bard-legends-framework 0.9.6 → 0.10.0

package/dist/game-entities/controller/controller.spec.js

@@ -1,128 +1,131 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+var __decorate =
+  (this && this.__decorate) ||
+  ((decorators, target, key, desc) => {
+    var c = arguments.length,
+      r = c < 3 ? target : desc === null ? (desc = Object.getOwnPropertyDescriptor(target, key)) : desc,
+      d;
+    if (typeof Reflect === 'object' && typeof Reflect.decorate === 'function')
+      r = Reflect.decorate(decorators, target, key, desc);
+    else
+      for (var i = decorators.length - 1; i >= 0; i--)
+        if ((d = decorators[i])) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const update_loop_1 = require("../update-loop");
-const controller_1 = require("./controller");
-const service_1 = require("../service/service");
+  });
+Object.defineProperty(exports, '__esModule', { value: true });
+const vitest_1 = require('vitest');
+const update_loop_1 = require('../update-loop');
+const controller_1 = require('./controller');
+const service_1 = require('../service/service');
 (0, vitest_1.describe)('CONTROLLER', () => {
-    (0, vitest_1.beforeEach)(() => {
-        update_loop_1.UpdateCycle.hardResetAction.trigger();
-    });
-    (0, vitest_1.test)('when gateway triggers service link, it should trigger the controller function', () => {
-        let SampleLink = new controller_1.ControllerLink();
-        let Gateway = class Gateway {
-            test(data) {
-                SampleLink.trigger('testFunction', data);
-            }
-        };
-        Gateway = __decorate([
-            (0, service_1.ServiceDecorator)()
-        ], Gateway);
-        let triggeredData;
-        let Controller = class Controller {
-            testFunction(data) {
-                triggeredData = data;
-            }
-        };
-        Controller = __decorate([
-            (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-        ], Controller);
-        let gateway = new Gateway();
-        let sampleData = 'sampleData';
-        gateway.test(sampleData);
-        (0, vitest_1.expect)(triggeredData).toEqual(sampleData);
-    });
-    (0, vitest_1.test)('there can be multiple controllers linked to one gateway', () => {
-        var Controller1_1, Controller2_1;
-        let SampleLink = new controller_1.ControllerLink();
-        let Gateway = class Gateway {
-            test1(data) {
-                SampleLink.trigger('testFunction1', data);
-            }
-            test2(data) {
-                SampleLink.trigger('testFunction2', data);
-            }
-        };
-        Gateway = __decorate([
-            (0, service_1.ServiceDecorator)()
-        ], Gateway);
-        let Controller1 = class Controller1 {
-            static { Controller1_1 = this; }
-            testFunction1(data) {
-                Controller1_1.data = data;
-            }
-        };
-        Controller1 = Controller1_1 = __decorate([
-            (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-        ], Controller1);
-        let Controller2 = class Controller2 {
-            static { Controller2_1 = this; }
-            testFunction2(data) {
-                Controller2_1.data = data;
-            }
-        };
-        Controller2 = Controller2_1 = __decorate([
-            (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-        ], Controller2);
-        let gateway = new Gateway();
-        let sampleData1 = 'sampleData1';
-        let sampleData2 = 'sampleData2';
-        gateway.test1(sampleData1);
-        gateway.test2(sampleData2);
-        (0, vitest_1.expect)(Controller1.data).toEqual(sampleData1);
-        (0, vitest_1.expect)(Controller2.data).toEqual(sampleData2);
-    });
-    (0, vitest_1.test)('it should complain when there are two functions with the same name', () => {
-        let SampleLink = new controller_1.ControllerLink();
-        let Gateway = class Gateway {
-            test() {
-                SampleLink.trigger('testFunction');
-            }
-        };
-        Gateway = __decorate([
-            (0, service_1.ServiceDecorator)()
-        ], Gateway);
-        let Controller1 = class Controller1 {
-            testFunction() { }
-        };
-        Controller1 = __decorate([
-            (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-        ], Controller1);
-        (0, vitest_1.expect)(() => {
-            let Controller2 = class Controller2 {
-                testFunction() { }
-            };
-            Controller2 = __decorate([
-                (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-            ], Controller2);
-        }).toThrow();
-    });
-    (0, vitest_1.test)('it should complain when there is no corresponding function', () => {
-        let SampleLink = new controller_1.ControllerLink();
-        let Gateway = class Gateway {
-            test() {
-                SampleLink.trigger('falseFunction');
-            }
-        };
-        Gateway = __decorate([
-            (0, service_1.ServiceDecorator)()
-        ], Gateway);
-        let Controller = class Controller {
-            testFunction() { }
-        };
-        Controller = __decorate([
-            (0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })
-        ], Controller);
-        let gateway = new Gateway();
-        (0, vitest_1.expect)(() => {
-            gateway.test();
-        }).toThrow('ServiceLink: no defined function with the name: "falseFunction", found in the linked controllers!');
-    });
+  (0, vitest_1.beforeEach)(() => {
+    update_loop_1.UpdateCycle.hardResetAction.trigger();
+  });
+  (0, vitest_1.test)('when gateway triggers service link, it should trigger the controller function', () => {
+    const SampleLink = new controller_1.ControllerLink();
+    let Gateway = class Gateway {
+      test(data) {
+        SampleLink.trigger('testFunction', data);
+      }
+    };
+    Gateway = __decorate([(0, service_1.ServiceDecorator)()], Gateway);
+    let triggeredData;
+    let Controller = class Controller {
+      testFunction(data) {
+        triggeredData = data;
+      }
+    };
+    Controller = __decorate([(0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })], Controller);
+    const gateway = new Gateway();
+    const sampleData = 'sampleData';
+    gateway.test(sampleData);
+    (0, vitest_1.expect)(triggeredData).toEqual(sampleData);
+  });
+  (0, vitest_1.test)('there can be multiple controllers linked to one gateway', () => {
+    var Controller1_1, Controller2_1;
+    const SampleLink = new controller_1.ControllerLink();
+    let Gateway = class Gateway {
+      test1(data) {
+        SampleLink.trigger('testFunction1', data);
+      }
+      test2(data) {
+        SampleLink.trigger('testFunction2', data);
+      }
+    };
+    Gateway = __decorate([(0, service_1.ServiceDecorator)()], Gateway);
+    let Controller1 = class Controller1 {
+      static {
+        Controller1_1 = Controller1;
+      }
+      testFunction1(data) {
+        Controller1_1.data = data;
+      }
+    };
+    Controller1 = Controller1_1 = __decorate(
+      [(0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })],
+      Controller1
+    );
+    let Controller2 = class Controller2 {
+      static {
+        Controller2_1 = Controller2;
+      }
+      testFunction2(data) {
+        Controller2_1.data = data;
+      }
+    };
+    Controller2 = Controller2_1 = __decorate(
+      [(0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })],
+      Controller2
+    );
+    const gateway = new Gateway();
+    const sampleData1 = 'sampleData1';
+    const sampleData2 = 'sampleData2';
+    gateway.test1(sampleData1);
+    gateway.test2(sampleData2);
+    (0, vitest_1.expect)(Controller1.data).toEqual(sampleData1);
+    (0, vitest_1.expect)(Controller2.data).toEqual(sampleData2);
+  });
+  (0, vitest_1.test)('it should complain when there are two functions with the same name', () => {
+    const SampleLink = new controller_1.ControllerLink();
+    let Gateway = class Gateway {
+      test() {
+        SampleLink.trigger('testFunction');
+      }
+    };
+    Gateway = __decorate([(0, service_1.ServiceDecorator)()], Gateway);
+    let Controller1 = class Controller1 {
+      testFunction() {}
+    };
+    Controller1 = __decorate([(0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })], Controller1);
+    (0, vitest_1.expect)(() => {
+      let Controller2 = class Controller2 {
+        testFunction() {}
+      };
+      Controller2 = __decorate(
+        [
+          (0, controller_1.ControllerDecorator)({
+            controllerLink: SampleLink
+          })
+        ],
+        Controller2
+      );
+    }).toThrow();
+  });
+  (0, vitest_1.test)('it should complain when there is no corresponding function', () => {
+    const SampleLink = new controller_1.ControllerLink();
+    let Gateway = class Gateway {
+      test() {
+        SampleLink.trigger('falseFunction');
+      }
+    };
+    Gateway = __decorate([(0, service_1.ServiceDecorator)()], Gateway);
+    let Controller = class Controller {
+      testFunction() {}
+    };
+    Controller = __decorate([(0, controller_1.ControllerDecorator)({ controllerLink: SampleLink })], Controller);
+    const gateway = new Gateway();
+    (0, vitest_1.expect)(() => {
+      gateway.test();
+    }).toThrow('ServiceLink: no defined function with the name: "falseFunction", found in the linked controllers!');
+  });
 });
-//# sourceMappingURL=controller.spec.js.map
+//# sourceMappingURL=controller.spec.js.map

package/dist/game-entities/entity/entity.d.ts

@@ -1,7 +1,10 @@
 import { Attachable } from '../base/attachable';
 export type EntityClassType = new (...args: any[]) => Entity;
+/**
+ * @param destroyOnSceneClose - Default: true. If true, the entity will be destroyed when the scene is closed.
+ */
 export interface EntityDecoratorMeta {
-    global: boolean;
+    destroyOnSceneClose: boolean;
 }
 export declare function EntityDecorator(meta?: EntityDecoratorMeta): (EntityClass: EntityClassType) => any;
 export declare abstract class Entity extends Attachable {

package/dist/game-entities/entity/entity.js

@@ -9,7 +9,7 @@ function EntityDecorator(meta) {
     return function (EntityClass) {
         EntityClass.$meta = {
             type: 'entity',
-            global: meta?.global ?? false
+            destroyOnSceneClose: meta?.destroyOnSceneClose ?? true
         };
         entity_store_helper_1.EntityStoreHelper.registerEntityClass(EntityClass);
     };
@@ -34,8 +34,8 @@ class Entity extends attachable_1.Attachable {
     constructor() {
         super();
         this.viewCreationHelper = new entity_views_helper_1.EntityViewsHelper(this);
-        let globalEntity = this.constructor.$meta.global;
-        if (!globalEntity) {
+        let destroyOnSceneClose = this.constructor.$meta.destroyOnSceneClose;
+        if (destroyOnSceneClose) {
             scene_1.Scene['registerEntity'](this);
         }
         entity_store_helper_1.EntityStoreHelper.registerEntity(this);
@@ -43,8 +43,8 @@ class Entity extends attachable_1.Attachable {
     destroySelf() {
         super.destroySelf();
         this.viewCreationHelper.destroyViews();
-        let globalEntity = this.constructor.$meta.global;
-        if (!globalEntity) {
+        let destroyOnSceneClose = this.constructor.$meta.destroyOnSceneClose;
+        if (destroyOnSceneClose) {
             scene_1.Scene['unregisterEntity'](this);
         }
         entity_store_helper_1.EntityStoreHelper.unregisterEntity(this.constructor.name, this.id);