@relu-interactives/spatial-ecs
@relu-interactives/spatial-ecs / components / UIToggleComponent
Class: UIToggleComponent ​
Defined in: components/UIToggle.ts:24
An on/off switch.
The knob is a separate quad positioned from value — flipping animates geometry, never redrawing the canvas. Scripts hear changes via Behaviour.onUiToggle (bubbling like button presses); value is authored state and persists with the scene.
Extends ​
Constructors ​
Constructor ​
ts
new UIToggleComponent(options?): UIToggleComponent;Defined in: components/UIToggle.ts:38
Parameters ​
| Parameter | Type |
|---|---|
options? | UIToggleOptions |
Returns ​
UIToggleComponent
Overrides ​
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
value | boolean | - | components/UIToggle.ts:25 |
actionId | string | Dispatch identifier; empty string means "use the entity name". | components/UIToggle.ts:27 |
width | number | Full width in metres. | components/UIToggle.ts:29 |
height | number | Full height in metres. | components/UIToggle.ts:31 |
trackColor | string | Track colour while OFF. | components/UIToggle.ts:33 |
accentColor | string | Track colour while ON. | components/UIToggle.ts:35 |
knobColor | string | - | components/UIToggle.ts:36 |