AtlasLoader Class
The atlas file loader is used to load in Texture Atlas data and parse it. When loaded this class will dispatch a 'loaded' event. If loading fails this class will dispatch an 'error' event.
To generate the data you can use http://www.codeandweb.com/texturepacker and publish in the 'JSON' format.
It is highly recommended to use texture atlases (also know as 'sprite sheets') as it allowed sprites to 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()
Constructor
AtlasLoader
-
url -
crossorigin
Parameters:
-
urlStringThe url of the JSON file
-
crossoriginBooleanWhether requests should be treated as crossorigin
Item Index
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
()
Starts 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.
onAtlasLoaded
()
private
Invoked when the Atlas has fully loaded. Parses the JSON and builds the texture frames.
once
-
eventName -
callback
Add an EventListener that's only called once.
Parameters:
-
eventNameStringName of the event.
-
callbackFunctionCallback function.
onError
()
private
Invoked when an error occurs.
onLoaded
()
private
Invoked when json file has loaded.
removeAllListeners
-
eventName
Remove all listeners or only the listeners for the specified event.
Parameters:
-
eventNameStringThe event you want to remove all listeners for.