setTimeScale()

言語バージョン

AS2 and AS3.

語法

Tweener.setTimeScale(scale:Number);

パラメーター

scale:Number — 0より大きい数値。デフォルト値（＝通常のタイムスケール）は1。このパラメーターが指定されない場合は1を指定したものとみなされる。

解説

プロパティの変更やトウィーンの遅延の際に適用されるタイムスケールを設定する。これはトゥイーンエンジンがよりどころとするタイムスケールを変更することで作用する。このメソッドが実行されると、実行中の全トゥイーンが更新され、新規に作成されるトゥイーンもこのタイムスケールに従う。このスケールは絶対値である。

デフォルト値は1。これが通常のタイムスケールとみなされる。値を2にするとトゥイーンエンジンが早送りモードとなり、全てのトゥイーンは通常の半分の早さで完了する。値を0.5にすると通常の倍の時間をかけるので、見た目的にはスローモーションで実行されている状態になる。

このメソッドはグローバルに作用する。このため、非常に特殊なケースのみに使用するべきである。主にデバッグ用途で使われる。例えば非常に長いアニメーションがあって完了するのを待ちきれない場合、タイムスケールの数値を大きく設定するとよい。で、終了後に値を1戻す。こうした機能を任意のキーに設定したり、ローカルでテストする時だけ使う。もちろん、ムービーの総合タイムスケールをいじることはできるが、これをやると全ての変更（transition）に影響してしまうので、あまりオススメしない。

返り値

なし

用例

// ムービーのトゥイーンをターボモードにする
Tweener.setTimeScale(10);

// Flash IDEでテストしてる時だけアニメーションをスローにする
if (System.capabilities.playerType == "External") Tweener.setTimeScale(0.5)

// SHIFTキーを押したらムービーを早送りモードにする
Key.addListener(this);
this.onKeyDown = function() {
	if (Key.isDown(Key.SHIFT)) Tweener.setTimeScale(10);
}
this.onKeyUp = function() {
	if (!Key.isDown(Key.SHIFT)) Tweener.setTimeScale(1);
};