Class: UIObject

Constructor

new UIObject(posopt, sizeopt)

Create a UIObject

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2	<optional>	vec2()
`size`	Vector2	<optional>	vec2(1)

Source: plugins/uiSystem.js, line 621

Members

activeColor

Properties

Type	Description
Color	Color of the object when active, uses hoverColor if undefined

Source: plugins/uiSystem.js, line 641

canBeHover

Properties

Type	Description
boolean	True if this can be a hover object

Source: plugins/uiSystem.js, line 695

children

Properties

Type	Description
Array.<UIObject>	A list of this object's children

Source: plugins/uiSystem.js, line 679

color

Properties

Type	Description
Color	Color of the object

Source: plugins/uiSystem.js, line 639

cornerRadius

Properties

Type	Description
number	Corner radius for rounded rects

Source: plugins/uiSystem.js, line 659

disabled

Properties

Type	Description
boolean	Is this object disabled?

Source: plugins/uiSystem.js, line 647

disabledColor

Properties

Type	Description
Color	Color when disabled

Source: plugins/uiSystem.js, line 645

dragActivate

Properties

Type	Description
boolean	Activate when dragged over with mouse held down

Source: plugins/uiSystem.js, line 693

extraTouchSize

Properties

Type	Description
number	Added size to make small buttons easier to touch on mobile devices

Source: plugins/uiSystem.js, line 683

font

Properties

Type	Description
string	Font for this objecct

Source: plugins/uiSystem.js, line 661

fontStyle

Properties

Type	Description
string	Font style for this object or undefined

Source: plugins/uiSystem.js, line 663

gradientColor

Properties

Type	Description
Color	Uses a gradient fill combined with color

Source: plugins/uiSystem.js, line 655

hoverColor

Properties

Type	Description
Color	Color used when hovering over the object

Source: plugins/uiSystem.js, line 651

interactive

Properties

Type	Description
boolean	Is this element interactive

Source: plugins/uiSystem.js, line 691

lineColor

Properties

Type	Description
Color	Color for line drawing

Source: plugins/uiSystem.js, line 653

lineWidth

Properties

Type	Description
number	Width for line drawing

Source: plugins/uiSystem.js, line 657

localPos

Properties

Type	Description
Vector2	Local position of the object

Source: plugins/uiSystem.js, line 633

navigationAutoSelect

Properties

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

Source: plugins/uiSystem.js, line 705

navigationIndex

Properties

Type	Description
number	Optional navigation order index, lower values are selected first

Source: plugins/uiSystem.js, line 703

parent

Properties

Type	Description
UIObject	This object's parent, position is in parent space

Source: plugins/uiSystem.js, line 681

pos

Properties

Type	Description
Vector2	Screen space position of the object

Source: plugins/uiSystem.js, line 635

shadowBlur

Properties

Type	Description
number	Size of shadow blur

Source: plugins/uiSystem.js, line 699

shadowColor

Properties

Type	Description
Color	Color for shadow, undefined if no shadow

Source: plugins/uiSystem.js, line 697

shadowOffset

Properties

Type	Description
Vector2	Offset of shadow blur

Source: plugins/uiSystem.js, line 701

size

Properties

Type	Description
Vector2	Screen space size of the object

Source: plugins/uiSystem.js, line 637

soundClick

Properties

Type	Description
Sound	Sound when interactive element is clicked

Source: plugins/uiSystem.js, line 689

soundPress

Properties

Type	Description
Sound	Sound when interactive element is pressed

Source: plugins/uiSystem.js, line 685

soundRelease

Properties

Type	Description
Sound	Sound when interactive element is released

Source: plugins/uiSystem.js, line 687

text

Properties

Type	Description
string	Text for this ui object

Source: plugins/uiSystem.js, line 643

textColor

Properties

Type	Description
Color	Color for text

Source: plugins/uiSystem.js, line 649

textFitScale

Properties

Type	Description
number	Scale text to fit in the object

Source: plugins/uiSystem.js, line 669

textHeight

Properties

Type	Description
number	Override for text height

Source: plugins/uiSystem.js, line 667

textLineColor

Properties

Type	Description
number	Color for text line drawing

Source: plugins/uiSystem.js, line 673

textLineWidth

Properties

Type	Description
number	Width for text line drawing

Source: plugins/uiSystem.js, line 675

textShadow

Properties

Type	Description
Vector2	How much to offset the text shadow or undefined

Source: plugins/uiSystem.js, line 671

textWidth

Properties

Type	Description
number	Override for text width

Source: plugins/uiSystem.js, line 665

visible

Properties

Type	Description
boolean	Should this object be drawn

Source: plugins/uiSystem.js, line 677

Methods

addChild(child) → {UIObject}

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

Parameters:

Name	Type	Description
`child`	UIObject

Source: plugins/uiSystem.js, line 713

Returns:

The child object added

Type:: UIObject

destroy()

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

Source: plugins/uiSystem.js, line 731

getTextSize() → {Vector2}

Get the size for text with overrides and scale

Source: plugins/uiSystem.js, line 849

Returns:

Type:: Vector2

isActiveObject() → {boolean}

Source: plugins/uiSystem.js, line 867

Returns:

Is the mouse held onto this element

Type:: boolean

isHoverObject() → {boolean}

Source: plugins/uiSystem.js, line 864

Returns:

Is the mouse hovering over this element

Type:: boolean

isInteractive() → {boolean}

Source: plugins/uiSystem.js, line 873

Returns:

Can it be interacted with

Type:: boolean

isMouseOverlapping() → {boolean}

Check if the mouse is overlapping a box in screen space

Source: plugins/uiSystem.js, line 748

Returns:

True if overlapping

Type:: boolean

isNavigationObject() → {boolean}

Source: plugins/uiSystem.js, line 870

Returns:

Is the gamepad or keyboard navigation object

Type:: boolean

navigatePressed()

Called when the navigation button is pressed on this object

Source: plugins/uiSystem.js, line 857

onChange()

Called when the state of this object changes

Source: plugins/uiSystem.js, line 930

onClick()

Called when user clicks on this object

Source: plugins/uiSystem.js, line 927

onEnter()

Called when the mouse enters the object

Source: plugins/uiSystem.js, line 915

onLeave()

Called when the mouse leaves the object

Source: plugins/uiSystem.js, line 918

onPress()

Called when the mouse is pressed while over the object

Source: plugins/uiSystem.js, line 921

onRelease()

Called when the mouse is released while over the object

Source: plugins/uiSystem.js, line 924

onRender()

Called each frame before object renders

Source: plugins/uiSystem.js, line 912

onUpdate()

Called each frame before object updates

Source: plugins/uiSystem.js, line 909

removeChild(child)

Remove a child UIObject from this object

Parameters:

Name	Type	Description
`child`	UIObject

Source: plugins/uiSystem.js, line 723

render()

Render the object, called automatically by plugin once each frame

Source: plugins/uiSystem.js, line 825

renderDebug(visible)

Called if uiDebug is enabled

Parameters:

Name	Type	Default	Description
`visible`	boolean	true

Source: plugins/uiSystem.js, line 897

toString() → {string}

Returns string containing info about this object for debugging

Source: plugins/uiSystem.js, line 877

Returns:

Type:: string

update()

Update the object, called automatically by plugin once each frame

Source: plugins/uiSystem.js, line 759