pauseTweens()

Availability

AS2 and AS3.

Usage

Tweener.pauseTweens(target:Object, [, property1:String, property2:String, ...]):Boolean;

Parameters

target:Object — The object with tweenings that you want to pause. Usually, a MovieClip, TextField, or some instance of any other class which has numeric properties. This parameter is required.

property1..propertyN:String — The name of the property or properties currently being tweened that you want to pause. This is a string containing the name of the property, and any number of strings can be specified as parameters. If no property name is specified, all tweenings for this specific target target are paused.

Description

Pauses specific tweenings of specific objects. All currently existing tweenings that match the target (or target and specified properties, if any) are paused, including tweenings currently delayed. Tweenings that are already paused are not affected. Paused tweenings can be resumed with resumeTweens.

Returns

Boolean — true if any property tweening was successfully paused, false if otherwise.

Examples

// Pauses all tweenings of a certain object
Tweener.pauseTweens(myMC); 
// Pauses the _x tweening of a certain object
Tweener.pauseTweens(myMC, "_x");
// Pauses the _x, _y and _alpha tweening of a certain object
Tweener.pauseTweens(myMC, "_x", "_y", "_alpha");

See also

addTween, pauseAllTweens, resumeTweens