API Documentation for: 0.2.8
Show:

pixiflash.FlashArtTask Class

Extends springroll.Task
Defined in: pixiflash.FlashArtTask:13
Module: SpringRoll Plugin

Loads a FlashArt, making it easier to load and unload PixiFlash art.

Constructor

pixiflash.FlashArtTask

(
  • asset
)
private

Defined in pixiflash.FlashArtTask:13

Parameters:

  • asset Object

    The data properties

    • type String

      Asset type must be "pixi"

    • format String

      Asset format must be "pixiflash.FlashArt"

    • src String

      The source

    • images Array

      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

    • [sizes=null] Object optional

      Define if certain sizes are not supported

Item Index

Methods

Properties

Methods

start

(
  • callback
)

Defined in start:84

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean static

Defined in test:68

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset

Properties

images

Array

Defined in images:39

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

imagesName

String

Defined in imagesName:52

The name of the window object images hang on

libName

String

Defined in libName:46

The name of the window object library items hang on

src

String

Defined in src:33

The path to the flash asset

suppressWarnings

Boolean

Defined in suppressWarnings:58

Do we suppress 'flash asset collision' warnings?