setTimer¶

タイマーを設定します。

1つのオブジェクトに対して1個のタイマー設定が可能です。

タイマーを設定すると、指定間隔で繰り返しイベントが発生します。設定したタイマーを解除するためには removeTimer メソッドを呼び出します。

secの間隔がTimerイベントハンドラの処理に要する時間よりも短い場合、Timerイベントがイベントキューに蓄積して動作不能になる場合があります。secの指定間隔には十分注意してください。

また、１回のみの実行を期待してTimerイベントにremoveTimerメソッドを記述すると、非常に短いsecの間隔を指定した場合、Timerイベント内のremoveTimerメソッドが実行される前に、次のTimerイベントが発生してしまう場合がありますので、1回のみの実行には必ずoneshotをtrueに指定するようにしてください。

オブジェクトがオブジェクトツリーから切り離された時、タイマーは自動的に停止します。

呼出形式一覧

呼出形式	説明
void setTimer(number sec[, boolean oneShot])	sec間隔でTimerイベントを発生させます。

戻り値一覧

戻り値	説明
void	なし

引数一覧

引数

説明

sec

Timerイベントの発行間隔を秒単位で指定します。タイマーの分解能は0.01秒です。

oneShot

trueを指定するとTimerイベントが一度だけ発生します。この場合はremoveTimerメソッドを呼び出す必要はありません。

省略時はfalseとみなします。

例外

なし

使用例

setTimer(2.5);
var count = 0;
function onTimer(e) {
    count++;
    if (count >= 5) {
        removeTimer();
    }
    print(new date(), "\n");
}

関連項目

removeTimer メソッド

Timer イベント

setTimer¶

ドキュメント目次

目次