restart
restart( includeDelay:Boolean, suppressEvents:Boolean ) : self
Restarts and begins playing forward from the beginning.
Parameters
includeDelay: Boolean
(default =
false
) - Determines whether or not the delay (if any) is honored when restarting. For example, if a tween has a delay of 1 second, likegsap.to(obj, {duration: 2, x: 100, delay: 1});
and then laterrestart()
is called, it will begin immediately, butrestart(true)
will cause the delay to be honored so that it won't begin for another 1 second.suppressEvents: Boolean
(default =
true
) - Iftrue
(the default), no events or callbacks will be triggered when the playhead moves to the new position defined in thetime
parameter.
Returns : self
self (makes chaining easier)
Details
Restarts and begins playing forward from the beginning.
//restarts, not including any delay that was defined
myAnimation.restart();
//restarts, including any delay, and doesn't suppress events during the initial move back to time:0
myAnimation.restart(true, false);