API Docs for: 2.2.1
Show:

AtlasLoader Class

Extends EventTarget
Defined in: pixi/loaders/AtlasLoader.hx:8

The atlas file loader is used to load in Atlas data and parse it When loaded this class will dispatch a 'loaded' event If loading fails this class will dispatch an 'error' event

Constructor

AtlasLoader

(
  • url
  • [crossorigin]
)

Defined in pixi/loaders/AtlasLoader.hx:8

Parameters:

  • url String

    the url of the JSON file

  • [crossorigin] Bool optional

Methods

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/AtlasLoader.hx:59

Starts loading the JSON file

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

baseUrl

String

Defined in pixi/loaders/AtlasLoader.hx:36

[read-only] The base url of json file

crossorigin

Boolean

Defined in pixi/loaders/AtlasLoader.hx:28

Whether the requests should be treated as cross origin

loaded

Boolean

Defined in pixi/loaders/AtlasLoader.hx:45

[read-only] Whether the data has loaded yet

url

String

Defined in pixi/loaders/AtlasLoader.hx:20

The url of the json file