Skip to main content

Interface: Toggle

Defined in: ui/utilities/create-toggle.ts:86

Properties​

checkmark​

checkmark: number

Defined in: ui/utilities/create-toggle.ts:91

The child checkmark entity - shown while toggle.isOn.

entity​

entity: number

Defined in: ui/utilities/create-toggle.ts:88

The toggle's root entity - a RectTransformEcsComponent + SpriteEcsComponent + UiInteractableEcsComponent + UiColorTransitionEcsComponent + UiToggleEcsComponent.

interactable​

interactable: UiInteractableEcsComponent

Defined in: ui/utilities/create-toggle.ts:94

The toggle's UiInteractableEcsComponent, for reading interaction state or registering pointer-event listeners.

onValueChanged​

onValueChanged: ParameterizedForgeEvent<boolean>

Defined in: ui/utilities/create-toggle.ts:104

Raised whenever isOn changes - toggle.onValueChanged, surfaced directly since registering a single listener on it is the overwhelmingly common case.

toggle​

toggle: UiToggleEcsComponent

Defined in: ui/utilities/create-toggle.ts:97

The toggle's UiToggleEcsComponent, for reading/setting isOn directly.