Kills all the tweens (or specific tweening properties) of a particular object or delayedCalls to a particular function. If, for example, you want to kill all tweens of myObject
, you'd do this:
TweenLite.killTweensOf(myObject);
To kill only active (currently animating) tweens of myObject
, you'd do this:
TweenLite.killTweensOf(myObject, true);
To kill only particular tweening properties of the object, use the third parameter. For example, if you only want to kill all the tweens ofmyObject.opacity
and myObject.x
, you'd do this:
TweenLite.killTweensOf(myObject, false, {opacity:true, x:true});
To kill all the delayedCalls that were created like TweenLite.delayedCall(5, myFunction);
, you can simply callTweenLite.killTweensOf(myFunction);
because delayedCalls are simply tweens that have their target
and onComplete
set to the same function (as well as a delay
of course).
As of version 1.8.0, you can also pass in a string that defines selector text, like "#myID" to kill the tweens of the element with an ID of "myID". If you load jQuery, you can do more complex things like ".myClass" or "tagname", etc.
killTweensOf()
affects tweens that haven't begun yet too. If, for example, a tween of myObject
has a delay
of 5 seconds andTweenLite.killTweensOf(mc)
is called 2 seconds after the tween was created, it will still be killed even though it hasn't started yet.