API Documentation for: 0.2.8
Show:

pixiflash.SpriteSheet Class

Defined in: pixiflash.SpriteSheet:12
Module: Pixi Flash

SpriteSheet for export from flash

Constructor

pixiflash.SpriteSheet

(
  • data
)

Defined in pixiflash.SpriteSheet:12

Parameters:

  • data Object

    The spritesheet to load

    • images Array

      The collection of BaseTextures

    • frames Array

      The collection of frames

Item Index

Methods

Properties

Methods

_addFrames

(
  • data
)
private

Defined in _addFrames:45

Add the frames data

Parameters:

  • data Object

    The spritesheet to load

    • images Array

      The collection of BaseTextures

    • frames Array

      The collection of frames

addToGlobal

(
  • id
)

Defined in addToGlobal:102

Get a frame of the spritesheet

Parameters:

  • id String

    The id of the spritesheet

destroy

()

Defined in destroy:81

Destroy the spritesheet

fromData

(
  • input
  • Callback
)
static

Defined in fromData:116

Create a spritesheet

Parameters:

  • input Object

    The flash spritesheet data

  • Callback Function

    when complete

getFrame

(
  • index
)

Defined in getFrame:71

Get a frame of the spritesheet

Parameters:

  • index Int

    The index or frame to get

Properties

_id

String private

Defined in _id:29

The global id of the spriteshet

frames

Array private

Defined in frames:22

The collection of frames