1681-engine / index / TimelineOptions
Interface: TimelineOptions ​
Defined in: src/core/Timeline.ts:5
Properties ​
onComplete? ​
optional onComplete?: (timeline) => void;Defined in: src/core/Timeline.ts:24
When the playhead reaches the end it is playing toward: the end, or the start when reversed.
Parameters ​
| Parameter | Type |
|---|---|
timeline | Timeline |
Returns ​
void
onRepeat? ​
optional onRepeat?: (timeline) => void;Defined in: src/core/Timeline.ts:22
Parameters ​
| Parameter | Type |
|---|---|
timeline | Timeline |
Returns ​
void
onUpdate? ​
optional onUpdate?: (timeline) => void;Defined in: src/core/Timeline.ts:21
Parameters ​
| Parameter | Type |
|---|---|
timeline | Timeline |
Returns ​
void
paused? ​
optional paused?: boolean;Defined in: src/core/Timeline.ts:12
Built but not playing until play() / resume().
repeat? ​
optional repeat?: number;Defined in: src/core/Timeline.ts:14
Extra plays after the first (-1 = forever).
repeatDelay? ​
optional repeatDelay?: number;Defined in: src/core/Timeline.ts:18
Ms of stillness between plays.
timeScale? ​
optional timeScale?: number;Defined in: src/core/Timeline.ts:20
Its own speed factor, on top of its manager's.
tweens? ​
optional tweens?: Tweener;Defined in: src/core/Timeline.ts:10
The manager that steps it: stage.tweens makes it follow the stage's timeScale and stop with the stage. Leave it out to step the timeline yourself with update(dt) (a fixed step, a test, a timeline played by another).
yoyo? ​
optional yoyo?: boolean;Defined in: src/core/Timeline.ts:16
Every second play runs backwards.