Class: Tween<T>

Default generic is any so a plain Tween field is assignable from any concrete target without forcing the caller to spell out the target type.

Type Parameters

Type Parameter	Default type
T extends TweenTarget	any

Constructors

Constructor

new Tween<T>(target): Tween<T>;

Parameters

Parameter	Type
target	T

Returns

Tween<T>

Methods

GetTarget()

GetTarget(): T;

Returns

T

---

IsCompleted()

IsCompleted(): boolean;

Returns

boolean

---

IsRunning()

IsRunning(): boolean;

Returns

boolean

---

Loop()

Loop(loop?, yoyo?): this;

Parameters

Parameter	Type	Default value
loop	boolean	true
yoyo	boolean	false

Returns

this

---

OnComplete()

OnComplete(cb): this;

Parameters

Parameter	Type
cb	() => void

Returns

this

---

OnUpdate()

OnUpdate(cb): this;

Parameters

Parameter	Type
cb	(target, t) => void

Returns

this

---

Pause()

Pause(pause?): this;

Stays registered; Tick is just skipped. Resume with Pause(false).

Parameters

Parameter	Type	Default value
pause	boolean	true

Returns

this

---

Reset()

Reset(): this;

Returns

this

---

Start()

Start(): this;

Returns

this

---

Stop()

Stop(): this;

Returns

this

---

Then()

Then(next): Tween<object>;

Chains the next tween onto completion. Returns the new tween; Start() the head.

Parameters

Parameter	Type
next	Tween<object>

Returns

Tween<object>

---

Tick()

Tick(dt): void;

Parameters

Parameter	Type
dt	number

Returns

void

---

To()

To(values, durationSeconds): this;

Snapshots the target's CURRENT values for each listed key — call after setting initial state, before Start.

Parameters

Parameter	Type
values	Partial<Record<keyof T, number>>
durationSeconds	number

Returns

this

---

WithEasing()

WithEasing(fn): this;

Parameters

Parameter	Type
fn	EasingFn

Returns

this