PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

TweenBase

Show deprecated

TweenBase

Show deprecated

The base class for in-between interpolation handlers.


Properties

PlaybackState

PlaybackState

[ReadOnly] [NotReplicated]

Read only property that shows the current playback Enum/PlaybackState of the Tween.

Functions

void

Cancel ( )

The Cancel function halts playback of its Tween and resets the tween variables. If TweenBase/Play is called again the Tween's properties will resume interpolating towards their destination but, as the tween variables have been reset, take the full length of the animation to do so.

void

Pause ( )

The Pause function halts playback of its Tween. If TweenBase/Resume is called again the tween will resume playback from the moment it was paused.

void

Play ( )

The Play function starts the playback of its Tween. Note that if a tween has already begun calling Play will have no effect unless the tween has finished or has been stopped (either by TweenBase/Cancel or TweenBase/Pause).

Events

RBXScriptSignal

Completed ( PlaybackState playbackState )

The Completed event of a Tween fires when the tween finishes playing. This will happen either when the tween naturally finishes playing, or if it is stopped with TweenBase/Cancel.