springroll.easeljs.FlashArtTask Class

Extends springroll.Task
Defined in: springroll.easeljs.FlashArtTask:13
Module: EaselJS Display

Loads javascript art exported from Flash, with special care taken to allow images to be handled properly and to attempt to avoid library definition collisions between different pieces of art.

Constructor

springroll.easeljs.FlashArtTask

(
  • asset
)
private

Defined in springroll.easeljs.FlashArtTask:13

Parameters:

  • asset Object

    The data properties

    • type String

      Asset type must be "easeljs"

    • format String

      Asset format must be "springroll.easeljs.FlashArt"

    • src String

      The source

    • [images] Array optional

      An array of Image, TextureAtlas, or SpriteSheet assets to load

    • [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

    • [libName='lib'] String optional

      The global window object for symbols

    • [imagesName='images'] String optional

      The global window object for images

    • [sizes=null] Object optional

      Define if certain sizes are not supported

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:91

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean
static

Defined in test:76

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

id

String

Inherited from springroll.Task: id:54

The task id

images

Array

Defined in images:43

Any image, atlas, or SpriteSheet assets that should be loaded along with this piece of flash art.

imagesName

String

Defined in imagesName:65

The name of the window object images hang on

Default: 'images'

libName

String

Defined in libName:58

The name of the window object library items hang on

Default: 'lib'

original

Object

Inherited from springroll.Task: original:66

Reference to the original asset data

src

String

Defined in src:37

The path to the flash asset

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