API Docs for: 2.2.1
Show:

SpriteSheetLoader Class

Uses
Defined in: pixi/loaders/SpriteSheetLoader.hx:9

The sprite sheet loader is used to load in JSON sprite sheet data To generate the data you can use http://www.codeandweb.com/texturepacker and publish in the 'JSON' format There is a free version so thats nice, although the paid version is great value for money. It is highly recommended to use Sprite sheets (also know as a 'texture atlas') as it means sprites can be batched and drawn together for highly increased rendering speed. Once the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId() This loader will load the image file that the Spritesheet points to as well as the data. When loaded this class will dispatch a 'loaded' event

Constructor

SpriteSheetLoader

(
  • url
  • [crossorigin]
)

Defined in pixi/loaders/SpriteSheetLoader.hx:9

Parameters:

  • url String

    The url of the sprite sheet JSON file

  • [crossorigin] Bool optional

    Whether requests should be treated as crossorigin

Methods

emit

(
  • eventName
  • data
)
Bool

Inherited from EventTarget: pixi/utils/EventTarget.hx:29

Emit an event to all registered event listeners.

Parameters:

  • eventName String

    The name of the event.

  • data Dynamic

Returns:

Bool:

Indication if we've emitted an event.

listeners

(
  • eventName
)
Array

Inherited from EventTarget: pixi/utils/EventTarget.hx:20

Return a list of assigned event listeners.

Parameters:

  • eventName String

    The events that should be listed.

Returns:

Array:

An array of listener functions

load

()

Defined in pixi/loaders/SpriteSheetLoader.hx:72

Loads the SpriteSheet JSON data

off

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:61

Remove event listeners.

Parameters:

  • eventName String

    The event we want to remove.

  • callback Function

    The listener that we need to find.

on

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:41

Register a new EventListener for the given event.

Parameters:

  • eventName String

    Name of the event.

  • callback Functon

    Callback function.

once

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:52

Add an EventListener that's only called once.

Parameters:

  • eventName String

    Name of the event.

  • callback Function

    Callback function.

removeAllListeners

(
  • eventName
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:72

Remove all listeners or only the listeners for the specified event.

Parameters:

  • eventName String

    The event you want to remove all listeners for.

Properties

baseUrl

String

Defined in pixi/loaders/SpriteSheetLoader.hx:42

[read-only] The base url of the bitmap font data

crossorigin

Boolean

Defined in pixi/loaders/SpriteSheetLoader.hx:34

Whether the requests should be treated as cross origin

frames

Object

Defined in pixi/loaders/SpriteSheetLoader.hx:59

The frames of the sprite sheet

texture

Texture

Defined in pixi/loaders/SpriteSheetLoader.hx:51

The texture being loaded

url

String

Defined in pixi/loaders/SpriteSheetLoader.hx:26

The url of the atlas data