Interface ITimelineCallbacksMap

Maps event names to their callback payload types.

Extend this interface to map event names to payload types. Use undefined for events without a payload.

interface ITimelineCallbacksMap {
    destroy: undefined;
    end: undefined;
    pause: undefined;
    play: undefined;
    props: Partial<ITimelineMutableProps>;
    reset: undefined;
    resume: undefined;
    reverse: undefined;
    start: undefined;
    update: ITimelineProgressArg;
}

Hierarchy (View Summary)

Properties

destroy end pause play props reset resume reverse start update

Properties

destroy

destroy: undefined

Triggered when the module is destroyed.

end

end: undefined

Fired when linear progress reaches 1.

pause

pause: undefined

Fired when an active playback loop is paused via Timeline.pause.

play

play: undefined

Fired when Timeline.play is called.

props

props: Partial<ITimelineMutableProps>

Triggered when the module's properties are updated. Receives the diff (changed keys and new values) as the first argument.

reset

reset: undefined

Fired when Timeline.reset is called, before progress is set to 0.

resume

resume: undefined

Fired when playback resumes after a pause via Timeline.play or Timeline.reverse.

reverse

reverse: undefined

Fired when Timeline.reverse is called.

start

start: undefined

Fired when linear progress is set to 0 (including Timeline.reset).

update

update: ITimelineProgressArg

Fired on every progress change with linear and eased values.

Settings

Member Visibility

On This Page

Properties