パッケージflash.utils
public class Timer
継承Timer Inheritance EventDispatcher Inheritance Object

Timer クラスは Flash Player タイマーへのインターフェイスです。新しい Timer オブジェクトを作成すると、指定したタイムシーケンスでコードを実行できます。タイマーを開始するには start() メソッドを使用します。timer イベントのイベントリスナーをセットアップコードに追加すると、そのタイマー間隔で実行されます。

Timer オブジェクトを作成して、1 回実行または指定した間隔で繰り返して定時にコードを実行できます。SWF ファイルのフレームレートまたは Flash Player の環境 (使用可能なメモリやその他の要素) に応じて、Flash Player ではややオフセットの間隔でイベントを送出できます。たとえば、SWF ファイルを 10 fps (1 秒あたりのフレーム数)、つまり100 ミリ秒間隔で実行するように設定し、80 ミリ秒でイベントを発生するようにタイマーを設定すると、Flash Player ではおよそ 100 ミリ秒間隔でイベントが実行されます。また、メモリに負荷のかかるスクリプトでも、イベントがオフセットされる場合があります。

例の表示

関連項目

日付と時刻の操作
タイマー間隔の制御


パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  currentCount : int
[read-only] ゼロで開始してから現在までに起動されたタイマーの合計回数です。
Timer
  delay : Number
ミリ秒単位で指定したタイマーイベント間の遅延です。
Timer
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  repeatCount : int
タイマーを実行する合計回数を設定します。
Timer
  running : Boolean
[read-only] タイマーの現在の状態です。タイマーの実行中は true、それ以外は false です。
Timer
パブリックメソッド
 メソッド定義
  Timer(delay:Number, repeatCount:int = 0)
delay および repeatCount に指定した状態で、新しい Timer オブジェクトを作成します。
Timer
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  reset():void
タイマーが実行されている場合はタイマーを停止して、ストップウォッチのリセットボタンのように、currentCount プロパティを 0 に戻します。
Timer
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  start():void
タイマーがまだ実行されていない場合は、タイマーを起動します。
Timer
  stop():void
タイマーを停止します。
Timer
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
  timer Timer オブジェクトが Timer.delay プロパティに従って指定された時間間隔に達するたびに送出されます。Timer
  timerComplete Timer.repeatCount で設定された要求数を完了するたびに送出されます。Timer
プロパティの詳細
currentCountプロパティ
currentCount:int  [read-only]

ゼロで開始してから現在までに起動されたタイマーの合計回数です。タイマーをリセットした場合は、リセット以降の回数のみがカウントされます。

実装
    public function get currentCount():int
delayプロパティ 
delay:Number  [read-write]

ミリ秒単位で指定したタイマーイベント間の遅延です。タイマーの実行中に遅延間隔を設定すると、同じ repeatCount の反復回数でタイマーが再起動されます。

実装
    public function get delay():Number
    public function set delay(value:Number):void

Throws
Error — 指定した遅延がマイナスまたは有限数でない場合、例外が発生します。
repeatCountプロパティ 
repeatCount:int  [read-write]

タイマーを実行する合計回数を設定します。繰り返し回数を 0 に設定すると、stop() メソッドが呼び出されるまで、またはプログラムによって停止されるまで、タイマーは無限に継続されます。繰り返し回数をゼロ以外に指定すると、タイマーは指定した回数実行されます。currentCount 以下の合計を repeatCount に設定するとタイマーは停止し、再起動されません。

実装
    public function get repeatCount():int
    public function set repeatCount(value:int):void
runningプロパティ 
running:Boolean  [read-only]

タイマーの現在の状態です。タイマーの実行中は true、それ以外は false です。

実装
    public function get running():Boolean
コンストラクタの詳細
Timer()コンストラクタ
public 関数 Timer(delay:Number, repeatCount:int = 0)

delay および repeatCount に指定した状態で、新しい Timer オブジェクトを作成します。

タイマーが自動的に起動しない場合は、start() メソッドを呼び出して起動させる必要があります。

パラメータ
delay:Number — ミリ秒単位で指定したタイマーイベント間の遅延です。
 
repeatCount:int (default = 0) — 繰り返しの回数を指定します。ゼロを指定すると、タイマーは無限に繰り返されます。ゼロ以外に指定すると、タイマーは指定した回数を実行された後に停止します。

スロー
Error — 指定した遅延がマイナスまたは有限数でない場合
メソッドの詳細
reset()メソッド
public function reset():void

タイマーが実行されている場合はタイマーを停止して、ストップウォッチのリセットボタンのように、currentCount プロパティを 0 に戻します。その後、start() が呼び出されると、repeatCount 値で指定した繰り返しの回数のタイマーインスタンスが実行されます。

関連項目

start()メソッド 
public function start():void

タイマーがまだ実行されていない場合は、タイマーを起動します。

stop()メソッド 
public function stop():void

タイマーを停止します。stop() の後に start() が呼び出されると、repeatCount プロパティで指定した残りの繰り返しの回数のタイマーインスタンスが実行されます。

関連項目

イベントの詳細
timerevent 
イベントオブジェクトの型: flash.events.TimerEvent
TimerEvent.type property = flash.events.TimerEvent.TIMER

Timer オブジェクトが Timer.delay プロパティに従って指定された時間間隔に達するたびに送出されます。

timer イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target時間間隔が経過した Timer オブジェクトです。
timerCompleteevent  
イベントオブジェクトの型: flash.events.TimerEvent
TimerEvent.type property = flash.events.TimerEvent.TIMER_COMPLETE

Timer.repeatCount で設定された要求数を完了するたびに送出されます。

timerComplete イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target要求を完了した Timer オブジェクトです。

次の例では、クラス TimerExample を使用して リスナーメソッド timerHandler() が新しい TimerEvent を受け取り、 送出する方法を示します。start() が呼び出されるときにタイマーが起動し、その後に タイマーイベントが送出されます。
package {
    import flash.utils.Timer;
    import flash.events.TimerEvent;
    import flash.display.Sprite;

    public class TimerExample extends Sprite {

        public function TimerExample() {
            var myTimer:Timer = new Timer(1000, 2);
            myTimer.addEventListener("timer", timerHandler);
            myTimer.start();
        }

        public function timerHandler(event:TimerEvent):void {
            trace("timerHandler: " + event);
        }
    }
}