Enum TweenState

Describes the current lifecycle state of a tween managed by the Scylla Tween system.

Namespace: Scylla.Core.Util.Tween
Assembly: ScyllaCore.dll
Syntax
public enum TweenState
Remarks

The normal forward progression through states is: Created → (Delayed) → Playing → Complete → Killed. Parentheses indicate that Delayed is only entered when a non-zero delay has been configured via SetDelay(float).

A tween may also enter Paused from either Delayed or Playing and return to the appropriate active state when resumed. Calling Kill(bool) from any non-killed state immediately transitions the tween to Killed.

The convenience bool properties on ITween - IsPlaying, IsPaused, IsComplete, and IsKilled - each test this enum value for readability.

Fields

Name Description
Complete

The tween has run through all configured loop iterations and applied its final end value. If AutoKill is true, the tween transitions to Killed immediately after the OnComplete(Action) callback fires.
Created

The tween has been constructed (or reset from the pool) but Play() has not yet been called. No value updates occur in this state.
Delayed

The tween is counting down its configured Delay before transitioning into Playing. While in this state IsPlaying returns true - the tween is active and will not receive pause calls through inactivity.
Killed

The tween has been permanently stopped via Kill(bool) and is no longer usable. Managed tweens are automatically unregistered from the TweenManager when entering this state. The instance should be discarded or returned to the pool for reuse.
Paused

The tween has been suspended via Pause(). Its ElapsedTime is preserved and no value updates occur until Play() is called to resume. The tween remains registered with the TweenManager but is skipped during the update loop.
Playing

The tween is actively advancing its ElapsedTime and writing the interpolated value to the animated property each frame. Transitions to Complete when ElapsedTime reaches Duration (accounting for looping).
See Also