Tween
One property animation, made by TweenService.create.
- Get it:
TweenService.createreturns one
A tween reads the starting values the first time it plays, then moves each property in goals
toward its end value every step, after physics. If its instance is destroyed, the tween cancels
itself.
Properties
Section titled “Properties”playing
Section titled “playing”Type: boolean · Access: read-only
True while the tween is playing.
Methods
Section titled “Methods”play(): voidStarts the tween, or resumes it after pause(). Does nothing while it’s already playing.
pause(): voidStops the tween where it is; play() resumes it.
cancel
Section titled “cancel”cancel(): voidStops the tween and resets its progress. The properties keep the values they have now.
Events
Section titled “Events”completed
Section titled “completed”Arguments: none
Fires when the tween finishes its last repeat. pause() and cancel() don’t fire it, and with a
repeatCount of -1 it never fires.