@awesome-ecs/abstract 0.5.4 → 0.7.0

package/dist/systems/system-middleware.d.ts

@@ -1,8 +1,8 @@
-import { IEntity } from "../entities/entity";
-import { IMiddleware } from "../pipelines/middleware";
-import { ISystemPipelineContext } from "./system-pipeline-context";
-/**
- * The SystemMiddleware is the basic System implementation that can be registered as a Middleware in a SystemPipeline.
- * It provides a SystemPipelineContext to it's exposed methods.
- */
-export declare type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemPipelineContext<TEntity>>;
+import { IEntity } from "../entities/entity";
+import { IMiddleware } from "../pipelines/middleware";
+import { ISystemPipelineContext } from "./system-pipeline-context";
+/**
+ * The SystemMiddleware is the basic System implementation that can be registered as a Middleware in a SystemPipeline.
+ * It provides a SystemPipelineContext to it's exposed methods.
+ */
+export declare type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemPipelineContext<TEntity>>;

package/dist/systems/system-middleware.js

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

package/dist/systems/system-pipeline-context.d.ts

@@ -1,39 +1,39 @@
-import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
-import { EntityEventUid, IEntityEvent, IEventData } from "../entities/entity-events";
-import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
-export interface ISystemContextRepository {
-    addEntity(entityType: EntityTypeUid, model: IEntityModel, events?: IEntityEvent<IEventData>[]): void;
-    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
-    updateEntity(target?: IEntityProxy): void;
-    removeEntity(target: IEntityProxy): void;
-}
-export interface ISystemContextScheduler {
-    scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
-    clearUpdateOnInterval(target?: IEntityProxy): void;
-}
-export interface ISystemContextProxies {
-    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
-    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
-    removeProxy(proxy: IEntityProxy): void;
-    removeProxies(proxyEntityType?: EntityTypeUid): void;
-}
-export interface ISystemContextEvents {
-    dispatchEvent<TEventData extends IEventData>(data: TEventData, ...targets: IEntityProxy[]): void;
-    dispatchEvents<TEventData extends IEventData>(data: TEventData[], ...targets: IEntityProxy[]): void;
-    getEvent<TEventData extends IEventData>(uid: EntityEventUid): IEntityEvent<TEventData>;
-    listEvents<TEventData extends IEventData>(): IEntityEvent<TEventData>[];
-    hasEvent(uid?: EntityEventUid): boolean;
-    subscribeTo<TEventData extends IEventData>(uid: EntityEventUid, filter?: (event: IEntityEvent<TEventData>) => boolean): void;
-    unsubscribeFrom(uid: EntityEventUid): void;
-    clearSubscriptions(uid?: EntityEventUid): void;
-    setContextEvents(events: IEntityEvent<IEventData>[]): void;
-    setContextEvent(event: IEntityEvent<IEventData>): void;
-}
-export interface ISystemPipelineContext<TEntity extends IEntity> {
-    readonly entity: TEntity;
-    readonly deltaTimeMs: number;
-    readonly repository: ISystemContextRepository;
-    readonly scheduler: ISystemContextScheduler;
-    readonly proxies: ISystemContextProxies;
-    readonly events: ISystemContextEvents;
-}
+import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
+import { EntityEventUid, IEntityEvent, IEventData } from "../entities/entity-events";
+import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
+export interface ISystemContextRepository {
+    addEntity(entityType: EntityTypeUid, model: IEntityModel, events?: IEntityEvent<IEventData>[]): void;
+    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
+    updateEntity(target?: IEntityProxy): void;
+    removeEntity(target: IEntityProxy): void;
+}
+export interface ISystemContextScheduler {
+    scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
+    clearUpdateOnInterval(target?: IEntityProxy): void;
+}
+export interface ISystemContextProxies {
+    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
+    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
+    removeProxy(proxy: IEntityProxy): void;
+    removeProxies(proxyEntityType?: EntityTypeUid): void;
+}
+export interface ISystemContextEvents {
+    dispatchEvent<TEventData extends IEventData>(data: TEventData, ...targets: IEntityProxy[]): void;
+    dispatchEvents<TEventData extends IEventData>(data: TEventData[], ...targets: IEntityProxy[]): void;
+    getEvent<TEventData extends IEventData>(uid: EntityEventUid): IEntityEvent<TEventData>;
+    listEvents<TEventData extends IEventData>(): IEntityEvent<TEventData>[];
+    hasEvent(uid?: EntityEventUid): boolean;
+    subscribeTo<TEventData extends IEventData>(uid: EntityEventUid, filter?: (event: IEntityEvent<TEventData>) => boolean): void;
+    unsubscribeFrom(uid: EntityEventUid): void;
+    clearSubscriptions(uid?: EntityEventUid): void;
+    setContextEvents(events: IEntityEvent<IEventData>[]): void;
+    setContextEvent(event: IEntityEvent<IEventData>): void;
+}
+export interface ISystemPipelineContext<TEntity extends IEntity> {
+    readonly entity: TEntity;
+    readonly deltaTimeMs: number;
+    readonly repository: ISystemContextRepository;
+    readonly scheduler: ISystemContextScheduler;
+    readonly proxies: ISystemContextProxies;
+    readonly events: ISystemContextEvents;
+}

package/dist/systems/system-pipeline-context.js

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

package/dist/systems/system-pipeline-type.d.ts

@@ -1,6 +1,6 @@
-export declare enum SystemPipelineType {
-    initialize = "initialize",
-    update = "update",
-    render = "render",
-    sync = "sync"
-}
+export declare enum SystemPipelineType {
+    initialize = "initialize",
+    update = "update",
+    render = "render",
+    sync = "sync"
+}

package/dist/systems/system-pipeline-type.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SystemPipelineType = void 0;
-var SystemPipelineType;
-(function (SystemPipelineType) {
-    SystemPipelineType["initialize"] = "initialize";
-    SystemPipelineType["update"] = "update";
-    SystemPipelineType["render"] = "render";
-    SystemPipelineType["sync"] = "sync";
-})(SystemPipelineType = exports.SystemPipelineType || (exports.SystemPipelineType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemPipelineType = void 0;
+var SystemPipelineType;
+(function (SystemPipelineType) {
+    SystemPipelineType["initialize"] = "initialize";
+    SystemPipelineType["update"] = "update";
+    SystemPipelineType["render"] = "render";
+    SystemPipelineType["sync"] = "sync";
+})(SystemPipelineType = exports.SystemPipelineType || (exports.SystemPipelineType = {}));
 //# sourceMappingURL=system-pipeline-type.js.map

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

@@ -1,21 +1,25 @@
-import { IEntity } from "../entities/entity";
-import { IEntityUpdate } from "../entities/entity-queue";
-import { ISystemMiddleware } from "./system-middleware";
-import { SystemPipelineType } from "./system-pipeline-type";
-/**
- * The SystemModule is the main way of registering and triggering the SystemMiddlewares registered for an Entity.
- * It can handle EntityUpdate objects and decides which SystemPipelines to trigger based on the information in the EntityUpdate.
- */
-export interface ISystemsModule {
-    /**
-     * The method allows triggering all registered SystemPipelines, to apply the changes from the provided EntityUpdate to an Entity instance.
-     * @param update The EntityUpdate containing the desired changes to be applied on an Entity instance.
-     */
-    triggerSystems(update: IEntityUpdate): void | Promise<void>;
-    /**
-     * @param type The SystemPipelineType to append the provided SystemMiddlewares to.
-     * @param systems The SystemMiddlewares will be registered in the provided SystemPipelineType in the same order as the provided array.
-     * The SystemMiddlewares will be appended to existing Pipelines to allow easy extension of existing behaviors.
-     */
-    registerSystems(type: SystemPipelineType, systems: ISystemMiddleware<IEntity>[]): void;
-}
+import { IEntity } from "../entities/entity";
+import { IEntityUpdate } from "../entities/entity-queue";
+import { PerformanceTimeEntry } from "../utils/performance-timer";
+import { ISystemMiddleware } from "./system-middleware";
+import { SystemPipelineType } from "./system-pipeline-type";
+export interface ISystemsModuleRuntimeResult {
+    metrics: PerformanceTimeEntry[];
+}
+/**
+ * The SystemModule is the main way of registering and triggering the SystemMiddlewares registered for an Entity.
+ * It can handle EntityUpdate objects and decides which SystemPipelines to trigger based on the information in the EntityUpdate.
+ */
+export interface ISystemsModule {
+    /**
+     * The method allows triggering all registered SystemPipelines, to apply the changes from the provided EntityUpdate to an Entity instance.
+     * @param update The EntityUpdate containing the desired changes to be applied on an Entity instance.
+     */
+    triggerSystems(update: IEntityUpdate): ISystemsModuleRuntimeResult | Promise<ISystemsModuleRuntimeResult>;
+    /**
+     * @param type The SystemPipelineType to append the provided SystemMiddlewares to.
+     * @param systems The SystemMiddlewares will be registered in the provided SystemPipelineType in the same order as the provided array.
+     * The SystemMiddlewares will be appended to existing Pipelines to allow easy extension of existing behaviors.
+     */
+    registerSystems(type: SystemPipelineType, systems: ISystemMiddleware<IEntity>[]): void;
+}

package/dist/systems/systems-module.js

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

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

@@ -1,26 +1,26 @@
-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;
-}
+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 | Promise<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,11 @@
-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 {
+    name: string;
+    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.4",
+  "version": "0.7.0",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,5 +32,5 @@
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "42e25f322e65c919497d189e34db4d897f985571"
+  "gitHead": "437c4702120c2fa0857a034e21096f0e683845bc"
 }