openfl/lib/openfl/utils/Timer.d.ts

A fast, productive library for 2D cross-platform development.

import EventDispatcher from "./../events/EventDispatcher";


declare namespace openfl.utils {
	
	
	/**
	 * The Timer class is the interface to timers, which let you run code on a
	 * specified time sequence. Use the `start()` method to start a
	 * timer. Add an event listener for the `timer` event to set up
	 * code to be run on the timer interval.
	 *
	 * You can create Timer objects to run once or repeat at specified
	 * intervals to execute code on a schedule. Depending on the SWF file's
	 * framerate or the runtime environment(available memory and other factors),
	 * the runtime may dispatch events at slightly offset intervals. For example,
	 * if a SWF file is set to play at 10 frames per second(fps), which is 100
	 * millisecond intervals, but your timer is set to fire an event at 80
	 * milliseconds, the event will be dispatched close to the 100 millisecond
	 * interval. Memory-intensive scripts may also offset the events.
	 * 
	 * @:event timer         Dispatched whenever a Timer object reaches an interval
	 *                      specified according to the `Timer.delay`
	 *                      property.
	 * @:event timerComplete Dispatched whenever it has completed the number of
	 *                      requests set by `Timer.repeatCount`.
	 */
	export class Timer extends EventDispatcher {
		
		
		/**
		 * The total number of times the timer has fired since it started at zero. If
		 * the timer has been reset, only the fires since the reset are counted.
		 */
		public readonly currentCount:number;
		
		/**
		 * The delay, in milliseconds, between timer events. If you set the delay
		 * interval while the timer is running, the timer will restart at the same
		 * `repeatCount` iteration.
		 *
		 * **Note:** A `delay` lower than 20 milliseconds is not
		 * recommended. Timer frequency is limited to 60 frames per second, meaning a
		 * delay lower than 16.6 milliseconds causes runtime problems.
		 * 
		 * @throws Error Throws an exception if the delay specified is negative or
		 *               not a finite number.
		 */
		public delay:number;
		
		protected get_delay ():number;
		protected set_delay (value:number):number;
		
		/**
		 * The total number of times the timer is set to run. If the repeat count is
		 * set to 0, the timer continues forever or until the `stop()`
		 * method is invoked or the program stops. If the repeat count is nonzero,
		 * the timer runs the specified number of times. If `repeatCount`
		 * is set to a total that is the same or less then `currentCount`
		 * the timer stops and will not fire again.
		 */
		public repeatCount:number;
		
		protected get_repeatCount ():number;
		protected set_repeatCount (value:number):number;
		
		/**
		 * The timer's current state; `true` if the timer is running,
		 * otherwise `false`.
		 */
		public readonly running:boolean;
		
		
		/**
		 * Constructs a new Timer object with the specified `delay` and
		 * `repeatCount` states.
		 *
		 * The timer does not start automatically; you must call the
		 * `start()` method to start it.
		 * 
		 * @param delay       The delay between timer events, in milliseconds. A
		 *                    `delay` lower than 20 milliseconds is not
		 *                    recommended. Timer frequency is limited to 60 frames
		 *                    per second, meaning a delay lower than 16.6
		 *                    milliseconds causes runtime problems.
		 * @param repeatCount Specifies the number of repetitions. If zero, the timer
		 *                    repeats infinitely. If nonzero, the timer runs the
		 *                    specified number of times and then stops.
		 * @throws Error if the delay specified is negative or not a finite number
		 */
		public constructor (delay:number, repeatCount?:number);
		
		
		/**
		 * Stops the timer, if it is running, and sets the `currentCount`
		 * property back to 0, like the reset button of a stopwatch. Then, when
		 * `start()` is called, the timer instance runs for the specified
		 * number of repetitions, as set by the `repeatCount` value.
		 * 
		 */
		public reset ():void;
		
		
		/**
		 * Starts the timer, if it is not already running.
		 * 
		 */
		public start ():void;
		
		
		/**
		 * Stops the timer. When `start()` is called after
		 * `stop()`, the timer instance runs for the _remaining_
		 * number of repetitions, as set by the `repeatCount` property.
		 * 
		 */
		public stop ():void;
		
		
	}
	
	
}


export default openfl.utils.Timer;