@urso/core 0.4.2 → 0.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@urso/core",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "HTML5 game engine",
   "main": "build/js/index.js",
   "author": "Megbrimef",

package/src/js/app.js

@@ -44,6 +44,7 @@ class App {
 
         //Modules
         Urso.assets = Urso.getInstance('Modules.Assets.Controller');
+        Urso.i18n = Urso.getInstance('Modules.I18n.Controller');
         Urso.transport = Urso.getInstance('Modules.Transport.Controller');
         Urso.logic = Urso.getInstance('Modules.Logic.Controller');
         Urso.objects = Urso.getInstance('Modules.Objects.Controller');

package/src/js/modules/_info.js

@@ -1,5 +1,6 @@
 Urso.Core.Modules = {};
 require('./assets/_info.js');
+require('./i18n/_info.js');
 require('./instances/_info.js');
 require('./logic/_info.js');
 require('./objects/_info.js');

package/src/js/modules/assets/service.js

@@ -38,7 +38,7 @@ class ModulesAssetsService {
         Urso.scenes.loadUpdate(Math.floor(param.progress));
     }
 
-    loadGroup(group, callback) {
+    loadGroup(group, callback = () => { }) {
         if (!this.assets[group])
             return Urso.logger.error('ModulesAssetsService group error, no assets:' + group + ' Check ModulesAssetsConfig please');
 

package/src/js/modules/i18n/_info.js

@@ -0,0 +1,4 @@
+Urso.Core.Modules.I18n = {
+    Config: require('./config.js'),
+    Controller: require('./controller.js')
+};

package/src/js/modules/i18n/config.js

@@ -0,0 +1,17 @@
+class ModulesI18nConfig {
+    constructor() {
+        this.singleton = true;
+
+        /**
+         * example of locales. Set please your keys and paths
+         */
+        this.locales = {
+            'de': 'i18n/de.json',
+            'en': 'i18n/en.json',
+            'ru': 'i18n/ru.json'
+        }
+    }
+};
+
+module.exports = ModulesI18nConfig;
+

package/src/js/modules/i18n/controller.js

@@ -0,0 +1,64 @@
+class ModulesI18nController {
+
+    #vocabulary = null;
+
+    /**
+     * get text by localeId
+     * @param {String} localeId 
+     */
+    get(localeId) {
+        return this.#vocabulary && this.#vocabulary[localeId] || localeId;
+    }
+
+    /**
+     * set alredy loaded as asset locale
+     * @param {String} localeKey - loaded json asset key with locale
+     */
+    setLocale(localeKey) {
+        const jsonResource = Urso.cache.getJson(localeKey);
+
+        if (!jsonResource)
+            return Urso.logger.error('ModulesI18nController setLocale error, no loaded json:' + localeKey + '. Check assets please');
+
+        this.#vocabulary = jsonResource.data;
+        this.emit(Urso.events.MODULES_I18N_NEW_LOCALE_WAS_SET, localeKey);
+    }
+
+    /**
+     * load json with locale, store as asset witn localeKey as key and set locale
+     * @param {String} localeKey 
+     * @param {String} [pathToLocaleJson] if this param will not used - we will check localeKey in config
+     */
+    loadAndSetLocale(localeKey, pathToLocaleJson) {
+        //check if localeKey was alredy loaded
+        const jsonResource = Urso.cache.getJson(localeKey);
+
+        if (jsonResource) {
+            this.setLocale(localeKey);
+        }
+
+        //load locale by path
+        if (pathToLocaleJson) {
+            this._loadLocaleByPath(localeKey, pathToLocaleJson);
+        } else { //we will check localeKey in config
+            this._loadLocaleByConfig(localeKey);
+        }
+    }
+
+    _loadLocaleByConfig(localeKey) {
+        const locales = this.getInstance('Config').locales;
+        const pathToLocaleJson = locales[localeKey];
+
+        if (!pathToLocaleJson)
+            return Urso.logger.error('ModulesI18nController _loadLocaleByConfig error, no locale data in config:' + localeKey + '. Check ModulesI18nConfig please');
+
+        this._loadLocaleByPath(localeKey, pathToLocaleJson);
+    }
+
+    _loadLocaleByPath(localeKey, pathToLocaleJson) {
+        const localeAsset = { type: Urso.types.assets.JSON, key: localeKey, path: pathToLocaleJson };
+        Urso.assets.preload(localeAsset, () => this.setLocale(localeKey));
+    }
+}
+
+module.exports = ModulesI18nController;

package/src/js/modules/objects/models/bitmapText.js

@@ -10,6 +10,8 @@ class ModulesObjectsModelsBitmapText extends Urso.Core.Modules.Objects.BaseModel
         super.setupParams(params);
 
         this.text = Urso.helper.recursiveGet('text', params, false);
+        this.localeId = Urso.helper.recursiveGet('localeId', params, false); //you can use this instead text for localization
+
         this.fontName = Urso.helper.recursiveGet('fontName', params, false);
         this.fontSize = Urso.helper.recursiveGet('fontSize', params, false);
 
@@ -17,8 +19,20 @@ class ModulesObjectsModelsBitmapText extends Urso.Core.Modules.Objects.BaseModel
     }
 
     _addBaseObject() {
+        if (this.localeId)
+            this._originalModel.text = this.text = Urso.i18n.get(this.localeId);
+
         this._baseObject = new PIXI.BitmapText(this.text, { fontName: this.fontName, fontSize: this.fontSize });
     };
+
+    _newLocaleHandler() {
+        this.text = this._baseObject.text = Urso.i18n.get(this.localeId);
+    }
+
+    _subscribeOnce() {
+        if (this.localeId)
+            this.addListener(Urso.events.MODULES_I18N_NEW_LOCALE_WAS_SET, this._newLocaleHandler.bind(this));
+    }
 }
 
 module.exports = ModulesObjectsModelsBitmapText;

package/src/js/modules/objects/models/text.js

@@ -10,6 +10,7 @@ class ModulesObjectsModelsText extends Urso.Core.Modules.Objects.BaseModel {
         super.setupParams(params);
 
         this.text = Urso.helper.recursiveGet('text', params, false);
+        this.localeId = Urso.helper.recursiveGet('localeId', params, false); //you can use this instead text for localization
 
         this.lineHeight = Urso.helper.recursiveGet('lineHeight', params, 0);
         this.fontFamily = Urso.helper.recursiveGet('fontFamily', params, 'Arial');
@@ -31,8 +32,20 @@ class ModulesObjectsModelsText extends Urso.Core.Modules.Objects.BaseModel {
     }
 
     _addBaseObject() {
+        if (this.localeId)
+            this._originalModel.text = this.text = Urso.i18n.get(this.localeId);
+
         this._baseObject = new PIXI.Text(this.text);
     };
+
+    _newLocaleHandler() {
+        this.text = this._baseObject.text = Urso.i18n.get(this.localeId);
+    }
+
+    _subscribeOnce() {
+        if (this.localeId)
+            this.addListener(Urso.events.MODULES_I18N_NEW_LOCALE_WAS_SET, this._newLocaleHandler.bind(this));
+    }
 }
 
 module.exports = ModulesObjectsModelsText;

package/src/js/modules/observer/events.js

@@ -6,6 +6,7 @@ class ModulesObserverConfig {
             MODULES_ASSETS_GROUP_LOADED: 'modules.assets.group.loaded',
             MODULES_ASSETS_LOAD_PROGRESS: 'modules.assets.load.progress',
             MODULES_ASSETS_LAZYLOAD_FINISHED: 'modules.assets.lazyLoad.finished',
+            MODULES_I18N_NEW_LOCALE_WAS_SET: 'modules.i18n.new.locale.was.set',
             MODULES_INSTANCES_MODES_CHANGED: 'modules.instances.modes.changed',
             MODULES_OBJECTS_BUTTON_PRESS: 'modules.objects.button.press',
             MODULES_OBJECTS_HIT_AREA_PRESS: 'modules.objects.hitArea.press',