UI

Shows a keyboard menu over your UI texts, pauses the script until the player picks one and stores its number.

Arrow keys or WASD move the selection (with several columns, up/down move one row). Confirm stores 1, 2, 3...; a cancel key stores 0. The options stay visible afterwards, so hide them with Hide UI if needed. While open, Dialogue or menu is open is true and Walk on grid pauses. A missing option object stops the game with an error.

Example After a Say in dialogue box, offer Yes|No and branch on choice with an If.

Disables a UI Button so it ignores hover and clicks and shows its disabled look.

A disabled button uses its disabled colour or image and never fires When This Button Clicked. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Disable a Buy button while the player cannot afford the item.

Enables a UI Button again so it reacts to hover and clicks.

If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Hides a UI object (text, image or button).

Only works on UI objects. A hidden UI Button can still be clicked where it was, so also use Disable Button if it must stop reacting. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Hide a Paused label when the game resumes.

Types text letter by letter into a UI text, then pauses the script until the player presses a key.

Pressing a key while it types shows the whole line; the next press closes it. Write \n for a line break. While open, Dialogue or menu is open is true and Walk on grid pauses; other controls such as Platformer controls keep running. A missing UI object stops the game with an error, so clear box UI if you have no box.

Example Chain several of these in a When Scene Starts script for an intro conversation, with hide after set to off except on the last one.

Resizes a bar to value / max of its full width, with an optional image for each fill level.

The width animates with an ease-out over seconds, keeping the left edge in place. At 0 or below the bar is hidden; above 0 it is shown. A missing bar object or a value that is not a number stops the game with an error.

Example Run it after the player takes damage, with green, yellow and red images for the three levels.

Sets the image a UI Button shows in one of its states.

Images only appear when the button's background mode is set to image in the Inspector; in colour mode the change is stored but not visible. Hover, pressed and disabled fall back to the normal image when empty. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Changes the label shown on a UI Button.

Only works on UI Buttons; Set UI Text works on both texts and buttons. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Change a Start button to Continue once a save exists.

Changes a colour of a UI Text or UI Button.

On a UI Text it always sets the text colour and Role is ignored. On a UI Button, Role picks what to recolour. UI Images have no colour (use Set UI Opacity). If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Turn a timer label red with #ff4040 when fewer than 10 seconds remain.

Changes the font, and optionally the size, of a UI Text or UI Button.

If the font file does not exist, a warning is logged once and the current font is kept (the size still changes). Only UI Texts and UI Buttons are accepted; other objects log a warning.

Example Switch a title to a pixel font when the game starts.

Changes the font size of a UI Text or UI Button.

Size is in pixels, rounded down to a whole number, minimum 1. The text also scales with the camera zoom. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Changes the image of a UI Image, or the normal image of a UI Button.

On a button it replaces only the normal state image, which is visible only in image background mode. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Swap a portrait image depending on who is talking.

Sets how opaque a UI object is, from 0 (invisible) to 1 (solid).

Values are clamped between 0 and 1. It is visible on UI Images and UI Buttons; UI Texts currently ignore it when drawn, so use Hide UI or Set UI Color for text. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Set 0.5 on a locked menu icon to make it look faded.

Changes the text of a UI Text or the label of a UI Button.

On a UI Text, the text is drawn from the top-left corner and wraps to the object's width. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Plug a variable reporter into Text inside On Update to show the score.

Sets a UI text from a template, replacing each {reference} with the current value of a variable.

{name} reads this object's variable, {Object.name} another object's and {global.name} a global; x, y, width, height and name also work as properties. Unknown references are left as typed. Whole numbers show without decimals, others with up to 2. Does nothing if the UI object is not found.

Example Inside On Update of a HUD object to keep Coins {global.coins} up to date.

Reserved: currently has no effect at runtime.

Meant for progress bars, but not implemented yet. Use Set bar to show a value as a bar.

Shows a UI object (text, image or button) that was hidden.

Only works on UI objects. If the object is missing or of the wrong kind, a message is printed to the console and the game continues.

Example Show a Game Over label when the player runs out of lives.