PlaybackState
Describes the current state of a Tween in its Tween.PlaybackState property.
Items 6
| History | Name | Value | Description | |
|---|---|---|---|---|
| 288 | Begin | 0 | The tween has been created, but has yet to be played. After exiting this state, the tween never enters it again. | |
| 288 | Delayed | 1 | The tween is waiting for the duration specified in its TweenInfo.DelayTime. After the delay elapses, the tween plays. | |
| 288 | Playing | 2 | The tween is currently in progress. | |
| 288 | Paused | 3 | The tween is paused in the middle of playing. | |
| 288 | Completed | 4 | The tween completed successfully. | |
| 288 | Cancelled | 5 | The tween was cancelled before completion. |
Description
Describes the current playback state of a Tween, accessible via its
TweenBase.PlaybackState property. The state advances through a defined
lifecycle: a newly created tween begins in Begin; calling
TweenBase:Play() moves it to Delayed (when
TweenInfo.DelayTime is greater than 0) or directly to Playing;
from Playing the tween can be suspended (Paused), stopped early
(Cancelled), or reach its natural end (Completed). The
TweenBase.Completed event fires when the state transitions to either
Completed or Cancelled.