Datatype · Userdata

Tween

userdatasince 1.6.9-2-alpha

Represents a running tween created by TweenService:Create. Controls playback and reports completion.

Properties

4
NameTypeAccessDescription
InstanceInstanceread

Returns the instance this tween is operating on.

since 1.6.9-2-alpha
TweenInfoTweenInforead

The TweenInfo that was used to create this tween.

since 1.6.9-2-alpha
CompletedEventread

Event thats fired once tween has completed for any reason. Passes PlaybackState as a argument to the callback.

since 1.6.9-2-alpha
PlaybackStatePlaybackStateread

The PlaybackState the tween is currently in.

since 1.6.9-2-alpha

Methods

3

#Tween:Cancel() → ()

since 1.6.9-2-alpha

Cancels the tween

#Tween:Pause() → ()

since 1.6.9-2-alpha

Pauses the tween

#Tween:Play() → ()

since 1.6.9-2-alpha

Plays or resumes the tween