GMUI Setup

GMUI_Init() - First thing called before any other GMUI command

GMUI_Create() - Creates the GMUI grid with the object specified

GMUI_CreateEvent() - Creates the GMUI grid in the object instead

GMUI_DrawEvent() - This required script needs to be in the draw event of the GMUI object

GMUI_ControlDraw() - The required script needs to be placed in the draw event of the control object

GMUI_SetKeyNavigation() - Set the keyboard navigation options for the GMUI instance or set as default to all instances

GMUI_DrawDebug() - You can use this to draw debugging info on the screen

Teardown

GMUI_Destroy() - Completely removes all GMUI components, destroying all instances and freeing memory

GMUI_DestroyNumber() - Completely removes all GMUI components of a specified GMUI id number

Base Form Functions

GMUI_AddLayer() - Creates a new layer and sets the current layer to this number

GMUI_Add() - Add a new control to the current layer

GMUI_CreateGroup() - Create a new group with number and size, in the current layer

GMUI_CreateGroupInLayer() - Create a new group in the specified layer

GMUI_CreateMenu() - Creates a new menu with name and size

GMUI_CreatePopup() - Creates a new popup with name and size

GMUI_CreateWarning() - Creates a new warning with name and size (untested)

GMUI_SetOnLayer() - Switches the current layer of which to create groups and controls onto

Properties of grouping and controls

These properties are added to groups, menus, and controls that you create in your interface form script

Group properties

GMUI_GroupHideOverflow() - Define the overflow method for groups (Coming soon)

GMUI_GroupSetClickOff() -

GMUI_GroupSetFadeOnHide() - Set the fade settings for the specified group in the current layer

GMUI_GroupSetSize() - Set the size of the specified group in the current layer

GMUI_GroupSetSpriteMap() - Set the sprite map to stretch to the control of the specified group in the current layer

GMUI_GroupSetStyle() - Set styling of the specified group in the current layer

GMUI_GroupStretchToGrid() - Stretch the specified group of the current layer to the grid

Menu properties

GMUI_MenuSetClickOff() - Determines for the specified menu if clicking outside of the menu will close it

GMUI_MenuSetHidePosition() - Sets the position for the specified menu where the menu will move to when hiding

**GMUI_MenuSetFadeOnHide() **- Sets the specified menu to fade out when hiding

GMUI_MenuSetStyle() - Sets the styling of the specified menu

GMUI_PopupSetAction() - Script to execute after responding to the popup

GMUI_PopupSetButton() - WIP

GMUI_PopupSetClickOff() - Determines for the specified popup if clicking outside of it will close it

GMUI_PopupSetHidePosition() - Sets the position for the specified popup where the popup will move to when hiding

GMUI_PopupSetMessage() - Sets the popup message information to display

GMUI_PopupSetFadeOnHide() - Sets the specified popup to fade out when hiding

GMUI_PopupSetStyle() - Sets the style settings of the specified popup

Control properties

GMUI_AddItem() - Adds a new item to a control that contains items

GMUI_AddToLayer() - Adds a new control to the specified layer

GMUI_AddTooltipToControl() - Creates a new tooltip that is bound to the specified control

GMUI_ControlAddOption() - Adds a new option to a control with options. This is different than items

GMUI_ControlAddToGroup() - Adds the current control to a specified group. The group needs to already exist

GMUI_ControlAddToMenu() - Adds the current control to a specified menu. The menu needs to already exist

GMUI_ControlAddToPopup() - Adds the current control to a specified popup. The popup needs to already exist

GMUI_ControlSelectOption() - Set the selected option of the specified control that has options

GMUI_ControlSetAttributes() - Set attributes of the current control, including min/max values and string lengths

GMUI_ControlSetButton() - Sets the button options for the current button control

GMUI_ControlSetButtonAction() - Sets the action to execute for the current button control when clicked

GMUI_ControlSetCheckboxSettings() - Sets the styling of the current checkbox control

GMUI_ControlSetFadeOnHide() - Sets the fade timing on the specified control

GMUI_ControlSetFontStyle() - Sets the font settings for the current control

GMUI_ControlSetHoverAction() - Sets the action to execute when hovering over the current control

GMUI_ControlSetHoverOffAction() - Sets the action to execute when leaving the current control

GMUI_ControlSetInitValue() - Sets the default value for the current control

GMUI_ControlSetPicker() - Sets the picker settings for the current picker control

GMUI_ControlSetPositioning() - Relative positioning and sizing, flexible outside of the grid cells for the current control

GMUI_ControlSetScrollbarStyle() - Sets the styling of the scrollbar of the current control if it has one

GMUI_ControlSetSelectingAction() - Sets the action to execute if a control is selected (similar to button action, but doesn't necessarily have to be clicked)

GMUI_ControlSetSliderMovement() - Sets the movement script (easing scripts) to use when moving the slider

GMUI_ControlSetSliderSettings() - Sets the ticks and snapping of the current slider control

GMUI_ControlSetSliderSize() - Sets the size of the slide and ticks of the current slider control

GMUI_ControlSetSliderStyle() - Sets coloring and design of the current slider control

GMUI_ControlSetSprite() - Specifies the sprite settings to use instead of drawn for the current control

GMUI_ControlSetSpriteExt() - Specifies sprite settings with more options for the current control

GMUI_ControlSetSpriteMap() - Specifies a map of sprites to use to stretch to the current control

GMUI_ControlSetStyle() - Sets the style settings for the current drawn control

GMUI_ControlSetText() - Sets the text for the current control, adjusting it to fit all of the text within it

GMUI_ControlSetToggleSettings() - Sets the style options for the current toggle control

GMUI_ControlSetValueChangedAction() - Sets the action to execute when the value was changed for the current control

GMUI_ControlStretchToGrid() - True/False, stretches the current control to the grid depending on the anchor

GMUI_ItemListBackground() - Set the styling of the current control that has items

GMUI_ItemListFont() - Set the font settings of the current control that has items

GMUI_ItemListSelectAction() - Action to execute when an item is selected in the current control

GMUI_ItemListSettings() - Set the styling and settings of items in the current control

These are typically used to assist with positioning the control when created or after:

GMUI_CenterX() - Returns the center X cell of the room of specified anchor and (control) width

GMUI_CenterY() - Returns the center Y cell of the room of specified anchor and (control) height

GMUI Manipulation

Call these in action scripts or in your own events

Interface Manipulation

GMUI_SwitchToLayer() - Changes the currently active layer in-game and disables other layers

GMUI_GetCurrentLayer() - Returns the number of the current layer

GMUI_LayerHide() - Hides/Shows the specified layer, including all groups and controls

GMUIid() - Returns the id of the control handling the GMUI instance of GMUI-ID number

GMUIself() - Returns the GMUI-ID number of the current object (or -1 if it is not handling a GMUI instance)

Menu Manipulation

GMUI_ShowMenu() - Opens the specified menu

GMUI_ShowMenuId() - Opens the specified menu of ID

GMUI_ShowPopup() - Opens the specified popup

GMUI_ShowPopupId() - Opens the specified popup of ID

GMUI_CloseMenu() - Closes the current menu with an option to animate

GMUI_IsMenuOpen() - Returns how many menus are open for the current interface (Will be adjusted soon)

GMUI_MenuSetPosition() - Sets the position of the specified menu

GMUI_PopupGetResponse() - Returns the response from the last popup selection

Group Manipulation

GMUI_GroupHide() - Hide/Show the specified group of the specified layer, fading if set

GMUI_GroupSetPosition() - Set the positioning of the specified group in the current layer

GMUI_GroupSetPositionActual() - Set the positioning of the specified group and layer with actual room x,y

GMUI_MouseInGroupRegion() - Returns if the mouse is in the region of the group

Control Manipulation

GMUI_GetControl() - Returns the ID of the specified control name

GMUI_ControlCenterX() - Moves the specified control to the center X of the layer

GMUI_ControlCenterY() - Moves the specified control to the center Y of the layer

GMUI_ControlDisable() - Disables or enables the specified control so that the action won't execute

GMUI_ControlDrawTooltip() - The event that is typically called by GMUI_ControlDraw for you to draw the tooltip

GMUI_ControlFadeIn() - Fades in a specified control with a lapse time

GMUI_ControlFadeOut() - Fades out a specified control with a lapse time

GMUI_ControlHide() - Hide/show the specified control, fading in or out if defined

GMUI_ControlHideTooltip() - Hide/show the tooltip of the specified control, fading in or out if defined

GMUI_ControlIsDisabled() - Returns if the specified control name is disabled

GMUI_ControlIsHidden() - Returns if the specified control name is hidden

GMUI_ControlPersistentToLayer() - Allows the current control to be enabled in every layer (not well tested yet)

GMUI_ControlPosition() - Set the position of the specified control

GMUI_GetValue() - Returns the value of the specified control name. Use this to retrieve values

GMUI_GetValueString() - Returns the string value of the specified control name

GMUI_SetValue() - Sets the value of the specified control