PlaybackState¶
Supported Enum
Describes the current state of a Tween in its Tween.PlaybackState property.
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.
Items¶
| Item | Value | Status | Notes |
|---|---|---|---|
Begin |
0 | Supported | The tween has been created, but has yet to be played. After exiting this state, the tween never enters it again. |
Cancelled |
1 / 5 | Supported | Value differs from Roblox. |
Delayed |
1 | Not yet | The tween is waiting for the duration specified in its TweenInfo.DelayTime. After the delay elapses, the tween plays. |
Completed |
2 / 4 | Supported | Value differs from Roblox. |
Paused |
3 | Supported | The tween is paused in the middle of playing. |
Playing |
4 / 2 | Supported | Value differs from Roblox. |
Roblox reference: PlaybackState