dragonbones-runtime
Version:
the tools to build dragonbones file for diffrent framework
188 lines (180 loc) • 8.67 kB
text/typescript
//////////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2014-present, Egret Technology.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of the Egret nor the
// names of its contributors may be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY EGRET AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL EGRET AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////////////
namespace egret {
export interface Timer{
addEventListener<Z>(type: "timer" | "timerComplete"
, listener: (this: Z, e: TimerEvent) => void, thisObject: Z, useCapture?: boolean, priority?: number);
addEventListener(type: string, listener: Function, thisObject: any, useCapture?: boolean, priority?: number);
}
/**
* A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval specified by the Timer.delay property.
* @see egret.Timer
* @version Egret 2.4
* @platform Web,Native
* @includeExample egret/events/TimerEvent.ts
* @language en_US
*/
/**
* 每当 Timer 对象达到由 Timer.delay 属性指定的间隔时，Timer 对象即会调度 TimerEvent 对象。
* @see egret.Timer
* @version Egret 2.4
* @platform Web,Native
* @includeExample egret/events/TimerEvent.ts
* @language zh_CN
*/
export class TimerEvent extends Event {
/**
* Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 每当 Timer 对象达到根据 Timer.delay 属性指定的间隔时调度。
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
public static TIMER:"timer" = "timer";
/**
* Dispatched whenever it has completed the number of requests set by Timer.repeatCount.
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 每当它完成 Timer.repeatCount 设置的请求数后调度。
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
public static TIMER_COMPLETE:"timerComplete" = "timerComplete";
/**
* Creates an Event object with specific information relevant to timer events.
* @param type The type of the event. Event listeners can access this information through the inherited type property.
* @param bubbles Determines whether the Event object bubbles. Event listeners can access this information through
* the inherited bubbles property.
* @param cancelable Determines whether the Event object can be canceled. Event listeners can access this information
* through the inherited cancelable property.
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 创建一个 Event 对象，其中包含有关 timer 事件的特定信息。
* @param type 事件的类型。事件侦听器可以通过继承的 type 属性访问此信息。
* @param bubbles 确定 Event 对象是否冒泡。事件侦听器可以通过继承的 bubbles 属性访问此信息。
* @param cancelable 确定是否可以取消 Event 对象。事件侦听器可以通过继承的 cancelable 属性访问此信息。
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
public constructor(type:string, bubbles?:boolean, cancelable?:boolean) {
super(type, bubbles, cancelable);
}
/**
* Instructs Egret runtime to render after processing of this event completes, if the display list has been modified.
* @example
* <pre>
* function onTimer(event:TimerEvent):void {
* if (40 < mySp.x && mySp.x < 375) {
* mySp.x-= 50;
* } else {
* mySp.x=374;
* }
* event.updateAfterEvent();
* }
*
* let moveTimer:Timer=new Timer(50,250);
* moveTimer.addEventListener(TimerEvent.TIMER,onTimer);
* moveTimer.start();
* </pre>
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 如果已修改显示列表，调用此方法将会忽略帧频限制，在此事件处理完成后立即重绘屏幕。
* @example
* <pre>
* function onTimer(event:TimerEvent):void {
* if (40 < mySp.x && mySp.x < 375) {
* mySp.x-= 50;
* } else {
* mySp.x=374;
* }
* event.updateAfterEvent();
* }
*
* let moveTimer:Timer=new Timer(50,250);
* moveTimer.addEventListener(TimerEvent.TIMER,onTimer);
* moveTimer.start();
* </pre>
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
public updateAfterEvent():void {
sys.$requestRenderingFlag = true;
}
/**
* uses a specified target to dispatchEvent an event. Using this method can reduce the number of
* reallocate event objects, which allows you to get better code execution performance.
* @param target the event target
* @param type The type of the event. Event listeners can access this information through the inherited type property.
* @param bubbles Determines whether the Event object bubbles. Event listeners can access this information through
* the inherited bubbles property.
* @param cancelable Determines whether the Event object can be canceled. Event listeners can access this information
* through the inherited cancelable property.
* @see egret.Event.create()
* @see egret.Event.release()
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 使用指定的EventDispatcher对象来抛出事件对象。抛出的对象将会缓存在对象池上，供下次循环复用。
* @param target 事件派发目标
* @param type 事件的类型。事件侦听器可以通过继承的 type 属性访问此信息。
* @param bubbles 确定 Event 对象是否冒泡。事件侦听器可以通过继承的 bubbles 属性访问此信息。
* @param cancelable 确定是否可以取消 Event 对象。事件侦听器可以通过继承的 cancelable 属性访问此信息。
* @see egret.Event.create()
* @see egret.Event.release()
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
public static dispatchTimerEvent(target:IEventDispatcher, type:string, bubbles?:boolean, cancelable?:boolean):boolean {
let event = Event.create(TimerEvent, type, bubbles, cancelable);
let result = target.dispatchEvent(event);
Event.release(event);
return result;
}
}
}