This repository was archived by the owner on Dec 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathTimerEvent.d.ts
39 lines (39 loc) · 1.7 KB
/
TimerEvent.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import BaseEvent from './BaseEvent';
/**
* The TimerEvent...
*
* @class TimerEvent
* @extends BaseEvent
* @param type {string} The type of event. The type is case-sensitive.
* @param [bubbles=false] {boolean} Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.
* Note: With event-bubbling you can let one Event subsequently call on every ancestor ({{#crossLink "EventDispatcher/parent:property"}}{{/crossLink}})
* (containers of containers of etc.) of the {{#crossLink "DisplayObjectContainer"}}{{/crossLink}} that originally dispatched the Event, all the way up to the surface ({{#crossLink "Stage"}}{{/crossLink}}). Any classes that do not have a parent cannot bubble.
* @param [cancelable=false] {boolean} Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is true; otherwise it is false.
* @param [data=null] {any} Use to pass any type of data with the event.
* @module StructureJS
* @submodule event
* @requires Extend
* @requires BaseEvent
* @constructor
* @author Robert S. (www.codeBelt.com)
*/
declare class TimerEvent extends BaseEvent {
/**
* Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.
*
* @event TIMER
* @type {string}
* @static
*/
static TIMER: string;
/**
* Dispatched whenever it has completed the number of requests set by Timer.repeatCount.
*
* @event TIMER_COMPLETE
* @type {string}
* @static
*/
static TIMER_COMPLETE: string;
constructor(type: string, bubbles?: boolean, cancelable?: boolean, data?: any);
}
export default TimerEvent;