GUI

Name
GUI
Description
The GUI class can assist in manipulating the display of the graphical user interface. The class can be used to hide certain elements on the graphical user interface, and can also be used to add custom elements to the graphical user interface.

Additionally, the class can also be used to trace mouse coordinates and change the navigation system of the game at run time.
Syntax
- GUI.function()
Functions
- addObj()
  Add an Object as overlay on the graphical user interface
- charsVisible()
  Sets the visibility of character portraits on the graphical user interface
- mouseX()
  Returns the x position of the cursor
- mouseY()
  Returns the y position of the cursor
- navVisible()
  Sets the visibility of navigation buttons on the graphical user interface
- playerVisible()
  Sets the visibility of the player portrait and inventory on the graphical user interface
- removeObj()
  Removes an Object as overlay on the graphical user interface
- roomItemsVisible()
  Sets the visibility of room items on the graphical user interface
- roomTitleVisible()
  Sets the visibility of room titles on the graphical user interface
- scale()
  Scales the width and height of the image of a given Object as overlay on the graphical user interface
- scaleHeight()
  Scales the height of the image of a given Object as overlay on the graphical user interface
- scaleWidth()
  Scales the width of the image of a given Object as overlay on the graphical user interface
- setNav()
  Sets the active navigation system to be displayed on the graphical user interface
Related
- <Game>
- Object

Name

Description

Syntax

Functions

Related