@urso/core 0.4.3 → 0.4.8

package/package.json

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

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

@@ -5,9 +5,14 @@ class ModulesI18nController {
     /**
      * get text by localeId
      * @param {String} localeId 
+     * @param {Object} [localeVariables] - variables for locale string
      */
-    get(localeId) {
-        return this.#vocabulary && this.#vocabulary[localeId] || localeId;
+    get(localeId, localeVariables = {}) {
+        if (this.#vocabulary && this.#vocabulary[localeId]) {
+            return this._interpolate(this.#vocabulary[localeId], localeVariables);
+        }
+
+        return localeId;
     }
 
     /**
@@ -59,6 +64,12 @@ class ModulesI18nController {
         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

@@ -12,6 +12,8 @@ class ModulesObjectsModelsBitmapText extends Urso.Core.Modules.Objects.BaseModel
         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);
 
@@ -20,13 +22,13 @@ class ModulesObjectsModelsBitmapText extends Urso.Core.Modules.Objects.BaseModel
 
     _addBaseObject() {
         if (this.localeId)
-            this._originalModel.text = this.text = Urso.i18n.get(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.text = this._baseObject.text = Urso.i18n.get(this.localeId, this.localeVariables);
     }
 
     _subscribeOnce() {

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

@@ -12,6 +12,8 @@ class ModulesObjectsModelsText extends Urso.Core.Modules.Objects.BaseModel {
         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');
         this.fontSize = Urso.helper.recursiveGet('fontSize', params, false);
@@ -33,13 +35,13 @@ class ModulesObjectsModelsText extends Urso.Core.Modules.Objects.BaseModel {
 
     _addBaseObject() {
         if (this.localeId)
-            this._originalModel.text = this.text = Urso.i18n.get(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.text = this._baseObject.text = Urso.i18n.get(this.localeId, this.localeVariables);
     }
 
     _subscribeOnce() {

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

@@ -28,6 +28,8 @@ class ModulesObserverConfig {
             MODULES_SCENES_DISPLAY_START: 'modules.scenes.display.start',
             MODULES_SCENES_DISPLAY_FINISHED: 'modules.scenes.display.finished',
             MODULES_SCENES_MOUSE_NEW_POSITION: 'modules.scenes.mouse.newPosition',
+            MODULES_SCENES_PAUSE: 'modules.scenes.pause',
+            MODULES_SCENES_RESUME: 'modules.scenes.resume',
             MODULES_SCENES_UPDATE: 'modules.scenes.update',
             EXTRA_BROWSEREVENTS_WINDOW_PRE_RESIZE: 'extra.browserEvents.window.pre.resize',
             EXTRA_BROWSEREVENTS_WINDOW_RESIZE: 'extra.browserEvents.window.resize',

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,33 @@ class ModulesScenesService {
         this._pixiWrapper.init();
     }
 
+    /**
+     * pause scene
+     */
+    pause() {
+        this.getInstance('PixiWrapper').pause();
+        this.emit(Urso.events.MODULES_SCENES_PAUSE);
+    }
+
+    /**
+     * resume scene
+     */
+    resume() {
+        this.getInstance('PixiWrapper').resume();
+        this.emit(Urso.events.MODULES_SCENES_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 +55,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) {