API:Class/Tween

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.
Uncreatable: This object cannot be created with Instance.new.

Tween.pngTween : Object Icon.pngTweenBase : Object Icon.pngInstance

Tweens are used to interpolate the properties of instances. The Tween object itself controls the playback of the interpolation. Creating and configuring tweens is done with the Create function. This is the only way to create tweens; Instance.new cannot be used for this particular object.

Note that while the configuration of a tween can be accessed after a tween has been created, it can not be modified. If new goals are needed for interpolation, a new tween must be created.

Properties

Properties [toggle]

Ref<Instance>Instance [readonly]

The object associated with the tween.

|RMD member="API:Class/Tween/Instance"|The object associated with the tween.|/RMD|
TweenInfoTweenInfo [readonly]

Describes how this tween is carried out while being played back.

|RMD member="API:Class/Tween/TweenInfo"|Describes how this tween is carried out while being played back.|/RMD|
Instance [readonly]
The object associated with the tween.
TweenInfo [readonly]
Describes how this tween is carried out while being played back.
Inherited from Object Icon.pngTweenBase:
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]

Inherited from Object Icon.pngTweenBase:
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]

Inherited from Object Icon.pngTweenBase:
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.

|RMD member="API:Class/Tween"|Tweens are used to interpolate the properties of instances. The Tween object itself controls the playback of the interpolation. Creating and configuring tweens is done with the Create function. This is the only way to create tweens; Instance.new cannot be used for this particular object. Note that while the configuration of a tween can be accessed after a tween has been created, it can not be modified. If new goals are needed for interpolation, a new tween must be created. |/RMD|