Documentation / scene / AnimationTimelineEventResult

Type Alias: AnimationTimelineEventResult

AnimationTimelineEventResult = object

Defined in: libs/scene/src/animation/animationtimeline.ts:113

Result returned when a timeline or controller dispatches an event.

Properties

handled

handled: boolean

Defined in: libs/scene/src/animation/animationtimeline.ts:117

Whether the event was consumed, converted into steps, enqueued, or accepted as a transition.

---

policy

policy: AnimationTimelineEventPolicy

Defined in: libs/scene/src/animation/animationtimeline.ts:121

The action selected for the event.

---

event

event: string

Defined in: libs/scene/src/animation/animationtimeline.ts:125

Dispatched event name.

---

payload?

optional payload?: unknown

Defined in: libs/scene/src/animation/animationtimeline.ts:129

Optional payload supplied by the caller.