SpriteSheetLoader Class
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
Parameters:
-
urlStringThe url of the sprite sheet JSON file
-
crossoriginBooleanWhether requests should be treated as crossorigin
Item Index
Methods
addEventListener
-
type -
listener
Adds a listener for a specific event
Parameters:
-
typeStringA string representing the event type to listen for.
-
listenerFunctionThe callback function that will be fired when the event occurs
dispatchEvent
-
event
Fires the event, ie pretends that the event has happened
Parameters:
-
eventEventthe event object
load
()
This will begin loading the JSON file
onLoaded
()
private
Invoke when all files are loaded (json and texture)
removeAllEventListeners
-
type
Removes all the listeners that were active for the specified event type
Parameters:
-
typeStringA string representing the event type which will have all its listeners removed
removeEventListener
-
type -
listener
Removes the specified listener that was assigned to the specified event type
Parameters:
-
typeStringA string representing the event type which will have its listener removed
-
listenerFunctionThe callback function that was be fired when the event occured
Properties
baseUrl
String
[read-only] The base url of the bitmap font data
crossorigin
Boolean
Whether the requests should be treated as cross origin
frames
Object
The frames of the sprite sheet
listeners
Object
Holds all the listeners
url
String
The url of the bitmap font data