Class: RunningTween<T>
Tweening.RunningTween
This class represents a running tween for a specific target object. It manages the execution of actions and tweens associated with the tween. Don't instantiate this manually.
Type parameters
| Name | Type | Description |
|---|---|---|
T | any | The type of the target object. |
Constructors
constructor
• new RunningTween<T>(target, tween)
Don't instantiate this manually.
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type |
|---|---|
target | T |
tween | Tween<T> |
Defined in
src/tweening/RunningTween.ts:68
Properties
paused
• paused: boolean = false
Indicates whether the execution of the running tween is paused.
If set to true, the tween will not progress until it is resumed.
Defined in
src/tweening/RunningTween.ts:52
timeScale
• timeScale: number = 1
The time scale factor for the running tween.
It determines the speed at which the tween progresses.
A value of 1 represents normal speed, while 0.5 would be half-speed, and 2 would be double-speed.
Defined in
src/tweening/RunningTween.ts:58
Accessors
finished
• get finished(): boolean
Indicates whether the running tween has finished executing.
Returns
boolean
Defined in
src/tweening/RunningTween.ts:63
Methods
complete
▸ complete(): void
Complete the running tween, causing it to finish immediately.
Returns
void
Defined in
src/tweening/RunningTween.ts:107
pause
▸ pause(): void
Pause the execution of the running tween.
Returns
void
Defined in
src/tweening/RunningTween.ts:86
resume
▸ resume(): void
Resume the execution of the running tween if it was paused.
Returns
void
Defined in
src/tweening/RunningTween.ts:93
revert
▸ revert(): void
Revert the running tween to its initial state (Not implemented yet).
Returns
void
Defined in
src/tweening/RunningTween.ts:114
setTimeScale
▸ setTimeScale(value): RunningTween<T>
Set the time scale for the running tween.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The time scale value to apply. |
Returns
RunningTween<T>
The updated RunningTween instance.
Defined in
src/tweening/RunningTween.ts:78
stop
▸ stop(): void
Stop the running tween, causing it to finish immediately.
Returns
void