@awesome-ecs/abstract 0.5.2 → 0.5.5

package/dist/systems/systems-runtime.d.ts

@@ -1,21 +1,26 @@
-import { EntityTypeUid } from "../entities/entity";
-import { ISystemsModule } from "./systems-module";
-/**
- * The System Runtime allows running a loop of Ticks.
- *
- * Each RunTick can process one or more Entity Updates, from the EntityQueue.
- * We can have multiple implementations of a SystemRuntime, based on the use-case.
- * A different implementation can be chosen at runtime, based for example on performance.
- */
-export interface ISystemsRuntime {
-    /**
-     * Allows registering the SystemsModule that will be triggered for any EntityUpdate for the given EntityType.
-     * @param entityType The EntityType this module will be registered for.
-     * @param module The Module implementation that will be triggered when executing updates for the given EntityType.
-     */
-    registerModule(entityType: EntityTypeUid, module: ISystemsModule): void;
-    /**
-     * The method allows for an Unit of Work implementation, and returns the remaining quantity of items scheduled to be processed next.
-     */
-    runTick(): number;
-}
+import { EntityTypeUid } from "../entities/entity";
+import { PerformanceTimeEntry } from "../utils/performance-timer";
+import { ISystemsModule } from "./systems-module";
+export interface ISystemsRuntimeTickResult {
+    readonly remainingUpdatesCount: number;
+    readonly metrics?: PerformanceTimeEntry[];
+}
+/**
+ * The System Runtime allows running a loop of Ticks.
+ *
+ * Each RunTick can process one or more Entity Updates, from the EntityQueue.
+ * We can have multiple implementations of a SystemRuntime, based on the use-case.
+ * A different implementation can be chosen at runtime, based for example on performance.
+ */
+export interface ISystemsRuntime {
+    /**
+     * Allows registering the SystemsModule that will be triggered for any EntityUpdate for the given EntityType.
+     * @param entityType The EntityType this module will be registered for.
+     * @param module The Module implementation that will be triggered when executing updates for the given EntityType.
+     */
+    registerModule(entityType: EntityTypeUid, module: ISystemsModule): void;
+    /**
+     * The method allows for an Unit of Work implementation, and returns the remaining quantity of items scheduled to be processed next.
+     */
+    runTick(): ISystemsRuntimeTickResult;
+}

package/dist/systems/systems-runtime.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=systems-runtime.js.map

package/dist/utils/performance-timer.d.ts

@@ -1,10 +1,10 @@
-export declare type PerformanceTimerUid = number;
-export interface PerformanceTimeEntry {
-    startedAt: number;
-    endedAt?: number;
-    msPassed?: number;
-}
-export interface IPerformanceTimer {
-    startTimer(name: string): PerformanceTimerUid;
-    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
-}
+export declare type PerformanceTimerUid = number;
+export interface PerformanceTimeEntry {
+    startedAt: number;
+    endedAt?: number;
+    msPassed?: number;
+}
+export interface IPerformanceTimer {
+    startTimer(name?: string): PerformanceTimerUid;
+    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
+}

package/dist/utils/performance-timer.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=performance-timer.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.5.2",
+  "version": "0.5.5",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,7 +11,7 @@
     "typescript": "^4.7.4"
   },
   "scripts": {
-    "build": "rm -rf ./dist && npx tsc --build"
+    "build": "rimraf ./dist && npx tsc --build"
   },
   "repository": {
     "type": "git",
@@ -26,11 +26,11 @@
     "runtime",
     "abstract"
   ],
-  "author": "Andrei Cojocaru",
-  "license": "MIT",
+  "author": "privatebytes",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "833c175fefd7678fe598f58ef1afd0d61f72353a"
+  "gitHead": "03a36e0b5e8af333f3922e331cbacadda408f0cc"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Andrei C
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/entities/entity-event.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"entity-event.js","sourceRoot":"","sources":["../../src/entities/entity-event.ts"],"names":[],"mappings":""}