UI Reference

UIs are defined via JSON, and can be instantiated as a UI config or as a standalone UI with CreateUI.

text

Displays left-aligned text.

button

Displays a button that when pressed fires one or more event messages. Text is centre-aligned.

image

Displays an image.

toggle

Displays a checkbox toggle that fires an event when pressed.

choiceButton

Displays one of several defined options as a button, changed by pressing it. Sends an event with the set text as an event.

sandChooser

Displays the Duster sand UI.

pos

An array with two elements defining the position of the component.

width

A number for the width of the component.

height

A number for the height of the component.

name

The name of a component, used when referencing with a script.

color

A hexcode color value of the component. If this is a text component it defines the color of the text. If it is an image component then it changes the color of the image.

bgcolor

A hexcode color value of the component's background.

tooltip

A string to show when hovering the mouse over the component.

text

A string to show on text or button components.

image

A path to an image to show on button or image components.

events

An array of strings defining what events are fired by the component.

eventNames

Unknown, used in weapon_rocket.

data

Data to send with an event in the _DATA variable.

choices

An array of strings defining what options are available on a choiceButton.