springroll.easeljs.SpriteSheetTask Class

Extends springroll.Task
Defined in: springroll.easeljs.SpriteSheetTask:11
Module: EaselJS Display

Create a createjs.SpriteSheet object, see SpriteSheet for more information

Constructor

springroll.easeljs.SpriteSheetTask

(
  • asset
)
private

Defined in springroll.easeljs.SpriteSheetTask:11

Parameters:

  • asset Object

    The data properties

    • images Array

      The source images

    • frames Array

      The SpriteSheet source frame data

    • type String

      Asset type must be "easeljs"

    • [cache=false] Boolean optional

      If we should cache the result

    • [id] String optional

      Id of asset

    • [complete] Function optional

      The event to call when done

    • [globalProperty='ss'] String optional

      The global window object for spritesheets

destroy

()

Inherited from springroll.Task: destroy:202

Destroy this and discard

filter

(
  • url
)
protected

Inherited from springroll.Task: filter:151

Add the sizing to each filter

Parameters:

  • url String
    The url to filter

load

(
  • source
  • [options]
)
protected

Inherited from springroll.Task: load:176

Pass-through to the Application load method

Parameters:

simpleLoad

(
  • url
  • complete
  • [progress]
  • [data]
)
protected

Inherited from springroll.Task: simpleLoad:188

Pass-through to the Application Loader.load

Parameters:

  • url String
    Path to file to load
  • complete Function
    The callback
  • [progress] Function optional
    The load progress
  • [data] Object optional
    Additiona data

start

(
  • callback
)

Inherited from springroll.Task but overwritten in start:68

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean
static

Defined in test:53

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset

cache

Boolean

Inherited from springroll.Task: cache:46

If we should cache the load and use later

Default: false

complete

Function

Inherited from springroll.Task: complete:37

The user call to fire when completed, returns the arguments result, original, and additionalAssets

Default: null

frames

Array | Object

Defined in frames:36

The frame definitions as used by the createjs.SpriteSheet object

globalProperty

String

Defined in globalProperty:42

The name of the window object library items hang on

Default: 'ss'

id

String

Inherited from springroll.Task: id:54

The task id

images

String

Defined in images:30

The collection of images paths

original

Object

Inherited from springroll.Task: original:66

Reference to the original asset data

status

Int

Inherited from springroll.Task: status:30

The current status of the task (waiting, running, etc)

Default: 0

type

String

Inherited from springroll.Task: type:60

The task type for display filter