API Reference

Class List

pc.I18n

Extends: pc.EventHandler

Handles localization. Responsible for loading localization assets and returning translations for a certain key. Can also handle plural forms. To override its default behaviour define a different implementation for pc.I18n#getText and pc.I18n#getPluralText.

Summary

Properties

assetsAn array of asset ids or assets that contain localization data in the expected format.
localeThe current locale for example "en-US".

Methods

addDataAdds localization data.
destroyFrees up memory.
findAvailableLocaleReturns the first available locale based on the desired locale specified.
getPluralTextReturns the pluralized translation for the specified key, number n and locale.
getTextReturns the translation for the specified key and locale.
removeDataRemoves localization data.

Inherited

Methods

fireFire an event, all additional arguments are passed on to the event listener
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.

Details

Constructor

I18n(app)

Parameters

apppc.ApplicationThe application.

Properties

Number[], pc.Asset[]assets

An array of asset ids or assets that contain localization data in the expected format. I18n will automatically load translations from these assets as the assets are loaded and it will also automatically unload translations if the assets get removed or unloaded at runtime.

Stringlocale

The current locale for example "en-US". Changing the locale will raise an event which will cause localized Text Elements to change language to the new locale.

Methods

addData(data)

Adds localization data. If the locale and key for a translation already exists it will be overwritten.

this.app.i18n.addData({
  header: {
     version: 1
  },
  data: [{
     info: {
         locale: 'en-US'
     },
     messages: {
         "key": "translation",
          // The number of plural forms depends on the locale. See the manual for more information.
         "plural_key": ["one item", "more than one items"]
     }
  }, {
     info: {
         locale: 'fr-FR'
     },
     messages: {
        // ...
     }
  }]
});

Parameters

dataObjectThe localization data. See example for the expected format of the data.

destroy()

Frees up memory.

findAvailableLocale(desiredLocale, availableLocales)

Returns the first available locale based on the desired locale specified. First tries to find the desired locale and then tries to find an alternative locale based on the language.

Parameters

desiredLocaleStringThe desired locale e.g. en-US.
availableLocalesObjectA dictionary where each key is an available locale.

Returns

String The locale found or if no locale is available returns the default en-US locale.

getPluralText(key, n, [locale])

Returns the pluralized translation for the specified key, number n and locale. If the locale is not specified it will use the current locale.

// manually replace {number} in the resulting translation with our number
var localized = this.app.i18n.getPluralText('{number} apples', number).replace("{number}", number);

Parameters

keyStringThe localization key
nNumberThe number used to determine which plural form to use. E.g. for the phrase "5 Apples" n equals 5.
localeStringThe desired locale.

Returns

String The translated text. If no translations are found at all for the locale then it will return the en-US translation. If no translation exists for that key then it will return the localization key.

getText(key, [locale])

Returns the translation for the specified key and locale. If the locale is not specified it will use the current locale.

var localized = this.app.i18n.getText('localization-key');
var localizedFrench = this.app.i18n.getText('localization-key', 'fr-FR');

Parameters

keyStringThe localization key
localeStringThe desired locale.

Returns

String The translated text. If no translations are found at all for the locale then it will return the en-US translation. If no translation exists for that key then it will return the localization key.

removeData(data)

Removes localization data.

Parameters

dataObjectThe localization data. The data is expected to be in the same format as pc.I18n#addData.

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener

obj.fire('test', 'This is the message');

Parameters

nameObjectName of event to fire
arg1*First argument that is passed to the event handler
arg2*Second argument that is passed to the event handler
arg3*Third argument that is passed to the event handler
arg4*Fourth argument that is passed to the event handler
arg5*Fifth argument that is passed to the event handler
arg6*Sixth argument that is passed to the event handler
arg7*Seventh argument that is passed to the event handler
arg8*Eighth argument that is passed to the event handler

Returns

pc.EventHandler Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

nameStringThe name of the event to test

Returns

Boolean true if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope that was used as the this when the event is fired

Returns

pc.EventHandler Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.