@antha/entity-2d 0.0.8 → 0.1.1

package/README.md

@@ -1,11 +1,55 @@
 # @antha/entity-2d
 
-A pre-built [Antha](https://www.npmjs.com/package/antha) mod for rendering and handling collision detection for 2D entities. This requires a mod that has setup PixiJS in a manner compatible with [@antha/graphics-2d](https://npmjs.com/package/@antha/graphics-2d)
-
-Demo: https://electrovir.github.io/antha/demo/basic-entities
+This package provides a pre-built [Antha game engine](https://www.npmjs.com/package/@antha/engine) mod for creating, updating, rendering, and collision-checking 2D entities. It uses the PixiJS application supplied by [`@antha/graphics-2d`](https://npmjs.com/package/@antha/graphics-2d) to display entity views.
 
 ## Install
 
 ```sh
 npm i @antha/entity-2d
 ```
+
+## Usage
+
+<!-- example-link: src/readme-examples/creating-logic-entity.example.ts -->
+
+```TypeScript
+import {AnthaEngine, defineAnthaMod} from '@antha/engine';
+import {createAnthaGraphics2dMod} from '@antha/graphics-2d';
+import {type AnthaEntity2dModState, createAnthaEntityMod2d} from '@antha/entity-2d';
+
+type GameState = AnthaEntity2dModState<{
+    hasCreatedScoreEntity: boolean;
+}>;
+
+const {defineLogicEntity, mod: entityMod} = createAnthaEntityMod2d<{
+    hasCreatedScoreEntity: boolean;
+}>();
+
+class ScoreEntity extends defineLogicEntity({
+    key: 'score',
+    paramsShape: undefined,
+}) {
+    public override update() {}
+}
+
+const engine = new AnthaEngine<GameState>({
+    initState: {
+        hasCreatedScoreEntity: false,
+    },
+    mods: [
+        createAnthaGraphics2dMod(),
+        entityMod,
+        defineAnthaMod<GameState>({
+            modName: 'game-logic',
+            async execute({state}) {
+                if (state.entityStore && !state.hasCreatedScoreEntity) {
+                    state.hasCreatedScoreEntity = true;
+                    await state.entityStore.addEntity(ScoreEntity);
+                }
+            },
+        }),
+    ],
+});
+
+engine.startLoop();
+```

package/dist/entity-suite.d.ts

@@ -1,6 +1,5 @@
-import { type AnyObject } from '@augment-vir/common';
+import { type AnyObject, type Constructor, type IsAny } from '@augment-vir/common';
 import { type Shape } from 'object-shape-tester';
-import { type Constructor, type IsAny } from 'type-fest';
 import { BaseEntity2d, type BaseEntityAssetDefinitions, type Entity2dConstructorParams, EntityStore2d, type EntityStore2dConstructorParams, type MappedEntityAssets, type ParamsMap, type ReverseParamsMap, ViewEntity2d } from './entity.js';
 /**
  * Params for both {@link EntitySuite2d.defineEntity} and {@link EntitySuite2d.defineLogicEntity}.

package/dist/entity-suite.js

@@ -1,5 +1,5 @@
 import { check } from '@augment-vir/assert';
-import { getObjectTypedEntries, getOrSet } from '@augment-vir/common';
+import { getObjectTypedEntries, getOrSet, } from '@augment-vir/common';
 import { BaseEntity2d, EntityStore2d, ViewEntity2d, } from './entity.js';
 /**
  * This is the starting point of the @game-vir/entity package. Call this to produce the function

package/dist/entity.d.ts

@@ -1,10 +1,9 @@
 import { type Asset, type AssetBulkLoaderLoadOptions, type AssetLoader, type AssetValue } from '@antha/asset';
 import { type PixiApplication } from '@antha/graphics-2d';
-import { ConstructorInstanceMap, type AnyObject, type ExtractKeysWithMatchingValues, type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
+import { ConstructorInstanceMap, type AbstractConstructor, type AnyObject, type Constructor, type EmptyObject, type ExtractKeysWithMatchingValues, type IsEqual, type IsNever, type MaybePromise, type PartialWithUndefined, type WritableKeysOf } from '@augment-vir/common';
 import { System as HitboxSystem, type Response as Collision, type Body as Hitbox } from 'detect-collisions';
 import { type Shape } from 'object-shape-tester';
 import { type Container, type ViewContainer } from 'pixi.js';
-import { type AbstractConstructor, type Constructor, type EmptyObject, type IsEqual, type IsNever, type WritableKeysOf } from 'type-fest';
 import { GenericListenTarget } from 'typed-event-target';
 import { type StaticEntity2dParts } from './entity-suite.js';
 export { System as HitboxSystem, type Response as Collision } from 'detect-collisions';
@@ -322,7 +321,7 @@ export declare abstract class BaseEntity2d<State extends AnyObject = any, Params
     dispatch(event: EntityEvent | EntityDestroyEvent): void;
     /** If true, this entity should no longer be used or operated upon. */
     readonly isDestroyed: boolean;
-    private readonly abortController;
+    protected readonly abortController: AbortController;
     /** An `AbortSignal` that triggers when the entity is destroyed. */
     readonly abortSignal: AbortSignal;
     hitbox: Hitbox<this> | undefined;
@@ -411,7 +410,8 @@ export declare abstract class ViewEntity2d<State extends AnyObject = any, Params
     /** Creates the view and hitbox, adds the view to the stage, and sets up the params proxy. */
     initInstance(): Promise<void>;
     constructor(args: Readonly<Entity2dConstructorParams<NoInfer<State>, NoInfer<Params>>>);
-    private wrapParamsInProxy;
+    /** Wrap entity params in a proxy that maps changes to the view and hitbox properties. */
+    protected wrapParamsInProxy(): void;
     /**
      * Creates the entity's PixiJS view. This will be called on entity construction and added to the
      * PixiJS application stage.

package/dist/entity.js

@@ -404,6 +404,7 @@ export class ViewEntity2d extends BaseEntity2d {
     constructor(args) {
         super(args);
     }
+    /** Wrap entity params in a proxy that maps changes to the view and hitbox properties. */
     wrapParamsInProxy() {
         const paramsMap = this.constructor.paramsMap;
         const reverseParamsMap = this.constructor.reverseParamsMap;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/entity-2d",
-    "version": "0.0.8",
+    "version": "0.1.1",
     "description": "An Antha mod for handling 2D entities.",
     "keywords": [
         "vir",
@@ -35,27 +35,26 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.73.1",
-        "@augment-vir/common": "^31.73.1",
-        "type-fest": "^5.7.0"
+        "@augment-vir/assert": "^32.2.2",
+        "@augment-vir/common": "^32.2.2"
     },
     "devDependencies": {
-        "@antha/engine": "^0.0.8",
-        "@augment-vir/test": "^31.73.1",
-        "@web/dev-server-esbuild": "^1.0.5",
-        "@web/test-runner": "^0.20.2",
-        "@web/test-runner-playwright": "^0.11.1",
+        "@antha/engine": "^0.1.1",
+        "@antha/web-test-runner-plugin-pixi": "^0.1.1",
+        "@augment-vir/test": "^32.2.2",
+        "@web/dev-server-esbuild": "^2.0.0",
+        "@web/test-runner": "^1.0.0",
+        "@web/test-runner-playwright": "^1.0.0",
         "detect-collisions": "^10.10.2025",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "object-shape-tester": "^6.14.0",
+        "object-shape-tester": "^6.14.1",
         "pixi.js": "^8.19.0",
-        "typed-event-target": "^4.3.1",
-        "web-test-runner-plugin-pixi": "^0.0.2"
+        "typed-event-target": "^4.3.3"
     },
     "peerDependencies": {
-        "@antha/asset": "^0.0.8",
+        "@antha/asset": "^0.1.1",
         "@antha/engine": "*",
-        "@antha/graphics-2d": "^0.0.8",
+        "@antha/graphics-2d": "^0.1.1",
         "detect-collisions": ">=10",
         "element-vir": ">=26",
         "object-shape-tester": ">=6",