LittleJS 1.30.1

UISystem

UIObject

UI Object - Base level object for all UI elements

Extended by UIButton, UICheckbox, UILayout, UISlider, UIText, UITextInput, UITile, UIVideo

Constructor

new UIObject(pos, size)uiSystem.js:908

Create a UIObject

pos Vector2 optional, default vec2()
size Vector2 optional, default vec2()

Members

Methods

Members

activeColor : Color|undefineduiSystem.js:935

Color of the object when active, uses hoverColor if undefined

align : 'left'|'center'|'right'uiSystem.js:1026

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.

canBeHover : booleanuiSystem.js:1008

True if this can be a hover object

children : Array<UIObject>uiSystem.js:988

A list of this object's children

Color of the object

cornerRadius : numberuiSystem.js:955

Corner radius for rounded rects

destroyed : booleanuiSystem.js:1028

Has this object been destroyed?

disabled : booleanuiSystem.js:942

Is this object disabled?

disabledColor : ColoruiSystem.js:940

Color when disabled

dragActivate : booleanuiSystem.js:1006

Activate when dragged over with mouse held down

extraTouchSize : numberuiSystem.js:993

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

font : stringuiSystem.js:961

Font for this object

fontStyle : string|undefineduiSystem.js:964

Font style for this object or undefined

gradientColor : Color|undefineduiSystem.js:951

Uses a gradient fill combined with color

Color used when hovering over the object

interactive : booleanuiSystem.js:1004

Is this element interactive

Color for line drawing

lineWidth : numberuiSystem.js:953

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.

navigationAutoSelect : booleanuiSystem.js:1019

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

navigationIndex : number|undefineduiSystem.js:1017

Optional navigation order index, lower values are selected first

parent : UIObject|undefineduiSystem.js:991

This object's parent, position is in parent space

shadowBlur : numberuiSystem.js:1012

Size of shadow blur

shadowColor : ColoruiSystem.js:1010

Color for shadow

Offset of shadow blur

Screen space size of the object

slice : TileSlice|undefineduiSystem.js:959

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

soundClick : Sound|undefineduiSystem.js:1002

Sound when interactive element is clicked

soundPress : Sound|undefineduiSystem.js:996

Sound when interactive element is pressed

soundRelease : Sound|undefineduiSystem.js:999

Sound when interactive element is released

text : string|undefineduiSystem.js:938

Text for this ui object

Color for text

textFitScale : numberuiSystem.js:972

Scale text to fit in the object

textHeight : number|undefineduiSystem.js:970

Override for text height

textLineColor : ColoruiSystem.js:980

Color for text line drawing

textLineWidth : numberuiSystem.js:982

Width for text line drawing

textShadow : Vector2|undefineduiSystem.js:978

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

textWidth : number|undefineduiSystem.js:967

Override for text width

visible : booleanuiSystem.js:984

Should this object be drawn

Methods

addChild(child) → UIObjectuiSystem.js:1036

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

child UIObject
Returns

The child object added

click(playSound)uiSystem.js:1309

Internal function called when object is clicked

playSound boolean optional, default true

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

getTextPos(textSize) → Vector2uiSystem.js:1247

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

textSize Vector2

From getTextSize

getTextSize() → Vector2uiSystem.js:1235

Get the size for text with overrides and scale

isActiveObject() → booleanuiSystem.js:1262

Is the mouse held onto this element

isHoverObject() → booleanuiSystem.js:1258

Is the mouse hovering over this element

isInteractive() → booleanuiSystem.js:1274

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

isKeyInputObject() → booleanuiSystem.js:1270

Is this object in keyboard input mode

isMouseOverlapping() → booleanuiSystem.js:1083

Check if the mouse is overlapping this ui object

Returns
  • True if overlapping
isNavigationObject() → booleanuiSystem.js:1266

Is the gamepad or keyboard navigation object

navigatePressed()uiSystem.js:1254

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

onKeyDown(e)uiSystem.js:1343

Called with each key while this is the keyInputObject

e KeyboardEvent

Called when the mouse leaves the object

Called when the mouse is pressed while over the object

onRelease()uiSystem.js:1333

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

removeChild(child)uiSystem.js:1046

Remove a child UIObject from this object

child UIObject

Render the object, called automatically by plugin once each frame

renderDebug(visible)uiSystem.js:1296

Called if uiDebug is enabled

visible boolean optional, default true
toString() → stringuiSystem.js:1278

Returns string containing info about this object for debugging

update() → voiduiSystem.js:1095

Update the object, called automatically by plugin once each frame