mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-23 21:00:01 +08:00
786 lines
34 KiB
TypeScript
786 lines
34 KiB
TypeScript
// Type definitions for EaselJS 0.7
|
|
// Project: http://www.createjs.com/#!/EaselJS
|
|
// Definitions by: Pedro Ferreira <https://bitbucket.org/drk4>, Chris Smith <https://github.com/evilangelist>
|
|
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
|
|
|
/*
|
|
Copyright (c) 2012 Pedro Ferreira
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
|
|
/// <reference path="../tweenjs/tweenjs.d.ts" />
|
|
|
|
// rename the native MouseEvent, to avoid conflict with createjs's MouseEvent
|
|
interface NativeMouseEvent extends MouseEvent {
|
|
|
|
}
|
|
|
|
declare module createjs {
|
|
// :: base classes :: //
|
|
|
|
export class DisplayObject extends EventDispatcher {
|
|
// properties
|
|
alpha: number;
|
|
cacheCanvas: HTMLCanvasElement;
|
|
cacheID: number;
|
|
compositeOperation: string;
|
|
cursor: string;
|
|
filters: Filter[];
|
|
hitArea: DisplayObject;
|
|
id: number;
|
|
mask: Shape;
|
|
mouseEnabled: boolean;
|
|
name: string;
|
|
parent: DisplayObject;
|
|
regX: number;
|
|
regY: number;
|
|
rotation: number;
|
|
scaleX: number;
|
|
scaleY: number;
|
|
shadow: Shadow;
|
|
skewX: number;
|
|
skewY: number;
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
snapToPixel: boolean;
|
|
static suppressCrossDomainErrors: boolean;
|
|
visible: boolean;
|
|
x: number;
|
|
y: number;
|
|
|
|
// methods
|
|
cache(x: number, y: number, width: number, height: number, scale?: number): void;
|
|
clone(): DisplayObject;
|
|
draw(ctx: CanvasRenderingContext2D, ignoreCache?: boolean): void;
|
|
getBounds(): Rectangle;
|
|
getCacheDataURL(): string;
|
|
getConcatenatedMatrix(mtx?: Matrix2D): Matrix2D;
|
|
getMatrix(matrix?: Matrix2D): Matrix2D;
|
|
getStage(): Stage;
|
|
getTransformedBounds(): Rectangle;
|
|
globalToLocal(x: number, y: number): Point;
|
|
hitTest(x: number, y: number): boolean;
|
|
isVisible(): boolean;
|
|
localToGlobal(x: number, y: number): Point;
|
|
localToLocal(x: number, y: number, target: DisplayObject): Point;
|
|
set(props: Object): DisplayObject;
|
|
setBounds(x: number, y: number, width: number, height: number);
|
|
setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, regX?: number, regY?: number): DisplayObject;
|
|
uncache(): void;
|
|
updateCache(compositeOperation: string): void;
|
|
updateContext(ctx: CanvasRenderingContext2D): void;
|
|
}
|
|
|
|
|
|
export class Filter {
|
|
constructor ();
|
|
applyFilter(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, targetCtx?: CanvasRenderingContext2D, targetX?: number, targetY?: number): boolean;
|
|
clone(): Filter;
|
|
getBounds(): Rectangle;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
// :: The rest :: //
|
|
|
|
export class AlphaMapFilter extends Filter {
|
|
// properties
|
|
alphaMap: any; //Image or HTMLCanvasElement
|
|
|
|
// methods
|
|
constructor (alphaMap: HTMLImageElement);
|
|
constructor (alphaMap: HTMLCanvasElement);
|
|
clone(): AlphaMapFilter;
|
|
}
|
|
|
|
|
|
export class AlphaMaskFilter extends Filter {
|
|
// properties
|
|
mask: any; // HTMLImageElement or HTMLCanvasElement
|
|
|
|
// methods
|
|
constructor (mask: HTMLImageElement);
|
|
constructor (mask: HTMLCanvasElement);
|
|
clone(): AlphaMaskFilter;
|
|
}
|
|
|
|
|
|
export class Bitmap extends DisplayObject {
|
|
// properties
|
|
image: any; // HTMLImageElement or HTMLCanvasElement or HTMLVideoElement
|
|
sourceRect: Rectangle;
|
|
|
|
// methods
|
|
constructor (imageOrUrl: HTMLImageElement);
|
|
constructor (imageOrUrl: HTMLCanvasElement);
|
|
constructor (imageOrUrl: HTMLVideoElement);
|
|
constructor (imageOrUrl: string);
|
|
|
|
clone(): Bitmap;
|
|
}
|
|
|
|
export class BitmapText extends DisplayObject {
|
|
// properties
|
|
letterSpacing: number;
|
|
lineHeight: number;
|
|
spaceWidth: number;
|
|
spriteSheet: SpriteSheet;
|
|
text: String;
|
|
|
|
// methods
|
|
constructor(text?: string, spriteSheet?: SpriteSheet);
|
|
}
|
|
|
|
/**
|
|
* @deprecated renamed to Sprite, here for backwards compatibility
|
|
*/
|
|
export class BitmapAnimation extends Sprite {
|
|
}
|
|
|
|
export class Sprite extends DisplayObject {
|
|
// properties
|
|
currentAnimation: string;
|
|
currentAnimationFrame: number;
|
|
currentFrame: number;
|
|
framerate: number;
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
offset: number;
|
|
paused: boolean;
|
|
spriteSheet: SpriteSheet;
|
|
|
|
// methods
|
|
constructor(spriteSheet: SpriteSheet, frameOrAnimation?: number);
|
|
constructor(spriteSheet: SpriteSheet, frameOrAnimation?: string);
|
|
advance(time?: number): void;
|
|
clone(): Sprite;
|
|
gotoAndPlay(frameOrAnimation: string): void;
|
|
gotoAndPlay(frameOrAnimation: number): void;
|
|
gotoAndStop(frameOrAnimation: string): void;
|
|
gotoAndStop (frameOrAnimation: number): void;
|
|
play(): void;
|
|
stop(): void;
|
|
}
|
|
|
|
export class ButtonHelper {
|
|
// properties
|
|
target: Object; // MovieClip or Sprite
|
|
overLabel: string;
|
|
outLabel: string;
|
|
downLabel: string;
|
|
play: boolean;
|
|
|
|
// methods
|
|
constructor(target: MovieClip, outLabel?: string, overLabel?: string, downLabel?: string, play?: boolean, hitArea?: DisplayObject, hitLabel?: string);
|
|
constructor(target: Sprite, outLabel?: string, overLabel?: string, downLabel?: string, play?: boolean, hitArea?: DisplayObject, hitLabel?: string);
|
|
setEnabled(value: boolean): void;
|
|
toString(): string;
|
|
}
|
|
|
|
export class BlurFilter extends Filter {
|
|
// properties
|
|
blurX: number;
|
|
blurY: number;
|
|
quality: number;
|
|
|
|
// methods
|
|
constructor (blurX?: number, blurY?: number, quality?: number);
|
|
clone(): BlurFilter;
|
|
}
|
|
|
|
|
|
export class ColorFilter extends Filter {
|
|
// properties
|
|
alphaOffset: number;
|
|
alphaMultiplier: number;
|
|
blueMultiplier: number;
|
|
blueOffset: number;
|
|
greenMultiplier: number;
|
|
greenOffset: number;
|
|
redMultiplier: number;
|
|
redOffset: number;
|
|
|
|
// methods
|
|
constructor (redMultiplier?: number, greenMultiplier?: number, blueMultiplier?: number, alphaMultiplier?: number, redOffset?: number, greenOffset?: number, blueOffset?: number, alphaOffset?: number);
|
|
clone(): ColorFilter;
|
|
}
|
|
|
|
|
|
export class ColorMatrix {
|
|
// properties
|
|
static DELTA_INDEX: number[];
|
|
static IDENTITY_MATRIX: number[];
|
|
static LENGTH: number;
|
|
|
|
// methods
|
|
constructor (brightness: number, contrast: number, saturation: number, hue: number);
|
|
adjustBrightness(value: number): ColorMatrix;
|
|
adjustColor(brightness: number, contrast: number, saturation: number, hue: number): ColorMatrix;
|
|
adjustContrast(value: number): ColorMatrix;
|
|
adjustHue(value: number): ColorMatrix;
|
|
adjustSaturation(value: number): ColorMatrix;
|
|
clone(): ColorMatrix;
|
|
concat(matrix: ColorMatrix): ColorMatrix;
|
|
concat(matrix: number[]): ColorMatrix;
|
|
copyMatrix(matrix: ColorMatrix): ColorMatrix;
|
|
copyMatrix(matrix: number[]): ColorMatrix;
|
|
reset(): ColorMatrix;
|
|
toArray(): number[];
|
|
}
|
|
|
|
|
|
export class ColorMatrixFilter extends Filter {
|
|
// methods
|
|
constructor (matrix: number[]);
|
|
clone(): ColorMatrixFilter;
|
|
}
|
|
|
|
|
|
export class Command {
|
|
// methods
|
|
constructor (f: any, params: any, path: any);
|
|
exec(scope: any): void;
|
|
}
|
|
|
|
|
|
export class Container extends DisplayObject {
|
|
// properties
|
|
children: DisplayObject[];
|
|
mouseChildren: boolean;
|
|
|
|
// methods
|
|
constructor();
|
|
addChild(...child: DisplayObject[]): DisplayObject;
|
|
addChildAt(child: DisplayObject, index: number): DisplayObject; // add this for the common case
|
|
addChildAt(...childOrIndex: any[]): DisplayObject; // actually (...child: DisplayObject[], index: number)
|
|
clone(recursive?: boolean): Container;
|
|
contains(child: DisplayObject): boolean;
|
|
getChildAt(index: number): DisplayObject;
|
|
getChildByName(name: string): DisplayObject;
|
|
getChildIndex(child: DisplayObject): number;
|
|
getNumChildren(): number;
|
|
getObjectsUnderPoint(x: number, y: number): DisplayObject[];
|
|
getObjectUnderPoint(x: number, y: number): DisplayObject;
|
|
removeAllChildren(): void;
|
|
removeChild(...child: DisplayObject[]): boolean;
|
|
removeChildAt(...index: number[]): boolean;
|
|
setChildIndex(child: DisplayObject, index: number): void;
|
|
sortChildren(sortFunction: (a: DisplayObject, b: DisplayObject) => number): void;
|
|
swapChildren(child1: DisplayObject, child2: DisplayObject): void;
|
|
swapChildrenAt(index1: number, index2: number): void;
|
|
}
|
|
|
|
|
|
export class DOMElement extends DisplayObject {
|
|
// properties
|
|
htmlElement: HTMLElement;
|
|
|
|
// methods
|
|
constructor (htmlElement: HTMLElement);
|
|
clone(): DOMElement;
|
|
}
|
|
|
|
|
|
export class EaselJS {
|
|
// properties
|
|
version: string;
|
|
buildDate: string;
|
|
}
|
|
|
|
export class Event {
|
|
// properties
|
|
bubbles: boolean;
|
|
cancelable: boolean;
|
|
currentTarget: Object;
|
|
defaultPrevented: boolean;
|
|
eventPhase: number;
|
|
immediatePropagationStopped: boolean;
|
|
propagationStopped: boolean;
|
|
removed: boolean;
|
|
target: Object;
|
|
timeStamp: number;
|
|
type: String;
|
|
|
|
// methods
|
|
constructor (type: String, bubbles: boolean, cancelable: boolean);
|
|
clone(): Event;
|
|
preventDefault(): void;
|
|
remove(): void
|
|
stopImmediatePropagation(): void;
|
|
stopPropagation(): void;
|
|
toString(): string;
|
|
}
|
|
|
|
export class EventDispatcher {
|
|
// properties
|
|
|
|
// methods
|
|
static initialize(target: Object): void;
|
|
|
|
addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
on(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
on(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
on(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
on(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
off(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
off(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
removeAllEventListeners(type?: string): void;
|
|
dispatchEvent(eventObj: string, target?: Object): boolean;
|
|
dispatchEvent(eventObj: Object, target?: Object): boolean;
|
|
dispatchEvent(eventObj: Event, target?: Object): boolean;
|
|
hasEventListener(type: string): boolean;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
export class Graphics {
|
|
// properties
|
|
static BASE_64: Object;
|
|
static STROKE_CAPS_MAP: string[];
|
|
static STROKE_JOINTS_MAP: string[];
|
|
|
|
// methods
|
|
arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): Graphics;
|
|
arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): Graphics;
|
|
beginBitmapFill(image: Object, repetition?: string, matrix?: Matrix2D): Graphics;
|
|
beginBitmapStroke(image: Object, repetition?: string): Graphics;
|
|
beginFill(color: string): Graphics;
|
|
beginLinearGradientFill(colors: string[], ratios: number[], x0: number, y0: number, x1: number, y1: number): Graphics;
|
|
beginLinearGradientStroke(colors: string[], ratios: number[], x0: number, y0: number, x1: number, y1: number): Graphics;
|
|
beginRadialGradientFill(colors: string[], ratios: number[], x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): Graphics;
|
|
beginRadialGradientStroke(colors: string[], ratios: number[], x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): Graphics;
|
|
beginStroke(color: string): Graphics;
|
|
bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): Graphics;
|
|
clear(): Graphics;
|
|
clone(): Graphics;
|
|
closePath(): Graphics;
|
|
curveTo(cpx: number, cpy: number, x: number, y: number): Graphics; // same as quadraticCurveTo()
|
|
decodePath(str: string): Graphics;
|
|
draw(ctx: CanvasRenderingContext2D): void;
|
|
drawAsPath(ctx: CanvasRenderingContext2D): void;
|
|
drawCircle(x: number, y: number, radius: number): Graphics;
|
|
drawEllipse(x: number, y: number, width: number, height: number): Graphics;
|
|
drawPolyStar(x: number, y: number, radius: number, sides: number, pointSize: number, angle: number): Graphics;
|
|
drawRect(x: number, y: number, width: number, height: number): Graphics; // same as rect()
|
|
drawRoundRect(x: number, y: number, width: number, height: number, radius: number): Graphics;
|
|
drawRoundRectComplex(x: number, y: number, width: number, height: number, radiusTL: number, radiusTR: number, radiusBR: number, radisBL: number): Graphics;
|
|
endFill(): Graphics;
|
|
endStroke(): Graphics;
|
|
static getHSL(hue: number, saturation: number, lightness: number, alpha?: number): string;
|
|
static getRGB(red: number, green: number, blue: number, alpha?: number): string;
|
|
inject(callback: Function, data: Object): Graphics;
|
|
isEmpty(): boolean;
|
|
lineTo(x: number, y: number): Graphics;
|
|
moveTo(x: number, y: number): Graphics;
|
|
quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): Graphics;
|
|
rect(x: number, y: number, width: number, height: number): Graphics;
|
|
setStrokeStyle(thickness: number, caps?: string, joints?: string, miterLimit?: number, ignoreScale?: boolean): Graphics; // caps and joints can be a string or number
|
|
setStrokeStyle(thickness: number, caps?: number, joints?: string, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
setStrokeStyle(thickness: number, caps?: string, joints?: number, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
setStrokeStyle(thickness: number, caps?: number, joints?: number, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
toString(): string;
|
|
|
|
// tiny API - short forms of methods above
|
|
mt(x: number, y: number): Graphics;
|
|
a(x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): Graphics;
|
|
at(x1: number, y1: number, x2: number, y2: number, radius: number): Graphics;
|
|
qt(cpx: number, cpy: number, x: number, y: number): Graphics;
|
|
cp(): Graphics;
|
|
f(color: string): Graphics;
|
|
rf(colors: string[], ratios: number[], x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): Graphics;
|
|
ef(): Graphics;
|
|
s(color: string): Graphics;
|
|
rs(colors: string[], ratios: number[], x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): Graphics;
|
|
es(): Graphics;
|
|
rr(x: number, y: number, width: number, height: number, radius: number): Graphics;
|
|
dc(x: number, y: number, radius: number): Graphics;
|
|
dp(x: number, y: number, radius: number, sides: number, pointSize: number, angle: number): Graphics;
|
|
lt(x: number, y: number): Graphics;
|
|
bt(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): Graphics;
|
|
r(x: number, y: number, width: number, height: number): Graphics;
|
|
c(): Graphics;
|
|
lf(colors: string[], ratios: number[], x0: number, y0: number, x1: number, y1: number): Graphics;
|
|
bf(image: Object, repetition?: string, matrix?: Matrix2D): Graphics;
|
|
ss(thickness: number, caps?: string, joints?: string, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
ss(thickness: number, caps?: number, joints?: string, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
ss(thickness: number, caps?: string, joints?: number, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
ss(thickness: number, caps?: number, joints?: number, miterLimit?: number, ignoreScale?: boolean): Graphics;
|
|
ls(colors: string[], ratios: number[], x0: number, y0: number, x1: number, y1: number): Graphics;
|
|
bs(image: Object, repetition?: string): Graphics;
|
|
dr(x: number, y: number, width: number, height: number): Graphics;
|
|
rc(x: number, y: number, width: number, height: number, radiusTL: number, radiusTR: number, radiusBR: number, radisBL: number): Graphics;
|
|
de(x: number, y: number, width: number, height: number): Graphics;
|
|
p(str: string): Graphics;
|
|
}
|
|
|
|
export class Matrix2D {
|
|
// properties
|
|
a: number;
|
|
alpha: number;
|
|
b: number;
|
|
c: number;
|
|
compositeOperation: string;
|
|
d: number;
|
|
static DEG_TO_RAD: number;
|
|
static identity: Matrix2D;
|
|
shadow: Shadow;
|
|
tx: number;
|
|
ty: number;
|
|
|
|
// methods
|
|
constructor (a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number);
|
|
append(a: number, b: number, c: number, d: number, tx: number, ty: number): Matrix2D;
|
|
appendMatrix(matrix: Matrix2D): Matrix2D;
|
|
appendProperties(alpha: number, shadow: Shadow, compositeOperation: string): Matrix2D;
|
|
appendTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, regX?: number, regY?: number): Matrix2D;
|
|
clone(): Matrix2D;
|
|
copy(matrix: Matrix2D): Matrix2D;
|
|
decompose(target: Object): Matrix2D;
|
|
identity(): Matrix2D;
|
|
invert(): Matrix2D;
|
|
isIdentity(): boolean;
|
|
prepend(a: number, b: number, c: number, d: number, tx: number, ty: number): Matrix2D;
|
|
prependMatrix(matrix: Matrix2D): Matrix2D;
|
|
prependProperties(alpha: number, shadow: Shadow, compositeOperation: string): Matrix2D;
|
|
prependTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, regX?: number, regY?: number): Matrix2D;
|
|
reinitialize(a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number, alpha?: number, shadow?: Shadow, compositeOperation?: string): Matrix2D;
|
|
rotate(angle: number): Matrix2D;
|
|
scale(x: number, y: number): Matrix2D;
|
|
skew(skewX: number, skewY: number): Matrix2D;
|
|
toString(): string;
|
|
transformPoint(x: number, y: number, pt?: Point): Point;
|
|
transformPoint(x: number, y: number, pt?: Object): Point;
|
|
translate(x: number, y: number): Matrix2D;
|
|
}
|
|
|
|
|
|
export class MouseEvent extends Event {
|
|
// properties
|
|
nativeEvent: NativeMouseEvent;
|
|
pointerID: number;
|
|
primary: boolean;
|
|
rawX: number;
|
|
rawY: number;
|
|
stageX: number;
|
|
stageY: number;
|
|
|
|
// methods
|
|
constructor (type: string, bubbles: boolean, cancelable: boolean, stageX: number, stageY: number, nativeEvent: NativeMouseEvent, pointerID: number, primary: boolean, rawX: number, rawY: number);
|
|
clone(): MouseEvent;
|
|
|
|
// EventDispatcher mixins
|
|
addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
on(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
on(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
on(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
on(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
off(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
off(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
removeAllEventListeners(type?: string): void;
|
|
dispatchEvent(eventObj: string, target?: Object): boolean;
|
|
dispatchEvent(eventObj: Object, target?: Object): boolean;
|
|
dispatchEvent(eventObj: Event, target?: Object): boolean;
|
|
hasEventListener(type: string): boolean;
|
|
}
|
|
|
|
|
|
export class MovieClip extends Container {
|
|
// properties
|
|
actionsEnabled: boolean;
|
|
autoReset: boolean;
|
|
static buildDate: string;
|
|
currentFrame: number;
|
|
frameBounds:Rectangle[];
|
|
static INDEPENDENT: string;
|
|
loop: boolean;
|
|
mode: string;
|
|
paused: boolean;
|
|
static SINGLE_FRAME: string;
|
|
startPosition: number;
|
|
static SYNCHED: string;
|
|
timeline: Timeline; //HERE requires tweenJS
|
|
static version: string;
|
|
|
|
// methods
|
|
constructor (mode?: string, startPosition?: number, loop?: boolean, labels?: Object);
|
|
clone(): MovieClip; // not supported
|
|
getCurrentLabel(): string;
|
|
getLabels(): Object[];
|
|
gotoAndPlay(positionOrLabel: string): void;
|
|
gotoAndPlay(positionOrLabel: number): void;
|
|
gotoAndStop(positionOrLabel: string): void;
|
|
gotoAndStop(positionOrLabel: number): void;
|
|
play(): void;
|
|
stop(): void;
|
|
}
|
|
|
|
|
|
export class Point {
|
|
// properties
|
|
x: number;
|
|
y: number;
|
|
|
|
// methods
|
|
constructor (x?: number, y?: number);
|
|
clone(): Point;
|
|
copy(point: Point): Point;
|
|
initialize(x?: number, y?: number): Point;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
export class Rectangle {
|
|
// properties
|
|
x: number;
|
|
y: number;
|
|
width: number;
|
|
height: number;
|
|
|
|
// methods
|
|
constructor (x?: number, y?: number, width?: number, height?: number);
|
|
clone(): Rectangle;
|
|
copy(rectangle: Rectangle): Rectangle;
|
|
initialize(x?: number, y?: number, width?: number, height?: number): Rectangle;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
export class Shadow {
|
|
// properties
|
|
blur: number;
|
|
color: string;
|
|
static identity: Shadow;
|
|
offsetX: number;
|
|
offsetY: number;
|
|
|
|
// methods
|
|
constructor (color: string, offsetX: number, offsetY: number, blur: number);
|
|
clone(): Shadow;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
export class Shape extends DisplayObject {
|
|
// properties
|
|
graphics: Graphics;
|
|
|
|
// methods
|
|
constructor (graphics?: Graphics);
|
|
clone(recursive?: boolean): Shape;
|
|
}
|
|
|
|
|
|
// what is returned from SpriteSheet.getAnimation(string)
|
|
interface SpriteSheetAnimation {
|
|
frames: number[];
|
|
speed: number;
|
|
name: string;
|
|
next: string;
|
|
}
|
|
|
|
// what is returned from SpriteSheet.getFrame(number)
|
|
interface SpriteSheetFrame {
|
|
image: HTMLImageElement;
|
|
rect: Rectangle;
|
|
}
|
|
|
|
export class SpriteSheet extends EventDispatcher {
|
|
// properties
|
|
complete: boolean;
|
|
framerate: number;
|
|
|
|
// methods
|
|
constructor (data: Object);
|
|
clone(): SpriteSheet;
|
|
getAnimation(name: string): SpriteSheetAnimation;
|
|
getAnimations(): string[];
|
|
getFrame(frameIndex: number): SpriteSheetFrame;
|
|
getFrameBounds(frameIndex: number, rectangle?: Rectangle): Rectangle;
|
|
getNumFrames(animation: string): number;
|
|
}
|
|
|
|
|
|
export class SpriteSheetBuilder extends EventDispatcher {
|
|
// properties
|
|
maxWidth: number;
|
|
maxHeight: number;
|
|
padding: number;
|
|
progress: number;
|
|
scale: number;
|
|
spriteSheet: SpriteSheet;
|
|
timeSlice: number;
|
|
|
|
// methods
|
|
addAnimation(name: string, frames: number[], next?: string, frequency?: number): void;
|
|
addFrame(source: DisplayObject, sourceRect?: Rectangle, scale?: number, setupFunction?: () => any, setupParams?: any[], setupScope?: Object): any; //HERE returns number or null
|
|
addMovieClip(source: MovieClip, sourceRect?: Rectangle, scale?: number): void;
|
|
build(): SpriteSheet;
|
|
buildAsync(timeSlice?: number): void;
|
|
clone(): SpriteSheetBuilder;
|
|
stopAsync(): void;
|
|
toString(): string;
|
|
}
|
|
|
|
|
|
export class SpriteSheetUtils {
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
static addFlippedFrames(spriteSheet: SpriteSheet, horizontal?: boolean, vertical?: boolean, both?: boolean): void;
|
|
static extractFrame(spriteSheet: SpriteSheet, frame: number): HTMLImageElement;
|
|
static extractFrame(spriteSheet: SpriteSheet, animationName: string): HTMLImageElement;
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
static mergeAlpha(rgbImage: HTMLImageElement, alphaImage: HTMLImageElement, canvas?: HTMLCanvasElement): HTMLCanvasElement;
|
|
}
|
|
|
|
|
|
export class Stage extends Container {
|
|
// properties
|
|
autoClear: boolean;
|
|
canvas: HTMLCanvasElement;
|
|
mouseInBounds: boolean;
|
|
mouseMoveOutside: boolean;
|
|
mouseX: number;
|
|
mouseY: number;
|
|
nextStage: Stage;
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
snapToPixelEnabled: boolean;
|
|
tickOnUpdate: boolean;
|
|
|
|
// methods
|
|
constructor (canvas: HTMLCanvasElement);
|
|
clear(): void;
|
|
clone(): Stage;
|
|
enableDOMEvents(enable?: boolean): void;
|
|
enableMouseOver(frequency?: number): void;
|
|
handleEvent(evt: Object): void;
|
|
toDataURL(backgroundColor?: string, mimeType?: string): string;
|
|
update(...params: any[]): void;
|
|
}
|
|
|
|
|
|
export class Text extends DisplayObject {
|
|
// properties
|
|
color: string;
|
|
font: string;
|
|
lineHeight: number;
|
|
lineWidth: number;
|
|
maxWidth: number;
|
|
outline: number;
|
|
text: string;
|
|
textAlign: string;
|
|
textBaseline: string;
|
|
|
|
// methods
|
|
constructor (text?: string, font?: string, color?: string);
|
|
clone(): Text;
|
|
getMeasuredHeight(): number;
|
|
getMeasuredLineHeight(): number;
|
|
getMeasuredWidth(): number;
|
|
}
|
|
|
|
|
|
export class Ticker {
|
|
// properties
|
|
static maxDelta: number;
|
|
static RAF: string;
|
|
static RAF_SYNCHED: string;
|
|
static TIMEOUT: string;
|
|
static timingMode: string;
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
static useRAF: boolean;
|
|
|
|
// methods
|
|
getEventTime(runTime: boolean): number;
|
|
static getFPS(): number;
|
|
static getInterval(): number;
|
|
static getMeasuredFPS(ticks?: number): number;
|
|
static getMeasuredTickTime(ticks?: number): number;
|
|
static getPaused(): boolean;
|
|
static getTicks(pauseable?: boolean): number;
|
|
static getTime(runTime: boolean): number;
|
|
static init(): void;
|
|
static reset(): void;
|
|
static setFPS(value: number): void;
|
|
static setInterval(interval: number): void;
|
|
static setPaused(value: boolean): void;
|
|
toString(): string;
|
|
|
|
// EventDispatcher mixins
|
|
static addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
static addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
static addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
static addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
static on(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function;
|
|
static on(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function;
|
|
static on(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object;
|
|
static on(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object;
|
|
static removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
static removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
static removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
static removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
static off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void;
|
|
static off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void;
|
|
static off(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): void;
|
|
static off(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): void;
|
|
static removeAllEventListeners(type?: string): void;
|
|
static dispatchEvent(eventObj: string, target?: Object): boolean;
|
|
static dispatchEvent(eventObj: Object, target?: Object): boolean;
|
|
static dispatchEvent(eventObj: Event, target?: Object): boolean;
|
|
static hasEventListener(type: string): boolean;
|
|
}
|
|
|
|
export class TickerEvent {
|
|
// properties
|
|
target: Object;
|
|
type: string;
|
|
paused: boolean;
|
|
delta: number;
|
|
time: number;
|
|
runTime : number;
|
|
}
|
|
|
|
|
|
export class Touch {
|
|
// methods
|
|
static disable(stage: Stage): void;
|
|
static enable(stage: Stage, singleTouch?: boolean, allowDefault?: boolean): boolean;
|
|
static isSupported(): boolean;
|
|
}
|
|
|
|
|
|
export class UID {
|
|
// methods
|
|
static get(): number;
|
|
}
|
|
}
|