pixi.loaders.Loader

type

class

extends

metadata

:directlyUsed
:native: "PIXI.loaders.Loader"

Constructor

The new loader, extends Resource Loader by Chad Engler : https://github.com/englercj/resource-loader ```js var loader = new PIXI.loader(); loader.add('spineboy',"data/spineboy.json"); loader.once('complete',onAssetsLoaded); loader.load(); ```

Instance Variables hide inherited show inherited

The base url for all resources loaded by this loader.

Loading state of the loader, true if it is currently loading resources.

The progress percent of the loader going through the queue.

All the resources for this loader keyed by name.

Instance Methods hide inherited show inherited

parameters: [name] {string} The name of the resource to load, if not passed the url is used.; url {string} The url for this resource, relative to the baseUrl of this loader.; [options] {object} The options for the load.; [options.crossOrigin] {boolean} Is this request cross-origin? Default is to determine automatically.; [options.loadType=Resource.LOAD_TYPE.XHR] {Resource.XHR_LOAD_TYPE} How should this resource be loaded?; [options.xhrType=Resource.XHR_RESPONSE_TYPE.DEFAULT] {Resource.XHR_RESPONSE_TYPE} How should the data being loaded be interpreted when using XHR?; [callback] {function} function to call when this specific resource completes loading.
returns: {Loader}

Adds a resource (or multiple resources) to the loader queue. This function can take a wide variety of different parameters. The only thing that is always required the url to load. All the following will work: ```js loader // normal param syntax .add('key', 'http://...', function () {}) .add('http://...', function () {}) .add('http://...') // object syntax .add({ name: 'key2', url: 'http://...' }, function () {}) .add({ url: 'http://...' }, function () {}) .add({ name: 'key3', url: 'http://...' onComplete: function () {} }) .add({ url: 'https://...', onComplete: function () {}, crossOrigin: true }) // you can also pass an array of objects or urls or both .add(

              { name: 'key4', url: 'http://...', onComplete: function () {} },
              { url: 'http://...', onComplete: function () {} },
              'http://...'

); ```

parameters: {String} event Name of the event.; {function} fn Callback function.; {Mixed} context The context of the function.

parameters: middleware {function} The middleware function to register.
returns: {Loader}

Sets up a middleware function that will run *after* the resource is loaded.

parameters: middleware {function} The middleware function to register.
returns: {Loader}

Sets up a middleware function that will run *before* the resource is loaded.

parameters: eventName {String} The name of the event.
returns: {Bool} Indication if we've emitted an event.

Emit an event to all registered event listeners.

parameters: {String} eventName
returns: {Array}

Return a list of assigned event listeners.

parameters: [callback] {function} Optional callback that will be bound to the `complete` event.
returns: {Loader}

Starts loading the queued resources.

Loads a single resource.

parameters: {String} event The event we want to remove.; {function} fn The listener that we need to find.; {Bool} once Only remove once listeners.

Remove event listeners.

parameters: {String} event Name of the event.; {function} fn Callback function.; {Mixed} context The context of the function.

parameters: {String} event Name of the event.; {function} fn Callback function.; {Mixed} context The context of the function.

Add an EventListener that's only called once.

parameters: {function} function to call

Middleware function

parameters: {String} event The event want to remove all listeners for.

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

parameters: {String} event The event we want to remove.; {function} fn The listener that we need to find.; {Bool} once Only remove once listeners.

Remove event listeners.

Resets the queue of the loader to prepare for a new load.

parameters: {function} function to call

Middleware function to use

pixi.loaders.Loader

Constructor

Instance Variables hide inherited show inherited

baseUrl : String

loading : Bool

progress : Float

resources : Dynamic

Instance Methods hide inherited show inherited

add(name : String, url : String, ?options : LoaderOptions, ?callback : Resource -> Void) : ResourceLoader

addListener(event : String, fn : EventTarget -> Void, ?context : Dynamic) : Void

after(fn : Resource -> Dynamic -> Void) : ResourceLoader

before(fn : Resource -> Dynamic -> Void) : ResourceLoader

emit(event : String, ?a1 : Dynamic, ?a2 : Dynamic, ?a3 : Dynamic, ?a4 : Dynamic, ?a5 : Dynamic) : Bool

listeners(event : String) : Array<Dynamic>

load(?cb : Void -> Void) : ResourceLoader

loadResource(resource : String, ?cb : Void -> Void) : ResourceLoader

off(event : String, fn : EventTarget -> Void, ?once : Bool) : Void

on(event : String, fn : EventTarget -> Void, ?context : Dynamic) : Void

once(event : String, fn : EventTarget -> Void, ?context : Dynamic) : Void

pre(fn : Resource -> Dynamic -> Void) : ResourceLoader

removeAllListeners(?event : String) : Void

removeListener(event : String, fn : EventTarget -> Void, ?once : Bool) : Void

reset() : Void

use(fn : Resource -> Dynamic -> Void) : Void