@awesome-ecs/abstract 0.1.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,4 @@
1
+ import { EntityTriggerUid } from "..";
1
2
  import { IEntityModel } from "./entity";
2
3
  import { IEntityProxy } from "./entity-proxy";
3
4
  import { IEntityTrigger, ITriggerData } from "./entity-trigger";
@@ -15,7 +16,7 @@ export interface IEntityUpdate {
15
16
  type: EntityUpdateType;
16
17
  entity: IEntityProxy;
17
18
  model?: IEntityModel;
18
- trigger?: IEntityTrigger<ITriggerData>;
19
+ triggers?: Map<EntityTriggerUid, IEntityTrigger<ITriggerData>>;
19
20
  forceUpdate?: boolean;
20
21
  }
21
22
  /**
@@ -1 +1 @@
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"}
1
+ {"version":3,"file":"entity-queue.js","sourceRoot":"","sources":["../../src/entities/entity-queue.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}
@@ -1,13 +1,9 @@
1
1
  import { IEntityProxy } from "./entity-proxy";
2
- import { ComponentUid } from "../components/component";
2
+ import { EntityUpdateType } from "./entity-queue";
3
3
  export declare type EntityTriggerUid = string | number;
4
- export declare enum EntityTriggerAction {
5
- add = "add",
6
- remove = "remove"
7
- }
8
4
  export interface ITriggerData {
9
- action: EntityTriggerAction;
10
- componentUid: ComponentUid;
5
+ uid: EntityTriggerUid;
6
+ action?: EntityUpdateType;
11
7
  }
12
8
  /**
13
9
  * Entity Triggers represent a basic inter-Entity messaging mechanism.
@@ -16,7 +12,6 @@ export interface ITriggerData {
16
12
  * The Triggers will be enqueued as part of an Entity Update envelope.
17
13
  */
18
14
  export interface IEntityTrigger<TTriggerData extends ITriggerData> {
19
- uid: EntityTriggerUid;
20
15
  origin: IEntityProxy;
21
16
  data: TTriggerData;
22
17
  }
@@ -1,6 +1,2 @@
1
- export var EntityTriggerAction;
2
- (function (EntityTriggerAction) {
3
- EntityTriggerAction["add"] = "add";
4
- EntityTriggerAction["remove"] = "remove";
5
- })(EntityTriggerAction || (EntityTriggerAction = {}));
1
+ export {};
6
2
  //# sourceMappingURL=entity-trigger.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"entity-trigger.js","sourceRoot":"","sources":["../../src/entities/entity-trigger.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,wCAAiB,CAAA;AACnB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B"}
1
+ {"version":3,"file":"entity-trigger.js","sourceRoot":"","sources":["../../src/entities/entity-trigger.ts"],"names":[],"mappings":""}
@@ -15,4 +15,5 @@ export interface IEntity {
15
15
  readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
16
16
  readonly triggers: Map<EntityTriggerUid, IEntityTrigger<ITriggerData>[]>;
17
17
  readonly identity: IdentityComponent<IEntityModel>;
18
+ readonly myProxy: IEntityProxy;
18
19
  }
@@ -2,6 +2,9 @@
2
2
  * 'Stop' function, passed to a middleware. Call it to break the pipeline execution.
3
3
  */
4
4
  export declare type Stop = () => void;
5
+ /**
6
+ * A middleware, the building block of a Pipeline. The middlewares will get called in the same order they get registered in the Pipeline.
7
+ */
5
8
  export interface IMiddleware<TContext> {
6
9
  /**
7
10
  * This (optional) function gets called before executing the middleware. It acts as a boolean gateway whether enough conditions are
@@ -1,14 +1,13 @@
1
1
  import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
2
2
  import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
3
- import { IEntityTrigger, ITriggerData } from "../entities/entity-trigger";
3
+ import { EntityTriggerUid, IEntityTrigger, ITriggerData } from "../entities/entity-trigger";
4
4
  export interface IEntitySchedule {
5
5
  target: IEntityProxy;
6
6
  intervalMs?: number;
7
7
  }
8
8
  export interface ISystemPipelineContext<TEntity extends IEntity> {
9
9
  readonly entity: TEntity;
10
- addEntity(entityType: EntityTypeUid, model: IEntityModel): void;
11
- addTrigger<TTriggerData extends ITriggerData>(target: IEntityProxy, trigger: IEntityTrigger<TTriggerData>): void;
10
+ addEntity(entityType: EntityTypeUid, model: IEntityModel, triggers?: ITriggerData[]): void;
12
11
  updateEntity(target?: IEntityProxy, model?: IEntityModel): void;
13
12
  removeEntity(target?: IEntityProxy): void;
14
13
  scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
@@ -17,4 +16,14 @@ export interface ISystemPipelineContext<TEntity extends IEntity> {
17
16
  registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
18
17
  registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
19
18
  removeProxies(proxyEntityType?: EntityTypeUid): void;
19
+ addTrigger<TTriggerData extends ITriggerData>(target: IEntityProxy, data: TTriggerData): void;
20
+ addTriggers<TTriggerData extends ITriggerData>(target: IEntityProxy, data: TTriggerData[]): void;
21
+ /**
22
+ * Retrieve the first Trigger of the specified type.
23
+ * @param uid The Trigger type.
24
+ */
25
+ getTrigger<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>;
26
+ getTriggers<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>[];
27
+ hasTriggers(uid?: EntityTriggerUid): boolean;
28
+ removeTriggers(uid?: EntityTriggerUid): void;
20
29
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awesome-ecs/abstract",
3
- "version": "0.1.2",
3
+ "version": "0.2.1",
4
4
  "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -32,5 +32,5 @@
32
32
  "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
33
33
  },
34
34
  "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
35
- "gitHead": "e0fb85ede67f6cd069a0e120be11e5a3e38d89a8"
35
+ "gitHead": "41adf309cfcd40d7cffac2e6047d6026f09c013b"
36
36
  }