Skip to content

TweenObject

A tween created by Tween:Create. Call :Play() to start it, and listen to Finished to know when it is done.

Not newable

This object cannot be created by scripts using Instance.New().

Properties

IsRunning : boolean

Returns whether this tween is currently running.

Methods

Play → TweenObject

Parameters: ``

Starts (or restarts) this tween. Returns the tween so calls can be chained.

Cancel → nil

Parameters: ``

Stops this tween and fires Canceled.

Events

Finished

Parameters: ``

Fires when this tween has finished.

Canceled

Parameters: ``

Fires when this tween has been canceled.