Class Sprite

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(spriteSheet: SpriteSheet, frameOrAnimation?: string): Sprite

Parameters

  • spriteSheet: SpriteSheet
  • frameOrAnimation?: string optional

Returns

Sprite

constructor(spriteSheet: SpriteSheet, frameOrAnimation?: number): Sprite

Parameters

  • spriteSheet: SpriteSheet
  • frameOrAnimation?: number optional

Returns

Sprite

Properties

public alpha: number

public cacheCanvas: any

public cacheID: number

public compositeOperation: string

public currentAnimation: string

public currentAnimationFrame: number

public currentFrame: number

public cursor: string

public filters: Filter[]

public framerate: number

public hitArea: DisplayObject

public id: number

public mask: Shape

public mouseEnabled: boolean

public name: string

public offset: number

deprecated

public parent: Container

public paused: boolean

public regX: number

public regY: number

public rotation: number

public scaleX: number

public scaleY: number

public shadow: Shadow

public skewX: number

public skewY: number

public snapToPixel: boolean

deprecated

public spriteSheet: SpriteSheet

public tickEnabled: boolean

public visible: boolean

public x: number

public y: number

Methods

public addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function

Parameters

  • type: string
  • listener: (eventObj: Object) => boolean
  • useCapture?: boolean optional

Returns

Function

public addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function

Parameters

  • type: string
  • listener: (eventObj: Object) => void
  • useCapture?: boolean optional

Returns

Function

public addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean): Object

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => boolean; }
  • useCapture?: boolean optional

Returns

Object

public addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean): Object

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => void; }
  • useCapture?: boolean optional

Returns

Object

public advance(time?: number)

Parameters

  • time?: number optional

public cache(x: number, y: number, width: number, height: number, scale?: number)

Parameters

  • x: number
  • y: number
  • width: number
  • height: number
  • scale?: number optional

public clone(): Sprite

Returns

Sprite

public dispatchEvent(eventObj: Object, target?: Object): boolean

Parameters

  • eventObj: Object
  • target?: Object optional

Returns

boolean

public dispatchEvent(eventObj: string, target?: Object): boolean

Parameters

  • eventObj: string
  • target?: Object optional

Returns

boolean

public dispatchEvent(eventObj: createjs.Event, target?: Object): boolean

Parameters

  • eventObj: createjs.Event
  • target?: Object optional

Returns

boolean

public draw(ctx: CanvasRenderingContext2D, ignoreCache?: boolean): boolean

Parameters

  • ctx: CanvasRenderingContext2D
  • ignoreCache?: boolean optional

Returns

boolean

public getBounds(): Rectangle

Returns

Rectangle

public getCacheDataURL(): string

Returns

string

public getConcatenatedMatrix(mtx?: Matrix2D): Matrix2D

Parameters

Returns

Matrix2D

public getMatrix(matrix?: Matrix2D): Matrix2D

Parameters

Returns

Matrix2D

public getStage(): Stage

Returns

Stage

public getTransformedBounds(): Rectangle

Returns

Rectangle

public globalToLocal(x: number, y: number): Point

Parameters

  • x: number
  • y: number

Returns

Point

public gotoAndPlay(frameOrAnimation: string)

Parameters

  • frameOrAnimation: string

public gotoAndPlay(frameOrAnimation: number)

Parameters

  • frameOrAnimation: number

public gotoAndStop(frameOrAnimation: string)

Parameters

  • frameOrAnimation: string

public gotoAndStop(frameOrAnimation: number)

Parameters

  • frameOrAnimation: number

public hasEventListener(type: string): boolean

Parameters

  • type: string

Returns

boolean

public hitTest(x: number, y: number): boolean

Parameters

  • x: number
  • y: number

Returns

boolean

public isVisible(): boolean

Returns

boolean

public localToGlobal(x: number, y: number): Point

Parameters

  • x: number
  • y: number

Returns

Point

public localToLocal(x: number, y: number, target: DisplayObject): Point

Parameters

Returns

Point

public off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean)

Parameters

  • type: string
  • listener: (eventObj: Object) => boolean
  • useCapture?: boolean optional

public off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean)

Parameters

  • type: string
  • listener: (eventObj: Object) => void
  • useCapture?: boolean optional

public off(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean)

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => boolean; }
  • useCapture?: boolean optional

public off(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean)

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => void; }
  • useCapture?: boolean optional

public off(type: string, listener: Function, useCapture?: boolean)

Parameters

  • type: string
  • listener: Function
  • useCapture?: boolean optional

public on(type: string, listener: (eventObj: Object) => boolean, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function

Parameters

  • type: string
  • listener: (eventObj: Object) => boolean
  • scope?: Object optional
  • once?: boolean optional
  • data?: any optional
  • useCapture?: boolean optional

Returns

Function

public on(type: string, listener: (eventObj: Object) => void, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function

Parameters

  • type: string
  • listener: (eventObj: Object) => void
  • scope?: Object optional
  • once?: boolean optional
  • data?: any optional
  • useCapture?: boolean optional

Returns

Function

public on(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => boolean; }
  • scope?: Object optional
  • once?: boolean optional
  • data?: any optional
  • useCapture?: boolean optional

Returns

Object

public on(type: string, listener: { handleEvent: (eventObj: Object) => void; }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => void; }
  • scope?: Object optional
  • once?: boolean optional
  • data?: any optional
  • useCapture?: boolean optional

Returns

Object

public play()

public removeAllEventListeners(type?: string)

Parameters

  • type?: string optional

public removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean)

Parameters

  • type: string
  • listener: (eventObj: Object) => boolean
  • useCapture?: boolean optional

public removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean)

Parameters

  • type: string
  • listener: (eventObj: Object) => void
  • useCapture?: boolean optional

public removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean; }, useCapture?: boolean)

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => boolean; }
  • useCapture?: boolean optional

public removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void; }, useCapture?: boolean)

Parameters

  • type: string
  • listener: { handleEvent: (eventObj: Object) => void; }
  • useCapture?: boolean optional

public removeEventListener(type: string, listener: Function, useCapture?: boolean)

Parameters

  • type: string
  • listener: Function
  • useCapture?: boolean optional

public set(props: Object): Sprite

Parameters

  • props: Object

Returns

Sprite

public setBounds(x: number, y: number, width: number, height: number)

Parameters

  • x: number
  • y: number
  • width: number
  • height: number

public setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, regX?: number, regY?: number): Sprite

Parameters

  • x?: number optional
  • y?: number optional
  • scaleX?: number optional
  • scaleY?: number optional
  • rotation?: number optional
  • skewX?: number optional
  • skewY?: number optional
  • regX?: number optional
  • regY?: number optional

Returns

Sprite

public stop()

public toString(): string

Returns

string

public uncache()

public updateCache(compositeOperation?: string)

Parameters

  • compositeOperation?: string optional

public updateContext(ctx: CanvasRenderingContext2D)

Parameters

  • ctx: CanvasRenderingContext2D

public willTrigger(type: string): boolean

Parameters

  • type: string

Returns

boolean