PlaybackState

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

Name	Value	Description
Begin	0	The tween has been created, but has yet to be played. After exiting this state, the tween never enters it again.
Delayed	1	The tween is waiting for the duration specified in its `TweenInfo.DelayTime`. After the delay elapses, the tween plays.
Playing	2	The tween is currently in progress.
Paused	3	The tween is paused in the middle of playing.
Completed	4	The tween completed successfully.
Cancelled	5	The tween was cancelled before completion.

Begin

The tween has been created, but has yet to be played. After exiting this state, the tween never enters it again.

Field	Value
value	0

Delayed

The tween is waiting for the duration specified in its TweenInfo.DelayTime. After the delay elapses, the tween plays.

Field	Value
value	1

Playing

The tween is currently in progress.

Field	Value
value	2

Paused

The tween is paused in the middle of playing.

Field	Value
value	3

Completed

The tween completed successfully.

Field	Value
value	4

Cancelled

The tween was cancelled before completion.

Field	Value
value	5