removeTweens()

言語バージョン

AS2 and AS3.

語法

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

パラメーター

target:Object — 削除したいトゥイーンのあるオブジェクト。通常は MovieClip, TextFieldインスタンス、あるいは数値プロパティのあるクラスのインスタンスなど。このパラメーターは必須。

property1..propertyN:String — トゥイーンを削除したいプロパティの名前。複数のプロパティ名を指定することも可能。プロパティ名が何も指定されていない場合、対象オブジェクトの全トゥイーンが削除される。

解説

特定のオブジェクトの特定のトゥイーンを削除し、再び実行されたりイベントが呼び出されることのないようにする。遅延指定されているトゥイーンや一時停止中のトゥイーンを含む、対象オブジェクトの全てのトゥイーン（プロパティが指定されている場合はそのプロパティのトゥイーン）が削除される。

返り値

Boolean — 狙ったトゥイーンがうまく削除されたらtrue、そうでなければfalse。

用例

// myMovieClipの全てのトゥイーンを削除
Tweener.removeTweens(myMovieClip);

// myMovieClipに_xと_yのトゥイーンを追加し、その後_xの方だけを削除する。
Tweener.addTween(myMovieClip, {_x:10, _y:20, time:1});
Tweener.removeTweens(myMovieClip, "_x");

// _x, _y, _alphaのトゥイーンを削除する
Tweener.removeTweens(myMovieClip, "_x", "_y", "_alpha");

注記

複数のプロパティを変更するトゥイーンにカスタムイベントが設定されていた場合、全てのトゥイーンが削除されない限りカスタムイベントは削除されない。例えば：

Tweener.addTween(myMovieClip, {_x:10, _y:20, time:1, onUpdate:this.redraw});
Tweener.removeTweens(myMovieClip, "_x");

上記の例の場合、removeTweens()実行後も_yトゥイーンは残るため、onUpdateイベントは呼び出され続ける。以下のようにして_yトゥイーンも削除した場合はカスタムイベントも削除され、onUpdateイベントの呼び出しは終了する：

Tweener.addTween(myMovieClip, {_x:10, _y:20, time:1, onUpdate:this.redraw});
Tweener.removeTweens(myMovieClip, "_x");
Tweener.removeTweens(myMovieClip, "_y");

一度に全部削除しても同じ：

Tweener.addTween(myMovieClip, {_x:10, _y:20, time:1, onUpdate:this.redraw});
Tweener.removeTweens(myMovieClip, "_x", "_y");

参照

addTween, removeAllTweens