@urso/core 0.4.0 → 0.4.1

package/package.json

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

package/src/js/modules/objects/baseModel.js

@@ -15,6 +15,10 @@ class ModulesObjectsBaseModel {
         this._parsed = false;
     }
 
+    /**
+     * setup params to object model
+     * @param {Object} params
+     */
     setupParams(params) {
         this.type = Urso.helper.recursiveGet('type', params, null);
 

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

@@ -6,6 +6,10 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
         this._addBaseObject();
     }
 
+    /**
+     * setup params to object model
+     * @param {Object} params
+     */
     setupParams(params) {
         super.setupParams(params);
 
@@ -21,11 +25,34 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
         params.animation = this.animation; //we redefine original property here
     }
 
+    /**
+     * play spine animation
+     * @param {String} animationName
+     * @param {Boolean} [loopFlag]
+     * @param {Number} [track] - you can define track number for current animation
+     */
     play(animationName, loopFlag = false, track = 0) {
         this._baseObject.state.setAnimation(track, animationName, loopFlag);
     }
 
-    addToSlot(object, slotName) {
+    /**
+     * stop track animation or all animations
+     * @param {Number} [track] - you can define track number to stop
+     */
+    stop(track) {
+        if (typeof track !== 'undefined')
+            this._baseObject.state.clearTrack(track);
+        else
+            this._baseObject.state.clearTracks();
+    }
+
+    /**
+     * add object to spine slot
+     * @param {Object} object - created by engine object
+     * @param {String} slotName
+     * @param {Boolean} replaceSlotContent - will replace other slot content
+     */
+    addToSlot(object, slotName, replaceSlotContent) {
         const spine = this._baseObject;
         const slotIndex = spine.spineData.slots.findIndex(({ name }) => name === slotName);
         const currentSlot = spine.slotContainers[slotIndex];
@@ -33,7 +60,12 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
         if (currentSlot) {
             object._baseObject.scale.y = -1;
 
-            Urso.objects.removeChild(object.parent, object)
+            Urso.objects.removeChild(object.parent, object);
+
+            if (replaceSlotContent)
+                currentSlot.removeChildren(); //todo check if its proxy and reset parent
+
+            //object.parent = this; //todo && make removeChild
             currentSlot.addChild(object._baseObject);
         } else {
             Urso.logger.warn('ModulesObjectsModelsSpine addToSlot error: no spine slot ' + slotName);
@@ -41,7 +73,16 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
     }
 
     /**
-     *
+     * replace spine slot with new object
+     * @param {Object} object - created by engine object
+     * @param {String} slotName
+     */
+    replaceSlotWith(object, slotName) {
+        this.addToSlot(object, slotName, true);
+    }
+
+    /**
+     * set/update animation config
      * @param {*} config
      * @param {boolean} [noObjectCreate] dont use this flag out of core
      *
@@ -64,6 +105,10 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
         }
     }
 
+    /**
+     * system function
+     * add object to pixi tree
+     */
     _addBaseObject() {
         let spineAsset = Urso.cache.getSpine(this.assetKey);
 
@@ -81,6 +126,10 @@ class ModulesObjectsModelsSpine extends Urso.Core.Modules.Objects.BaseModel {
             this.play(this.animation.name, this.animation.loop);
     };
 
+    /**
+     * get animation timeScale
+     * @returns Number
+     */
     getTimeScale() {
         return Urso.scenes.timeScale * this.animation.timeScale;
     }