UIObject

Create a UIObject

Color of the object when active, uses hoverColor if undefined

Horizontal text alignment: left, center, or right

Where on parent (or canvas if no parent) this object is anchored. Components in [-1, 1]: (0,0)=center, (-1,-1)=top-left, (1,1)=bottom-right. Also acts as self-pivot — e.g. (1,-1) puts your top-right corner at the anchor point.

True if this can be a hover object

A list of this object's children

Color of the object

Corner radius for rounded rects

Has this object been destroyed?

Is this object disabled?

Color when disabled

Activate when dragged over with mouse held down

Added size to make small buttons easier to touch on mobile devices

Font for this object

Font style for this object or undefined

Uses a gradient fill combined with color

Color used when hovering over the object

Is this element interactive

Color for line drawing

Width for line drawing

Position you set: an offset from this object's anchor point (the parent box, or the canvas for roots). This is the input that controls placement — set this, not nativePos.

Resolved position in native UI space, recomputed every frame from localPos + anchor (and nativeHeight, if set). This is a derived output used for drawing and hit-testing; assigning to it has no effect since it is overwritten each frame. Set localPos instead.

Should this be auto selected by navigation? Must also have valid navigation index.

Optional navigation order index, lower values are selected first

This object's parent, position is in parent space

Size of shadow blur

Color for shadow

Offset of shadow blur

Screen space size of the object

Style to draw with in place of the rectangle, tinted by the color for its state; its art has the frame, so the outline, corner radius and shadow are not drawn

Sound when interactive element is clicked

Sound when interactive element is pressed

Sound when interactive element is released

Text for this ui object

Color for text

Scale text to fit in the object

Override for text height

Color for text line drawing

Width for text line drawing

How much to offset the text shadow or undefined. UIText draws it in its shadowColor, which is clear by default, so set that too; the blurred shadow then shows as well unless shadowBlur and shadowOffset are zero. The other widgets draw it in black

Override for text width

Should this object be drawn

Add a child UIObject to this object, returns child for chaining

Internal function called when object is clicked

Destroy this object, destroy its children, detach its parent, and mark it for removal

Get where the text is drawn, the center, or the edge of the text area its align puts it against

Get the size for text with overrides and scale

Is the mouse held onto this element

Is the mouse hovering over this element

Can it be interacted with, it and every parent visible and enabled

Is this object in keyboard input mode

Check if the mouse is overlapping this ui object

Is the gamepad or keyboard navigation object

Called when the navigation button is pressed on this object

Called when the state of this object changes

Called when user clicks on this object

Called when the mouse enters the object

Called with each key while this is the keyInputObject

Called when the mouse leaves the object

Called when the mouse is pressed while over the object

Called when a press on it ends, wherever the mouse is let go, or when it is disabled or hidden while held, or an edit takes the press; onClick is the one for a press let go over it

Called each frame before object renders

Called each frame before object updates

Remove a child UIObject from this object

Render the object, called automatically by plugin once each frame

Called if uiDebug is enabled

Returns string containing info about this object for debugging

Update the object, called automatically by plugin once each frame