Class SpriteSheet

Hierarchy

  • createjs.EventDispatcher
    • SpriteSheet

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(data: Object): SpriteSheet

Parameters

  • data: Object

Returns

SpriteSheet

Properties

public complete: boolean

public framerate: 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 clone(): SpriteSheet

Returns

SpriteSheet

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 getAnimation(name: string): SpriteSheetAnimation

Parameters

  • name: string

Returns

SpriteSheetAnimation

public getAnimations(): Array<string>

Returns

Array<string>

public getFrame(frameIndex: number): SpriteSheetFrame

Parameters

  • frameIndex: number

Returns

SpriteSheetFrame

public getFrameBounds(frameIndex: number, rectangle?: Rectangle): Rectangle

Parameters

  • frameIndex: number
  • rectangle?: Rectangle optional

Returns

Rectangle

public getNumFrames(animation: string): number

Parameters

  • animation: string

Returns

number

public hasEventListener(type: string): boolean

Parameters

  • type: string

Returns

boolean

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 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 toString(): string

Returns

string

public willTrigger(type: string): boolean

Parameters

  • type: string

Returns

boolean