@urso/core 0.4.2 → 0.4.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@urso/core",
-  "version": "0.4.2",
+  "version": "0.4.7",
   "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,75 @@
+class ModulesI18nController {
+
+    #vocabulary = null;
+
+    /**
+     * get text by localeId
+     * @param {String} localeId 
+     * @param {Object} [localeVariables] - variables for locale string
+     */
+    get(localeId, localeVariables = {}) {
+        if (this.#vocabulary && this.#vocabulary[localeId]) {
+            return this._interpolate(this.#vocabulary[localeId], localeVariables);
+        }
+
+        return 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));
+    }
+
+    _interpolate(string, params) {
+        const names = Object.keys(params);
+        const vals = Object.values(params);
+        return new Function(...names, `return \`${string}\`;`)(...vals);
+    }
+}
+
+module.exports = ModulesI18nController;

package/src/js/modules/objects/controller.js

@@ -30,7 +30,7 @@ class ModulesObjectsController {
     }
 
     _createSingleObject(object, parent, doNotRefreshStylesFlag) {
-        //parse template for assets and objects (groups, components)
+        //parse template for assets and objects (groups, components)  Urso.types.objects.COMPONENT  Urso.types.objects.GROUP
         if (!object._parsed) { //todo only for objects, contains components && groups in future
             return Urso.scenes.addObject(object, parent, doNotRefreshStylesFlag);
         }

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

@@ -10,6 +10,10 @@ 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.localeVariables = Urso.helper.recursiveGet('localeVariables', params, {}); //optional variables for localization by localeId
+
         this.fontName = Urso.helper.recursiveGet('fontName', params, false);
         this.fontSize = Urso.helper.recursiveGet('fontSize', params, false);
 
@@ -17,8 +21,20 @@ class ModulesObjectsModelsBitmapText extends Urso.Core.Modules.Objects.BaseModel
     }
 
     _addBaseObject() {
+        if (this.localeId)
+            this._originalModel.text = this.text = Urso.i18n.get(this.localeId, this.localeVariables);
+
         this._baseObject = new PIXI.BitmapText(this.text, { fontName: this.fontName, fontSize: this.fontSize });
     };
+
+    _newLocaleHandler() {
+        this.text = this._baseObject.text = Urso.i18n.get(this.localeId, this.localeVariables);
+    }
+
+    _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,9 @@ 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.localeVariables = Urso.helper.recursiveGet('localeVariables', params, {}); //optional variables for localization by localeId
 
         this.lineHeight = Urso.helper.recursiveGet('lineHeight', params, 0);
         this.fontFamily = Urso.helper.recursiveGet('fontFamily', params, 'Arial');
@@ -31,8 +34,20 @@ class ModulesObjectsModelsText extends Urso.Core.Modules.Objects.BaseModel {
     }
 
     _addBaseObject() {
+        if (this.localeId)
+            this._originalModel.text = this.text = Urso.i18n.get(this.localeId, this.localeVariables);
+
         this._baseObject = new PIXI.Text(this.text);
     };
+
+    _newLocaleHandler() {
+        this.text = this._baseObject.text = Urso.i18n.get(this.localeId, this.localeVariables);
+    }
+
+    _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',

package/src/js/modules/scenes/controller.js

@@ -6,38 +6,86 @@ class ModulesScenesController {
         this.init();
     }
 
+    /**
+     * init scenes mahager
+     */
     init() {
         this._service = this.getInstance('Service');
     }
 
+    /**
+     * display scene with name
+     * @param {String} name 
+     */
     display(name) {
         this._service.display(name);
     }
 
+    /**
+     * pause scene
+     */
+    pause() {
+        this._service.pause();
+    }
+
+    /**
+     * resume scene
+     */
+    resume() {
+        this._service.resume();
+    }
+
+    /**
+     * system function for transfer loadUpdate progress to components
+     * @param {Number} loadProgress 
+     */
     loadUpdate(loadProgress) {
         this._service.loadUpdate(loadProgress);
     }
 
+    /**
+     * system function, returns pixi world container
+     */
     getPixiWorld() {
         return this.getInstance('PixiWrapper').getPixiWorld();
     }
 
+    /**
+     * get template size
+     * @returns {Object}
+     */
     getTemplateSize() {
         return this.getInstance('Resolutions').getTemplateSize();
     }
 
+    /**
+     * return mouse coords related to scene
+     * @returns {Object}
+     */
     getMouseCoords() {
         return this.getInstance('PixiWrapper').getCachedMouseCoords();
     }
 
+    /**
+     * system function to add custom objects to scene like groups or components
+     * @param {Object|Array} objects 
+     * @param {Object} parent 
+     * @param {Boolean} doNotRefreshStylesFlag 
+     */
     addObject(objects, parent, doNotRefreshStylesFlag) {
-        this._service.addObject(objects, parent, doNotRefreshStylesFlag);
+        return this._service.addObject(objects, parent, doNotRefreshStylesFlag);
     }
 
+    /**
+     * global timeScale getter
+     */
     get timeScale() {
-        return this._service.timeScale;
+        return this._service.getTimeScale();
     }
 
+    /**
+     * global timeScale setter
+     */
     set timeScale(value) {
         return this._service.setTimeScale(value);
     }

package/src/js/modules/scenes/model.js

@@ -1,7 +1,4 @@
 class ModulesScenesModel {
-    constructor() {
-        this._isPaused = false;
-    }
 
     loadUpdate() {
         //just blank
@@ -23,10 +20,6 @@ class ModulesScenesModel {
         //just blank
     }
 
-    isPaused() {
-        return this._isPaused;
-    }
-
     destroy() {
         //just blank
     }

package/src/js/modules/scenes/pixiWrapper.js

@@ -40,6 +40,32 @@ class ModulesScenesPixiWrapper {
         this.getInstance('Resolutions');
     }
 
+    /**
+     * returns is scene paused
+     * @returns {Boolean}
+     */
+    isPaused() {
+        return this._loopPaused;
+    }
+
+    /**
+     * pause scene
+     */
+    pause() {
+        this._loopPaused = true;
+        PIXI.spine.settings.GLOBAL_AUTO_UPDATE = false;
+    }
+
+    /**
+     * resume scene
+     */
+    resume() {
+        this._loopLastCall = Date.now();
+        this._loopPaused = false;
+        this.update();
+        PIXI.spine.settings.GLOBAL_AUTO_UPDATE = true;
+    }
+
     _setPixiSettings() {
         PIXI.settings.SCALE_MODE = PIXI.SCALE_MODES.LINEAR;
         PIXI.settings.TEXT_RESOLUTION = 1;
@@ -94,7 +120,7 @@ class ModulesScenesPixiWrapper {
     };
 
     update() {
-        if (!this.currentScene || this.currentScene.isPaused())
+        if (!this.currentScene)
             return;
 
         let deltaTime = this._getDeltaTime();

package/src/js/modules/scenes/service.js

@@ -21,6 +21,31 @@ class ModulesScenesService {
         this._pixiWrapper.init();
     }
 
+    /**
+     * pause scene
+     */
+    pause() {
+        this.getInstance('PixiWrapper').pause();
+    }
+
+    /**
+     * resume scene
+     */
+    resume() {
+        this.getInstance('PixiWrapper').resume();
+    }
+
+    /**
+     * global timeScale getter
+     */
+    getTimeScale() {
+        const loopPaused = this.getInstance('PixiWrapper').isPaused();
+        return loopPaused ? 0 : this.timeScale;
+    }
+
+    /**
+     * global timeScale setter
+     */
     setTimeScale(value) {
         this.timeScale = value;
         gsap.globalTimeline.timeScale(this.timeScale);
@@ -28,15 +53,22 @@ class ModulesScenesService {
 
     addObject(objects, parent, doNotRefreshStylesFlag) {
         const newTemplatePart = Urso.template.parse({ objects: [objects] }, true);
-        Urso.assets.preload(newTemplatePart.assets, () => this._newTemplateAssetsLoadedHandler(newTemplatePart, parent, doNotRefreshStylesFlag));
+
+        if (newTemplatePart.assets.length) {
+            Urso.assets.preload(newTemplatePart.assets, () => this._newTemplateAssetsLoadedHandler(newTemplatePart, parent, doNotRefreshStylesFlag));
+            return null; //objects will be created soon. Maybe we can return a promice
+        } else
+            return this._newTemplateAssetsLoadedHandler(newTemplatePart, parent, doNotRefreshStylesFlag);
     }
 
     _newTemplateAssetsLoadedHandler(newTemplatePart, parent, doNotRefreshStylesFlag) {
-        Urso.objects.create(newTemplatePart.objects, parent, doNotRefreshStylesFlag);
+        const objectToCreate = newTemplatePart.objects[0];
+        const result = Urso.objects.create(objectToCreate, parent, doNotRefreshStylesFlag);
 
         //components create
         newTemplatePart.components.forEach(component => component.create());
         this._currentSceneTemplate.components = Urso.helper.mergeArrays(this._currentSceneTemplate.components, newTemplatePart.components);
+        return result;
     }
 
     display(name) {