Class: UIText

Constructor

new UIText(posopt, sizeopt, textopt, alignopt, fontopt)

Create a UIText object

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2	<optional>
`size`	Vector2	<optional>
`text`	string	<optional>
`align`	string	<optional>	center
`font`	string	<optional>	uiSystem.defaultFont

Source: plugins/uiSystem.js, line 373

Extends

UIObject

Members

children

Properties

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

Overrides: UIObject#children
Source: plugins/uiSystem.js, line 233

color

Properties

Type	Description
Color	Color of the object

Overrides: UIObject#color
Source: plugins/uiSystem.js, line 205

cornerRadius

Properties

Type	Description
number	Corner radius for rounded rects

Overrides: UIObject#cornerRadius
Source: plugins/uiSystem.js, line 221

disabled

Properties

Type	Description
boolean	Is this object disabled?

Overrides: UIObject#disabled
Source: plugins/uiSystem.js, line 211

disabledColor

Properties

Type	Description
Color	Color when disabled

Overrides: UIObject#disabledColor
Source: plugins/uiSystem.js, line 209

extraTouchSize

Properties

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

Overrides: UIObject#extraTouchSize
Source: plugins/uiSystem.js, line 237

font

Properties

Type	Description
string	Font for this objecct

Overrides: UIObject#font
Source: plugins/uiSystem.js, line 223

hoverColor

Properties

Type	Description
Color	Color used when hovering over the object

Overrides: UIObject#hoverColor
Source: plugins/uiSystem.js, line 215

interactive

Properties

Type	Description
boolean	Is this element interactive

Overrides: UIObject#interactive
Source: plugins/uiSystem.js, line 247

lineColor

Properties

Type	Description
Color	Color for line drawing

Overrides: UIObject#lineColor
Source: plugins/uiSystem.js, line 217

lineWidth

Properties

Type	Description
number	Width for line drawing

Overrides: UIObject#lineWidth
Source: plugins/uiSystem.js, line 219

localPos

Properties

Type	Description
Vector2	Local position of the object

Overrides: UIObject#localPos
Source: plugins/uiSystem.js, line 199

mouseIsHeld

Properties

Type	Description
boolean	Is the mouse held on this element (was pressed while over and hasn't been released)

Overrides: UIObject#mouseIsHeld
Source: plugins/uiSystem.js, line 249

mouseIsOver

Properties

Type	Description
boolean	Is the mouse over this element

Overrides: UIObject#mouseIsOver
Source: plugins/uiSystem.js, line 245

parent

Properties

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

Overrides: UIObject#parent
Source: plugins/uiSystem.js, line 235

pos

Properties

Type	Description
Vector2	Screen space position of the object

Overrides: UIObject#pos
Source: plugins/uiSystem.js, line 201

size

Properties

Type	Description
Vector2	Screen space size of the object

Overrides: UIObject#size
Source: plugins/uiSystem.js, line 203

soundClick

Properties

Type	Description
Sound	Sound when interactive element is clicked

Overrides: UIObject#soundClick
Source: plugins/uiSystem.js, line 243

soundPress

Properties

Type	Description
Sound	Sound when interactive element is pressed

Overrides: UIObject#soundPress
Source: plugins/uiSystem.js, line 239

soundRelease

Properties

Type	Description
Sound	Sound when interactive element is released

Overrides: UIObject#soundRelease
Source: plugins/uiSystem.js, line 241

text

Properties

Type	Description
string	Text for this ui object

Overrides: UIObject#text
Source: plugins/uiSystem.js, line 207

textColor

Properties

Type	Description
Color	Color for text

Overrides: UIObject#textColor
Source: plugins/uiSystem.js, line 213

textHeight

Properties

Type	Description
number	Override for text height

Overrides: UIObject#textHeight
Source: plugins/uiSystem.js, line 227

textScale

Properties

Type	Description
number	Scale text to fit in the object

Overrides: UIObject#textScale
Source: plugins/uiSystem.js, line 229

textWidth

Properties

Type	Description
number	Override for text width

Overrides: UIObject#textWidth
Source: plugins/uiSystem.js, line 225

visible

Properties

Type	Description
boolean	Should this object be drawn

Overrides: UIObject#visible
Source: plugins/uiSystem.js, line 231

Methods

addChild(child)

Add a child UIObject to this object

Parameters:

Name	Type	Description
`child`	UIObject

Overrides: UIObject#addChild
Source: plugins/uiSystem.js, line 256

getTextSize() → {Vector2}

Get the size for text with overrides and scale

Overrides: UIObject#getTextSize
Source: plugins/uiSystem.js, line 342

Returns:

Type:: Vector2

onChange()

Called when the state of this object changes

Overrides: UIObject#onChange
Source: plugins/uiSystem.js, line 365

onClick()

Called when user clicks on this object

Overrides: UIObject#onClick
Source: plugins/uiSystem.js, line 362

onEnter()

Called when the mouse enters the object

Overrides: UIObject#onEnter
Source: plugins/uiSystem.js, line 350

onLeave()

Called when the mouse leaves the object

Overrides: UIObject#onLeave
Source: plugins/uiSystem.js, line 353

onPress()

Called when the mouse is pressed while over the object

Overrides: UIObject#onPress
Source: plugins/uiSystem.js, line 356

onRelease()

Called when the mouse is released while over the object

Overrides: UIObject#onRelease
Source: plugins/uiSystem.js, line 359

removeChild(child)

Remove a child UIObject from this object

Parameters:

Name	Type	Description
`child`	UIObject

Overrides: UIObject#removeChild
Source: plugins/uiSystem.js, line 266

render()

Render the object, called automatically by plugin once each frame

Overrides: UIObject#render
Source: plugins/uiSystem.js, line 326

update()

Update the object, called automatically by plugin once each frame

Overrides: UIObject#update
Source: plugins/uiSystem.js, line 274

updateInvisible()

Special update when object is not visible

Overrides: UIObject#updateInvisible
Source: plugins/uiSystem.js, line 333