Documentation / scene / AnimationTimelineEventResponse
Type Alias: AnimationTimelineEventResponse
AnimationTimelineEventResponse =
object
Defined in: libs/scene/src/animation/animationtimeline.ts:139
A reaction to a gameplay event, declared on a timeline or a controller state.
The model is orthogonal: target says what to do, onActive says what happens to the currently running steps, and enqueue defers steps instead of running them immediately.
Properties
event
event:
string
Defined in: libs/scene/src/animation/animationtimeline.ts:143
Event name this response handles.
target
target:
AnimationTimelineEventTarget
Defined in: libs/scene/src/animation/animationtimeline.ts:145
What the event does.
onActive?
optionalonActive?:AnimationTimelineActiveDisposition
Defined in: libs/scene/src/animation/animationtimeline.ts:151
Disposition of the currently active steps. Defaults to 'stop'. Use 'keep' with target.steps to run the new steps concurrently (true parallel branch). Ignored for consume/ignore targets.
enqueue?
optionalenqueue?:boolean
Defined in: libs/scene/src/animation/animationtimeline.ts:156
When true and target.steps is set, the steps are appended to the queue and run after the current steps drain, instead of replacing/joining them. onActive is ignored.