Skip to main content

Interface: Slider

Defined in: ui/utilities/create-slider.ts:105

Properties​

entity​

entity: number

Defined in: ui/utilities/create-slider.ts:107

The slider's root entity - the track - a RectTransformEcsComponent + SpriteEcsComponent + UiInteractableEcsComponent + UiColorTransitionEcsComponent + UiSliderEcsComponent.

fill?​

optional fill?: number

Defined in: ui/utilities/create-slider.ts:113

The child fill entity, if fillSprite was given.

handle​

handle: number

Defined in: ui/utilities/create-slider.ts:110

The child handle entity.

interactable​

interactable: UiInteractableEcsComponent

Defined in: ui/utilities/create-slider.ts:116

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

onValueChanged​

onValueChanged: ParameterizedForgeEvent<number>

Defined in: ui/utilities/create-slider.ts:126

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

slider​

slider: UiSliderEcsComponent

Defined in: ui/utilities/create-slider.ts:119

The slider's UiSliderEcsComponent, for reading/setting value directly.