Class: ButtonComponent
Clickable UI button. Adding it auto-attaches InteractionComponent. ButtonSystem runs the state machine and fires EntityEvent.ButtonClick when the pointer went down AND came up on the same button while interactable is true. Flipping interactable to false snaps state to Disabled and silences clicks.
Extends
Constructors
Constructor
ts
new ButtonComponent(): ButtonComponent;Returns
ButtonComponent
Inherited from
Properties
| Property | Modifier | Type | Default value | Inherited from |
|---|---|---|---|---|
dirty | public | boolean | true | Component.dirty |
disabledColor | public | number | undefined | - |
disabledSprite | public | string | undefined | - |
duration | public | number | undefined | - |
enabled | public | boolean | true | Component.enabled |
hoverColor | public | number | undefined | - |
hoverScale | public | number | undefined | - |
hoverSprite | public | string | undefined | - |
interactable | public | boolean | undefined | - |
normalColor | public | number | undefined | - |
normalScale | public | number | undefined | - |
normalSprite | public | string | undefined | - |
pressedColor | public | number | undefined | - |
pressedScale | public | number | undefined | - |
pressedSprite | public | string | undefined | - |
state | public | ButtonState | ButtonState.Normal | - |
transition | public | ButtonTransition | undefined | - |