@awesome-ecs/abstract 0.0.8 → 0.2.0

package/dist/components/component-factory.d.ts

@@ -0,0 +1,4 @@
+import { ComponentTypeUid, IComponent } from "./component";
+export interface IComponentFactory {
+    create<TComponent extends IComponent>(type: ComponentTypeUid): TComponent;
+}

package/dist/components/component-factory.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=component-factory.js.map

package/dist/components/component-factory.js.map

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

package/dist/components/component.d.ts

@@ -1,5 +1,5 @@
-export declare type ComponentTypeUid = string | number;
+export declare type ComponentUid = string | number;
 export interface IComponent {
-    readonly componentType: ComponentTypeUid;
+    readonly componentType: ComponentUid;
     toJSON?(): string | object;
 }

package/dist/components/identity-component.d.ts

@@ -1,6 +1,6 @@
 import { IComponent } from "./component";
-import { IEntityModel } from "../entities/entity-model";
-import { EntityTypeUid } from "../entities/entity";
+import { EntityTypeUid, IEntityModel } from "../entities/entity";
+import { IEntityProxy } from "..";
 export declare enum BasicComponentType {
     identity = "identity"
 }
@@ -8,4 +8,5 @@ export interface IdentityComponent<TModel extends IEntityModel> extends ICompone
     entityType: EntityTypeUid;
     model: TModel;
     previousModel?: TModel;
+    proxies?: IEntityProxy[];
 }

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

@@ -1,24 +1,4 @@
-import { EntityTypeUid } from "./entity";
 export declare type EntityUid = string | number;
-export declare enum EntityChangeType {
-    added = "added",
-    removed = "removed",
-    updated = "updated"
-}
 export interface IEntityModel {
     uid: EntityUid;
 }
-export interface IEntityModelChange {
-    changeType: EntityChangeType;
-    entityType: EntityTypeUid;
-    currentModel?: IEntityModel;
-    previousModel?: IEntityModel;
-    shouldForceUpdate?: boolean;
-}
-export interface IEntityUpdateQueue {
-    readonly size: number;
-    enqueue(change: IEntityModelChange): void;
-    dequeue(): IEntityModelChange;
-    peek(): IEntityModelChange;
-    clear(): void;
-}

package/dist/entities/entity-model.js

@@ -1,7 +1,2 @@
-export var EntityChangeType;
-(function (EntityChangeType) {
-    EntityChangeType["added"] = "added";
-    EntityChangeType["removed"] = "removed";
-    EntityChangeType["updated"] = "updated";
-})(EntityChangeType || (EntityChangeType = {}));
+export {};
 //# sourceMappingURL=entity-model.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"entity-model.js","sourceRoot":"","sources":["../../src/entities/entity-model.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,uCAAmB,CAAA;AACrB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B"}
+{"version":3,"file":"entity-model.js","sourceRoot":"","sources":["../../src/entities/entity-model.ts"],"names":[],"mappings":""}

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

@@ -1,6 +1,14 @@
-import { EntityTypeUid } from "./entity";
-import { EntityUid } from "./entity-model";
+import { EntityTypeUid, EntityUid, IEntity } from "./entity";
+/**
+ * Represents a pointer to another Entity.
+ */
 export interface IEntityProxy {
     readonly entityType: EntityTypeUid;
     readonly entityUid: EntityUid;
 }
+/**
+ * A utility extension of IEntityProxy.
+ * Useful for providing Type information when using the IEntityProxy.
+ */
+export interface EntityProxy<TEntity extends IEntity> extends IEntityProxy {
+}

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

@@ -0,0 +1,31 @@
+import { IEntityModel } from "./entity";
+import { IEntityProxy } from "./entity-proxy";
+import { IEntityTrigger, ITriggerData } from "./entity-trigger";
+/**
+ * The Entity update state for this change.
+ */
+export declare enum EntityUpdateType {
+    update = "update",
+    remove = "remove"
+}
+/**
+ * Represents an Entity update that should be applied over an (existing) Entity.
+ */
+export interface IEntityUpdate {
+    type: EntityUpdateType;
+    entity: IEntityProxy;
+    model?: IEntityModel;
+    trigger?: IEntityTrigger<ITriggerData>;
+    forceUpdate?: boolean;
+}
+/**
+ * The Entity Updates will be queued up, and can be picked up in order.
+ * The interface can be implemented using a simple queue mechanism, or perhaps, a Priority Queue.
+ */
+export interface IEntityUpdateQueue {
+    readonly size: number;
+    enqueue(change: IEntityUpdate): void;
+    dequeue(): IEntityUpdate;
+    peek(): IEntityUpdate;
+    clear(): void;
+}

package/dist/entities/entity-queue.js

@@ -0,0 +1,9 @@
+/**
+ * The Entity update state for this change.
+ */
+export var EntityUpdateType;
+(function (EntityUpdateType) {
+    EntityUpdateType["update"] = "update";
+    EntityUpdateType["remove"] = "remove";
+})(EntityUpdateType || (EntityUpdateType = {}));
+//# sourceMappingURL=entity-queue.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity-queue.js","sourceRoot":"","sources":["../../src/entities/entity-queue.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}

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

@@ -1,5 +1,8 @@
-import { EntityTypeUid, IEntity } from "./entity";
-import { EntityUid } from "./entity-model";
+import { EntityUid, EntityTypeUid, IEntity } from "./entity";
+/**
+ * The Entity Repository is the main storage for keeping track of existing Entities.
+ * It provides basic CRUD functionality.
+ */
 export interface IEntityRepository {
     has(type: EntityTypeUid, uid: EntityUid): boolean;
     get<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): TEntity;

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

@@ -1,4 +1,9 @@
 import { IEntityProxy } from "./entity-proxy";
+/**
+ * The Entity Scheduler is the main way of scheduling Entity Updates on a Time Interval.
+ * It usually reads the Entities from the Entity Repository,
+ * and uses the Entity Update Queue to enqueue Entity updates.
+ */
 export interface IEntityScheduler {
     schedule(entityProxy: IEntityProxy, intervalMs?: number): void;
     remove(entityProxy: IEntityProxy): void;

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

@@ -0,0 +1,17 @@
+import { IEntityProxy } from "./entity-proxy";
+import { EntityUpdateType } from "./entity-queue";
+export declare type EntityTriggerUid = string | number;
+export interface ITriggerData {
+    uid: EntityTriggerUid;
+    action?: EntityUpdateType;
+}
+/**
+ * Entity Triggers represent a basic inter-Entity messaging mechanism.
+ * Can be used to "trigger" actions in an Entity, from the systems of another Entity.
+ *
+ * The Triggers will be enqueued as part of an Entity Update envelope.
+ */
+export interface IEntityTrigger<TTriggerData extends ITriggerData> {
+    origin: IEntityProxy;
+    data: TTriggerData;
+}

package/dist/entities/entity-trigger.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entity-trigger.js.map

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

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

package/dist/entities/entity.d.ts

@@ -1,15 +1,19 @@
 import { IdentityComponent } from "../components/identity-component";
-import { ComponentTypeUid, IComponent } from "../components/component";
-import { EntityUid, IEntityModel } from "./entity-model";
+import { ComponentUid, IComponent } from "../components/component";
+import { EntityTriggerUid, IEntityTrigger, ITriggerData } from "./entity-trigger";
 import { IEntityProxy } from "./entity-proxy";
 export declare type EntityTypeUid = string | number;
+export declare type EntityUid = string | number;
+export interface IEntityModel {
+    uid: EntityUid;
+}
+/**
+ * An Entity is a container of Components and Entity Proxies. Only Systems can manipulate the internal state of the Entity.
+ */
 export interface IEntity {
-    readonly identity: IdentityComponent<IEntityModel>;
-    readonly components: Map<ComponentTypeUid, IComponent>;
+    readonly components: Map<ComponentUid, IComponent>;
     readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
-    hasProxy(proxy: IEntityProxy): boolean;
-    registerProxy(proxy: IEntityProxy): void;
-    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
-    removeProxy(proxyToRemove: IEntityProxy): void;
-    removeProxies(proxyEntityType?: EntityTypeUid): void;
+    readonly triggers: Map<EntityTriggerUid, IEntityTrigger<ITriggerData>[]>;
+    readonly identity: IdentityComponent<IEntityModel>;
+    readonly myProxy: IEntityProxy;
 }

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 export * from './components/component';
 export * from './components/identity-component';
 export * from './entities/entity';
-export * from './entities/entity-model';
 export * from './entities/entity-proxy';
+export * from './entities/entity-queue';
 export * from './entities/entity-repository';
 export * from './entities/entity-scheduler';
+export * from './entities/entity-trigger';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';

package/dist/index.js

@@ -1,10 +1,11 @@
 export * from './components/component';
 export * from './components/identity-component';
 export * from './entities/entity';
-export * from './entities/entity-model';
 export * from './entities/entity-proxy';
+export * from './entities/entity-queue';
 export * from './entities/entity-repository';
 export * from './entities/entity-scheduler';
+export * from './entities/entity-trigger';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,iCAAiC,CAAA;AAE/C,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,6BAA6B,CAAA;AAE3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,0BAA0B,CAAA;AAExC,cAAc,2BAA2B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,iCAAiC,CAAA;AAE/C,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AAEzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,0BAA0B,CAAA;AAExC,cAAc,2BAA2B,CAAA"}

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

@@ -1,7 +1,28 @@
-import { IEntity } from "../entities/entity";
-import { IEntityModelChange } from "../entities/entity-model";
+import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
+import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
+import { EntityTriggerUid, IEntityTrigger, ITriggerData } from "../entities/entity-trigger";
+export interface IEntitySchedule {
+    target: IEntityProxy;
+    intervalMs?: number;
+}
 export interface ISystemPipelineContext<TEntity extends IEntity> {
-    entity: TEntity;
-    modelChange: IEntityModelChange;
-    entityUpdatesToSchedule: IEntityModelChange[];
+    readonly entity: TEntity;
+    addEntity(entityType: EntityTypeUid, model: IEntityModel): void;
+    updateEntity(target?: IEntityProxy, model?: IEntityModel): void;
+    removeEntity(target?: IEntityProxy): void;
+    scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
+    clearUpdateOnInterval(target?: IEntityProxy): void;
+    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
+    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
+    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
+    removeProxies(proxyEntityType?: EntityTypeUid): void;
+    addTrigger<TTriggerData extends ITriggerData>(target: IEntityProxy, data: TTriggerData): void;
+    /**
+     * Retrieve the first Trigger of the specified type.
+     * @param uid The Trigger type.
+     */
+    getTrigger<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>;
+    getTriggers<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>[];
+    hasTriggers(uid?: EntityTriggerUid): boolean;
+    removeTriggers(uid?: EntityTriggerUid): void;
 }

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

@@ -1,5 +1,4 @@
-import { IEntity } from "../entities/entity";
-import { IEntityModelChange } from "../entities/entity-model";
-export interface ISystemPipeline<TEntity extends IEntity> {
-    handleEntityModelChange(entity: TEntity, modelChange: IEntityModelChange): void | Promise<void>;
+import { IEntityUpdate } from "../entities/entity-queue";
+export interface ISystemPipeline {
+    handleUpdate(update: IEntityUpdate): void | Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,7 +8,7 @@
     "dist"
   ],
   "devDependencies": {
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
   "scripts": {
     "build": "npx tsc"
@@ -32,5 +32,5 @@
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "53fc9410e7bb114fed7841fed5480b374da983d2"
+  "gitHead": "2b590e7a53a247ce7ec019b061658dafef679a35"
 }