API Documentation for: 0.2.8
Show:

pixiflash.SpriteSheetTask Class

Extends springroll.LoadTask
Defined in: pixiflash.SpriteSheetTask:8
Module: SpringRoll Plugin

Load a spritesheet generated from Flash and adds it to the global ss namespace. This namespace is shared with regular CreateJS art, as it can't be changed in Flash's publishing settings. As such, don't name spritesheets for CreateJS and PixiFlash the same thing if both spritesheets are being used by art published from Flash.

Constructor

pixiflash.SpriteSheetTask

(
  • asset
)
private

Defined in pixiflash.SpriteSheetTask:8

Parameters:

  • asset Object

    The data properties

    • type String

      Asset type must be "pixi"

    • format String

      Asset format must be "pixiflash.SpriteSheet"

    • src String

      The source

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

    • [sizes=null] Object optional

      Define if certain sizes are not supported

Item Index

Methods

Methods

start

(
  • callback
)

Defined in start:50

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean static

Defined in test:35

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset