Skip to main content

kill

kill( target:Object, propertiesList:String ) : self

Kills the animation entirely or in part depending on the parameters. To kill means to immediately stop the animation, remove it from its parent timeline, and release it for garbage collection.

Parameters

  • target: Object

    (default = null) — To kill only aspects of the animation related to a particular target (or targets), reference it here. For example, to kill only parts having to do with myObject, do kill(myObject) or to kill only parts having to do with myObject1 andmyObject2, do kill([myObject1, myObject2]). If no target is defined, ALL targets will be affected.

  • propertiesList: String

    (default = "all") — a comma-delimited list of property names that should no longer be animated by this Tween. If no object (or null or "all") is defined, ALL properties will be killed.

Returns : self​

self (makes chaining easier)

Details​

Kills the animation entirely or in part depending on the parameters. Simply calling kill() (omitting the parameters) will immediately stop the animation, remove it from its parent timeline, wipe out any property tweens and release it for garbage collection.

// kill the entire animation:
animation.kill();

// set to null so the reference is removed
animation = null;

To kill only a certain target (or targets) from the animation, use the first parameter. To kill particular tweening properties of the animation, use the second parameter which is a comma-delimited list of property names.

// kill all parts of the animation related to the target "myObject" (if the tween has multiple targets, the others will not be affected):
animation.kill(myObject);

// kill only the "x" and "y" properties of the animation (all targets):
animation.kill(null, "x,y");

// kill only the "x" and "y" properties of animations of the target "myObject":
animation.kill(myObject, "x,y");

// kill only the "opacity" properties of animations of the targets "myObject1" and "myObject2":
animation.kill([myObject1, myObject2], "opacity"); //you could use selector text instead, like ".class1, .class2"

Note: don't kill() an animation if you want to use it again later - you could pause() it instead if you want to reuse it.

Contents