API Docs for: 2.2.1
Show:

AssetLoader Class

Uses
Defined in: pixi/loaders/AssetLoader.hx:8

A Class that loads a bunch of images / sprite sheet / bitmap font files. Once the assets have been loaded they are added to the PIXI Texture cache and can be accessed easily through PIXI.Texture.fromImage() and PIXI.Sprite.fromImage() When all items have been loaded this class will dispatch a 'onLoaded' event As each individual item is loaded this class will dispatch a 'onProgress' event

Constructor

AssetLoader

(
  • assetURLs
  • [crossorigin]
)

Defined in pixi/loaders/AssetLoader.hx:8

Parameters:

  • assetURLs Array

    an array of image/sprite sheet urls that you would like loaded supported. Supported image formats include 'jpeg', 'jpg', 'png', 'gif'. Supported sprite sheet data formats only include 'JSON' at this time. Supported bitmap font data formats include 'xml' and 'fnt'.

  • [crossorigin] Bool optional

    Whether requests should be treated as crossorigin

Methods

_getDataType

(
  • str
)

Defined in pixi/loaders/AssetLoader.hx:76

Given a filename, returns its extension.

Parameters:

  • str String

    the name of the asset

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/AssetLoader.hx:69

Starts loading the assets sequentially

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

assetURLs

Array

Defined in pixi/loaders/AssetLoader.hx:26

The array of asset URLs that are going to be loaded

crossorigin

Boolean

Defined in pixi/loaders/AssetLoader.hx:40

Whether the requests should be treated as cross origin

loadCount

Int

Defined in pixi/loaders/AssetLoader.hx:34

loadersByType

Dynamic

Defined in pixi/loaders/AssetLoader.hx:48

Maps file extension to loader types

onComplete

Function

Defined in pixi/loaders/AssetLoader.hx:62

Fired when all the assets are loaded

onProgress

Function

Defined in pixi/loaders/AssetLoader.hx:55

Fired when an item finishes loading