Constructor
new UIButton(posopt, sizeopt, textopt, coloropt)
Create a UIButton object
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
pos | Vector2 | <optional> | ||
size | Vector2 | <optional> | ||
text | string | <optional> | ||
color | Color | <optional> | uiDefaultButtonColor |
- Source
Extends
Members
children
Properties| Type | Description |
|---|---|
| Array.<UIObject> |
- Overrides
- Source
color
Properties| Type | Description |
|---|---|
| Color |
- Overrides
- Source
font
Properties| Type | Description |
|---|---|
| string |
- Overrides
- Source
hoverColor
Properties| Type | Description |
|---|---|
| Color |
- Overrides
- Source
lineColor
Properties| Type | Description |
|---|---|
| Color |
- Overrides
- Source
lineWidth
Properties| Type | Description |
|---|---|
| number |
- Overrides
- Source
localPos
Properties| Type | Description |
|---|---|
| Vector2 | Local position of the object |
- Overrides
- Source
parent
Properties| Type | Description |
|---|---|
| UIObject |
- Overrides
- Source
pos
Properties| Type | Description |
|---|---|
| Vector2 | Screen space position of the object |
- Overrides
- Source
size
Properties| Type | Description |
|---|---|
| Vector2 | Screen space size of the object |
- Overrides
- Source
text
Properties| Type | Description |
|---|---|
| string |
- Source
textColor
Properties| Type | Description |
|---|---|
| Color |
- Overrides
- Source
visible
Properties| Type | Description |
|---|---|
| boolean |
- Overrides
- Source
Methods
addChild(child)
Add a child UIObject to this object
Parameters:
| Name | Type | Description |
|---|---|---|
child | UIObject |
- Overrides
- Source
onChange()
Called when the state of this object changes
- Overrides
- Source
onEnter()
Called when the mouse enters the object
- Overrides
- Source
onLeave()
Called when the mouse leaves the object
- Overrides
- Source
onPress()
Called when the mouse is pressed while over the object
- Overrides
- Source
onRelease()
Called when the mouse is released while over the object
- Overrides
- Source
removeChild(child)
Remove a child UIObject from this object
Parameters:
| Name | Type | Description |
|---|---|---|
child | UIObject |
- Overrides
- Source
render()
Render the object, called automatically by plugin once each frame
- Overrides
- Source
update()
Update the object, called automatically by plugin once each frame
- Overrides
- Source