API:Class/TweenBase


Abstract: This object is abstract. It cannot be created with Instance.new, and its members are inherited by other classes.
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.

Object Icon.pngTweenBase : Object Icon.pngInstance

The base class for in-between interpolation handlers.

Properties

Properties [toggle]

PlaybackStatePlaybackState [readonly]

The current playback status of the tween.

|RMD member="API:Class/TweenBase/PlaybackState"|The current playback status of the tween.|/RMD|
PlaybackState [readonly]
The current playback status of the tween.

Functions

Functions [toggle]

voidCancel ( )

Stops playback and resets the Tween and its Instance back to their initial state.

|RMD member="API:Class/TweenBase/Cancel"|Stops playback and resets the Tween and its Instance back to their initial state.|/RMD|
voidPause ( )

Pauses playback of the Tween.

|RMD member="API:Class/TweenBase/Pause"|Pauses playback of the Tween.|/RMD|
voidPlay ( )

Starts the Tween playback.

|RMD member="API:Class/TweenBase/Play"|Starts the Tween playback.|/RMD|
Cancel ( )
Stops playback and resets the Tween and its Instance back to their initial state.
Pause ( )
Pauses playback of the Tween.
Play ( )
Starts the Tween playback.


Events

Events [toggle]

Completed ( PlaybackState playbackState )

Fires when the tween finishes playing or is cancelled.

|RMD member="API:Class/TweenBase/Completed"|Fires when the tween finishes playing or is cancelled.|/RMD|
Completed ( PlaybackState playbackState )
Fires when the tween finishes playing or is cancelled.

Inherited Classes

Tween.pngTween
|RMD member="API:Class/TweenBase"|The base class for in-between interpolation handlers. |/RMD|