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
Properties
Methods
emit
-
eventName
Emit an event to all registered event listeners.
Parameters:
-
eventNameStringThe name of the event.
Returns:
Indication if we've emitted an event.
listeners
-
eventName
Return a list of assigned event listeners.
Parameters:
-
eventNameStringThe events that should be listed.
Returns:
An array of listener functions
load
()
This will begin loading the JSON file
mixin
-
object
Mixes in the properties of the EventTarget prototype onto another object
Parameters:
-
objectObjectThe obj to mix into
off
-
eventName -
callback
Remove event listeners.
Parameters:
-
eventNameStringThe event we want to remove.
-
callbackFunctionThe listener that we need to find.
on
-
eventName -
callback
Register a new EventListener for the given event.
Parameters:
-
eventNameStringName of the event.
-
callbackFunctonfn Callback function.
once
-
eventName -
callback
Add an EventListener that's only called once.
Parameters:
-
eventNameStringName of the event.
-
callbackFunctionCallback function.
onLoaded
()
private
Invoke when all files are loaded (json and texture)
removeAllListeners
-
eventName
Remove all listeners or only the listeners for the specified event.
Parameters:
-
eventNameStringThe event you want to remove all listeners for.
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
url
String
The url of the atlas data