Collapse Sidebar


The Pause function halts playback of its Tween. However the progress variables of the tween will not be reset, meaning that when TweenBase/Play is called again the tween will resume playback from the moment it was paused.

If a developer wishes to reset the progress variables of the tween, they should use TweenBase/Cancel.

This means a tween paused half way through its animation will take half of its duration to complete when resumed.


Return Type Summary

Code Samples

Pausing a Tween

This sample demonstrates how the playback of a tween can be paused and resumed.

A part is instanced in the Workspace and a tween is setup that will move it 50 studs along the X axis. However during playback the tween is briefly paused, then resumed. To further illustrate this the BrickColor of the part changes from red to green whilst it is paused.