Class SpriteSheetBuilder

Hierarchy

  • createjs.EventDispatcher
    • SpriteSheetBuilder

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(): SpriteSheetBuilder

Returns

SpriteSheetBuilder

Properties

public maxHeight: number

public maxWidth: number

public padding: number

public progress: number

public scale: number

public spriteSheet: SpriteSheet

public timeSlice: number

Methods

public addAnimation(name: string, frames: Array<number>, next?: string, frequency?: number)

Parameters

  • name: string
  • frames: Array<number>
  • next?: string optional
  • frequency?: number optional

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 addFrame(source: DisplayObject, sourceRect?: Rectangle, scale?: number, setupFunction?: () => any, setupParams?: Array<any>, setupScope?: Object): number

Parameters

  • source: DisplayObject
  • sourceRect?: Rectangle optional
  • scale?: number optional
  • setupFunction?: () => any optional
  • setupParams?: Array<any> optional
  • setupScope?: Object optional

Returns

number

public addMovieClip(source: MovieClip, sourceRect?: Rectangle, scale?: number)

Parameters

public build(): SpriteSheet

Returns

SpriteSheet

public buildAsync(timeSlice?: number)

Parameters

  • timeSlice?: number optional

public clone()

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 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 stopAsync()

public toString(): string

Returns

string

public willTrigger(type: string): boolean

Parameters

  • type: string

Returns

boolean