1681-engine / index / Tweener

Class: Tweener

Defined in: src/core/Tweener.ts:135

Frame-driven tween manager (the renderer's replacement for Phaser's TweenManager).

Constructors

Constructor

new Tweener(): Tweener;

Returns

Tweener

Properties

timeScale

timeScale: number = 1;

Defined in: src/core/Tweener.ts:137

Global speed factor; hit-stop slows every tween at once.

Methods

add()

add(cfg): Tween;

Defined in: src/core/Tweener.ts:140

Parameters

Parameter	Type
cfg	TweenConfig

Returns

Tween

---

clear()

clear(): void;

Defined in: src/core/Tweener.ts:196

Returns

void

---

killTweensOf()

killTweensOf(target): void;

Defined in: src/core/Tweener.ts:174

Parameters

Parameter	Type
target	object | object[]

Returns

void

---

run()

run<T>(item): T;

Defined in: src/core/Tweener.ts:164

Steps item every frame from the next one on, at this manager's timeScale, until its step answers false or the manager is cleared (a stage's manager is cleared when the stage is destroyed).

Type Parameters

Type Parameter
T extends Steppable

Parameters

Parameter	Type
item	T

Returns

T

---

timeline()

timeline(options?): Timeline;

Defined in: src/core/Tweener.ts:170

A Timeline driven by this manager: it follows timeScale and stops with clear.

Parameters

Parameter	Type
options	Omit<TimelineOptions, "tweens">

Returns

Timeline

---

update()

update(dt): void;

Defined in: src/core/Tweener.ts:179

Parameters

Parameter	Type
dt	number

Returns

void