API Docs for: 2.0.0
Show:

SpineLoader Class

Uses
Defined in: src/pixi/loaders/SpineLoader.js:10
Module: PIXI

The Spine loader is used to load in JSON spine data To generate the data you need to use http://esotericsoftware.com/ and export in the "JSON" format Due to a clash of names You will need to change the extension of the spine file from .json to .anim for it to load See example 12 (http://www.goodboydigital.com/pixijs/examples/12/) to see a working example and check out the source You will need to generate a sprite sheet to accompany the spine data When loaded this class will dispatch a "loaded" event

Constructor

SpineLoader

(
  • url
  • crossorigin
)

Defined in src/pixi/loaders/SpineLoader.js:10

Parameters:

  • url String

    The url of the JSON file

  • crossorigin Boolean

    Whether requests should be treated as crossorigin

Methods

emit

(
  • eventName
)
Boolean

Inherited from EventTarget: src/pixi/utils/EventTarget.js:54

Emit an event to all registered event listeners.

Parameters:

  • eventName String

    The name of the event.

Returns:

Boolean:

Indication if we've emitted an event.

listeners

(
  • eventName
)
Array

Inherited from EventTarget: src/pixi/utils/EventTarget.js:41

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 src/pixi/loaders/SpineLoader.js:56

Loads the JSON data

mixin

(
  • object
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:34

Mixes in the properties of the EventTarget prototype onto another object

Parameters:

  • object Object

    The obj to mix into

off

(
  • eventName
  • callback
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:143

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: src/pixi/utils/EventTarget.js:107

Register a new EventListener for the given event.

Parameters:

  • eventName String

    Name of the event.

  • callback Functon

    fn Callback function.

once

(
  • eventName
  • callback
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:124

Add an EventListener that's only called once.

Parameters:

  • eventName String

    Name of the event.

  • callback Function

    Callback function.

onLoaded

() private

Defined in src/pixi/loaders/SpineLoader.js:72

Invoked when JSON file is loaded.

removeAllListeners

(
  • eventName
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:173

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

Parameters:

  • eventName String

    The event you want to remove all listeners for.

Properties

crossorigin

Boolean

Defined in src/pixi/loaders/SpineLoader.js:34

Whether the requests should be treated as cross origin

loaded

Boolean

Defined in src/pixi/loaders/SpineLoader.js:42

[read-only] Whether the data has loaded yet

url

String

Defined in src/pixi/loaders/SpineLoader.js:26

The url of the bitmap font data