Interface: UiToggleDefaultedOptions

Defined in: ui/components/ui-toggle-component.ts:9

Fields of UiToggleEcsComponent with a sensible default; callers may omit these.

Extended by

• UiToggleEcsComponent

Properties

group?

optional group?: number

Defined in: ui/components/ui-toggle-component.ts:19

The entity id of a UiToggleGroupEcsComponent this toggle belongs to. Toggles sharing a group are mutually exclusive - turning one on turns every other toggle in the group off (see createUiToggleEcsSystem). Omitted, this toggle behaves as an independent checkbox.

---

isOn

isOn: boolean

Defined in: ui/components/ui-toggle-component.ts:11

Whether this toggle is currently on. System-owned once group links it into a radio group's mutual exclusivity; freely settable otherwise.