API Docs for: 2.0.0
Show:

BitmapFontLoader Class

Uses
Defined in: src/pixi/loaders/BitmapFontLoader.js:5
Module: PIXI

The xml loader is used to load in XML bitmap font data ('xml' or 'fnt') To generate the data you can use http://www.angelcode.com/products/bmfont/ This loader will also load the image file as the data. When loaded this class will dispatch a 'loaded' event

Constructor

BitmapFontLoader

(
  • url
  • crossorigin
)

Defined in src/pixi/loaders/BitmapFontLoader.js:5

Parameters:

  • url String

    The url of the sprite sheet 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/BitmapFontLoader.js:63

Loads the XML font 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/BitmapFontLoader.js:158

Invoked when all files are loaded (xml/fnt and texture)

onXMLLoaded

() private

Defined in src/pixi/loaders/BitmapFontLoader.js:78

Invoked when the XML file is loaded, parses the data

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

baseUrl

String

Defined in src/pixi/loaders/BitmapFontLoader.js:41

[read-only] The base url of the bitmap font data

baseUrl

String

Defined in src/pixi/loaders/BitmapFontLoader.js:50

[read-only] The texture of the bitmap font

crossorigin

Boolean

Defined in src/pixi/loaders/BitmapFontLoader.js:33

Whether the requests should be treated as cross origin

url

String

Defined in src/pixi/loaders/BitmapFontLoader.js:25

The url of the bitmap font data