new UIObject(pos, size)uiSystem.js:979Create a UIObject
UI Object - Base level object for all UI elements
Extended by UIButton, UICheckbox, UILayout, UISlider, UIText, UITextInput, UITile, UIVideo
new UIObject(pos, size)uiSystem.js:979Create a UIObject
activeColor : Color|undefineduiSystem.js:1006Color of the object when active, uses hoverColor if undefined
align : 'left'|'center'|'right'uiSystem.js:1097Horizontal text alignment: left, center, or right
anchor : Vector2uiSystem.js:1094Where 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.
canBeHover : booleanuiSystem.js:1079True if this can be a hover object
children : Array<UIObject>uiSystem.js:1059A list of this object's children
color : ColoruiSystem.js:1003Color of the object
cornerRadius : numberuiSystem.js:1026Corner radius for rounded rects
destroyed : booleanuiSystem.js:1099Has this object been destroyed?
disabled : booleanuiSystem.js:1013Is this object disabled?
disabledColor : ColoruiSystem.js:1011Color when disabled
dragActivate : booleanuiSystem.js:1077Activate when dragged over with mouse held down
extraTouchSize : numberuiSystem.js:1064Added size to make small buttons easier to touch on mobile devices
font : stringuiSystem.js:1032Font for this object
fontStyle : string|undefineduiSystem.js:1035Font style for this object or undefined
gradientColor : Color|undefineduiSystem.js:1022Uses a gradient fill combined with color
hoverColor : ColoruiSystem.js:1017Color used when hovering over the object
interactive : booleanuiSystem.js:1075Is this element interactive
lineColor : ColoruiSystem.js:1019Color for line drawing
lineWidth : numberuiSystem.js:1024Width for line drawing
localPos : Vector2uiSystem.js:994Position 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.
nativePos : Vector2uiSystem.js:999Resolved 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.
parent : UIObject|undefineduiSystem.js:1062This object's parent, position is in parent space
shadowBlur : numberuiSystem.js:1083Size of shadow blur
shadowColor : ColoruiSystem.js:1081Color for shadow
shadowOffset : Vector2uiSystem.js:1085Offset of shadow blur
size : Vector2uiSystem.js:1001Screen space size of the object
slice : TileSlice|undefineduiSystem.js:1030Style 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
soundClick : Sound|undefineduiSystem.js:1073Sound when interactive element is clicked
soundPress : Sound|undefineduiSystem.js:1067Sound when interactive element is pressed
soundRelease : Sound|undefineduiSystem.js:1070Sound when interactive element is released
text : string|undefineduiSystem.js:1009Text for this ui object
textColor : ColoruiSystem.js:1015Color for text
textFitScale : numberuiSystem.js:1043Scale text to fit in the object
textHeight : number|undefineduiSystem.js:1041Override for text height
textLineColor : ColoruiSystem.js:1051Color for text line drawing
textLineWidth : numberuiSystem.js:1053Width for text line drawing
textShadow : Vector2|undefineduiSystem.js:1049How 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
textWidth : number|undefineduiSystem.js:1038Override for text width
visible : booleanuiSystem.js:1055Should this object be drawn
addChild(child) → UIObjectuiSystem.js:1107Add a child UIObject to this object, returns child for chaining
child UIObjectThe child object added
click(playSound)uiSystem.js:1383Internal function called when object is clicked
playSound boolean optional, default truedestroy()uiSystem.js:1126Destroy this object, destroy its children, detach its parent, and mark it for removal
getTextPos(textSize) → Vector2uiSystem.js:1321Get where the text is drawn, the center, or the edge of the text area its align puts it against
textSize Vector2From getTextSize
getTextSize() → Vector2uiSystem.js:1309Get the size for text with overrides and scale
isActiveObject() → booleanuiSystem.js:1336Is the mouse held onto this element
isHoverObject() → booleanuiSystem.js:1332Is the mouse hovering over this element
isInteractive() → booleanuiSystem.js:1348Can it be interacted with, it and every parent visible and enabled
isKeyInputObject() → booleanuiSystem.js:1344Is this object in keyboard input mode
isMouseOverlapping() → booleanuiSystem.js:1154Check if the mouse is overlapping this ui object
onChange()uiSystem.js:1413Called when the state of this object changes
onClick()uiSystem.js:1410Called when user clicks on this object
onEnter()uiSystem.js:1397Called when the mouse enters the object
onLeave()uiSystem.js:1400Called when the mouse leaves the object
onPress()uiSystem.js:1403Called when the mouse is pressed while over the object
onRelease()uiSystem.js:1407Called 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
onRender()uiSystem.js:1394Called each frame before object renders
onUpdate()uiSystem.js:1391Called each frame before object updates
render()uiSystem.js:1281Render the object, called automatically by plugin once each frame
renderDebug(visible)uiSystem.js:1370Called if uiDebug is enabled
visible boolean optional, default truetoString() → stringuiSystem.js:1352Returns string containing info about this object for debugging
update() → voiduiSystem.js:1167Update the object, called automatically by plugin once each frame