@antha/entity-2d 0.16.0 → 0.18.0

package/README.md

@@ -15,13 +15,13 @@ npm i @antha/entity-2d
 ```TypeScript
 import {AnthaEngine, defineAnthaMod} from '@antha/engine';
 import {createAnthaGraphics2dMod} from '@antha/graphics-2d';
-import {type AnthaEntity2dModState, createAnthaEntityMod2d} from '@antha/entity-2d';
+import {type AnthaEntity2dModState, createAnthaEntity2dSuite} from '@antha/entity-2d';
 
 type GameState = AnthaEntity2dModState<{
     hasCreatedScoreEntity: boolean;
 }>;
 
-const {defineLogicEntity, mod: entityMod} = createAnthaEntityMod2d<{
+const {defineLogicEntity, updateEntitiesMod} = createAnthaEntity2dSuite<{
     hasCreatedScoreEntity: boolean;
 }>();
 
@@ -38,7 +38,7 @@ const engine = new AnthaEngine<GameState>({
     },
     mods: [
         createAnthaGraphics2dMod(),
-        entityMod,
+        updateEntitiesMod,
         defineAnthaMod<GameState>({
             modName: 'game-logic',
             async execute({state}) {

package/dist/{entity-suite.d.ts → antha-entity-2d.mod.d.ts}

@@ -1,8 +1,11 @@
-import { type AnyObject, type Constructor, type IsAny } from '@augment-vir/common';
+import { type AnthaAssetModState } from '@antha/asset';
+import { type ModTrigger } from '@antha/engine';
+import { type AnthaGraphics2dModState } from '@antha/graphics-2d';
+import { type AnyObject, type Constructor, type PartialWithUndefined } from '@augment-vir/common';
 import { type Shape } from 'object-shape-tester';
-import { BaseEntity2d, type BaseEntityAssetDefinitions, type Entity2dConstructor, type Entity2dConstructorParams, type EntityCollisionDefinition, EntityStore2d, type EntityStore2dConstructorParams, type MappedEntityAssets, type ParamsMap, type ReverseParamsMap, ViewEntity2d } from './entity.js';
+import { BaseEntity2d, EntityStore2d, ViewEntity2d, type BaseEntityAssetDefinitions, type EntityCollisionDefinition, type EntityStore2dConstructorParams, type ParamsMap, type StaticEntity2dParts } from './entity.js';
 /**
- * Params for both {@link EntitySuite2d.defineEntity} and {@link EntitySuite2d.defineLogicEntity}.
+ * Params for both `defineEntity` and `defineLogicEntity`.
  *
  * @category Internal
  */
@@ -92,37 +95,6 @@ export type DefineEntity2dArgs<ParamsShape extends Shape | undefined, EntityAsse
     paramsMap?: ParamsMap<NoInfer<ParamsShape> extends Shape ? NoInfer<ParamsShape>['runtimeType'] : undefined> | undefined;
     assets?: EntityAssets;
 };
-/**
- * Static members of both view and logic entity constructors.
- *
- * @category Internal
- */
-export type StaticEntity2dParts<State extends AnyObject = any, ParamsShape extends Shape | undefined = any, EntityAssets extends BaseEntityAssetDefinitions | undefined = any> = {
-    /** Entity classes this entity observes collisions with. Omit to observe none. */
-    collidesWith: EntityCollisionDefinition | undefined;
-    /** Cached entity classes this entity observes collisions with. */
-    collidesWithSet: ReadonlySet<Entity2dConstructor>;
-    /**
-     * This key is used for deserialization of entities to track which class needs to be
-     * constructed. You cannot have duplicate keys loaded at the same time.
-     *
-     * This is used instead of inferring the entity key from the class name so that you can still
-     * minify your class names without making debugging nigh impossible (you'll still know which
-     * entities are being serialized and deserialized even if your class names are minified).
-     */
-    entityKey: string;
-    /** Shape definition of this entity's parameters. */
-    paramsShape: ParamsShape;
-    /**
-     * Defines which properties from {@link BaseEntity2d.params} will be mapped to hitbox and/or view
-     * properties.
-     */
-    paramsMap: IsAny<ParamsShape> extends true ? any : ParamsMap<ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
-    /** Parses the serialized params generated by {@link BaseEntity2d.serialize}. */
-    deserialize(serialized: string | undefined): AnyObject | undefined;
-    assets: MappedEntityAssets<EntityAssets>;
-    ConstructorArgsType: Entity2dConstructorParams<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
-};
 /**
  * ========================
  *
@@ -145,7 +117,7 @@ export type DefinedViewEntity2dInstance<State extends AnyObject, ParamsShape ext
  */
 export type DefinedViewEntity2dConstructor<State extends AnyObject, ParamsShape extends Shape | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = Constructor<DefinedViewEntity2dInstance<State, ParamsShape, EntityAssets>, ConstructorParameters<typeof ViewEntity2d<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>>> & StaticEntity2dParts<State, ParamsShape>;
 /**
- * Type for {@link EntitySuite2d.defineEntity}.
+ * Type for `defineEntity`.
  *
  * @category Internal
  */
@@ -173,56 +145,62 @@ export type DefinedLogicEntity2dInstance<State extends AnyObject, ParamsShape ex
  */
 export type DefinedLogicEntity2dConstructor<State extends AnyObject, ParamsShape extends Shape | undefined> = Constructor<DefinedLogicEntity2dInstance<State, ParamsShape>, ConstructorParameters<typeof BaseEntity2d<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>>> & StaticEntity2dParts<State, ParamsShape>;
 /**
- * Type for `EntitySuite.defineEntity`.
+ * Type for `defineLogicEntity`.
  *
  * @category Internal
  */
 export type DefineLogicEntity2d<State extends AnyObject> = <const ParamsShape extends Shape | undefined, const EntityAssets extends BaseEntityAssetDefinitions | undefined>(params: DefineEntity2dArgs<ParamsShape, EntityAssets>) => DefinedLogicEntity2dConstructor<NoInfer<State>, NoInfer<ParamsShape>>;
 /**
- * ========================
- *
- * # Entity Suite
+ * State for {@link createAnthaEntity2dSuite}.
  *
- * ========================
+ * @category Internal
  */
+export type AnthaEntity2dModState<State extends AnyObject = AnyObject> = {
+    entityStore: EntityStore2d<Partial<AnthaEntity2dModState<State>>>;
+    /** If true, entity updates and collision checks are skipped. */
+    disableEntityUpdate: boolean;
+    /** If true, entity renders are skipped. */
+    disableEntityRender: boolean;
+    /** If `true`, hit boxes are visually rendered for debugging purposes. */
+    showHitboxDebug: boolean;
+} & State & AnthaGraphics2dModState & AnthaAssetModState;
 /**
- * Output of {@link defineEntitySuite2d}, used to defining and creating entities.
+ * Options for {@link createAnthaEntity2dSuite}.
  *
  * @category Internal
  */
-export type EntitySuite2d<State extends AnyObject> = {
+export type AnthaEntity2dModOptions = PartialWithUndefined<EntityStore2dConstructorParams & {
+    debug: boolean;
     /**
-     * The suite's entity store constructor. Instantiate this and to add your first entities.
-     *
-     * All defined entities will also have a reference to this store so they can add additional
-     * entities by themselves.
+     * The entity update mod's trigger. If left undefined, enabled entity updates will run on
+     * every engine tick.
      */
-    EntityStore: new (params: Readonly<EntityStore2dConstructorParams>) => EntityStore2d<State>;
+    updateTrigger: ModTrigger;
     /**
-     * Define a standard entity (with a view). This is intended to be extended from your entity
-     * class.
+     * If `true`, the `updateEntitiesMod` does not update entity data and collision state.
+     *
+     * @default false
      */
-    defineEntity: DefineViewEntity2d<State>;
-    /** Define an entity that doesn't have an attached view. These are likely to be rare. */
-    defineLogicEntity: DefineLogicEntity2d<State>;
+    disableEntityUpdate: boolean;
     /**
-     * A set of entity keys used within this entity suite. This will only be populated by all
-     * classes that are defined with `defineEntity` or `defineLogicEntity` (so this will miss any
-     * not-yet-resolved dynamic imports). This will be populated even before the classes are ever
-     * instantiated.
+     * If `true`, the `updateEntitiesMod` does not update transient entity render state.
+     *
+     * @default false
      */
-    entityKeys: Set<string>;
-};
-/**
- * This is the starting point of the @game-vir/entity package. Call this to produce the function
- * needed to define new entities and the store needed to add entity instances.
- *
- * @category Main
- */
-export declare function defineEntitySuite2d<State extends AnyObject>(): EntitySuite2d<State>;
+    disableEntityRender: boolean;
+}>;
 /**
- * Converts {@link ParamsMap} to {@link ReverseParamsMap}.
+ * Creates an entity update mod and entity factories.
  *
- * @category Internal
+ * @category Pre-built Mods
  */
-export declare function reverseParamsMap(paramsMap: ParamsMap | undefined): ReverseParamsMap | undefined;
+export declare function createAnthaEntity2dSuite<ExtraState extends AnyObject>(options?: Readonly<AnthaEntity2dModOptions>): {
+    /**
+     * Updates entity data an/or transient render state, depending on the options you provided
+     * to `createAnthaEntity2dSuite`.
+     */
+    updateEntitiesMod: import("@antha/engine").AnthaMod<NoInfer<AnthaEntity2dModState<ExtraState>>>;
+    defineEntity: DefineViewEntity2d<AnthaEntity2dModState<ExtraState>>;
+    defineLogicEntity: DefineLogicEntity2d<AnthaEntity2dModState<ExtraState>>;
+    entityKeys: Set<string>;
+};

package/dist/antha-entity-2d.mod.js

@@ -0,0 +1,101 @@
+import { defineAnthaMod, SkipExecution } from '@antha/engine';
+import { assertWrap } from '@augment-vir/assert';
+import { getObjectTypedEntries, mergeDefinedProperties, } from '@augment-vir/common';
+import { html } from 'element-vir';
+import { BaseEntity2d, EntityStore2d, reverseParamsMap, ViewEntity2d, } from './entity.js';
+function ensureEntityStore({ state, options, }) {
+    if (!state.pixi?.pixiApplication || !state.assetLoader) {
+        return false;
+    }
+    if (!state.entityStore) {
+        state.entityStore = new EntityStore2d(mergeDefinedProperties({
+            pixi: state.pixi.pixiApplication,
+            state,
+            assetLoader: state.assetLoader,
+        }, options));
+    }
+    return true;
+}
+/**
+ * Creates an entity update mod and entity factories.
+ *
+ * @category Pre-built Mods
+ */
+export function createAnthaEntity2dSuite(options = {}) {
+    const entityKeys = new Set();
+    function createDefiner(entityParent) {
+        return (params) => {
+            if (params.assets) {
+                getObjectTypedEntries(params.assets).forEach(([key, rawAsset,]) => {
+                    rawAsset.assetName = [
+                        params.key,
+                        key,
+                    ].join(':');
+                });
+            }
+            return defineEntity(entityParent, params);
+        };
+    }
+    function defineEntity(entityParent, { collidesWith, key, paramsShape, paramsMap, assets }) {
+        if (entityKeys.has(key)) {
+            throw new Error(`Entity key '${key}' has already been attached to an entity class.`);
+        }
+        entityKeys.add(key);
+        const classWrapper = {
+            // @ts-expect-error: abstract methods are intentionally not implemented here
+            [key]: class extends entityParent {
+                static collidesWith = collidesWith;
+                static collidesWithSet = new Set(collidesWith?.collidesWithOtherEntities);
+                static entityKey = key;
+                static paramsShape = paramsShape;
+                static assets = assets || {};
+                static paramsMap = paramsMap;
+                static reverseParamsMap = reverseParamsMap(paramsMap);
+            },
+        };
+        return assertWrap.isDefined(classWrapper[key]);
+    }
+    const updateEntitiesMod = defineAnthaMod({
+        modName: 'antha-entity-2d-update',
+        initState: {
+            showHitboxDebug: !!options.debug,
+            disableEntityRender: !!options.disableEntityRender,
+            disableEntityUpdate: !!options.disableEntityUpdate,
+        },
+        cleanup({ state }) {
+            state.entityStore?.destroy();
+        },
+        trigger: options.updateTrigger,
+        async execute(executeParams) {
+            if (!ensureEntityStore({
+                options,
+                state: executeParams.state,
+            })) {
+                return SkipExecution;
+            }
+            else if (executeParams.state.entityStore) {
+                if (!executeParams.state.disableEntityUpdate) {
+                    await executeParams.state.entityStore.updateAllEntities(executeParams);
+                }
+                if (!executeParams.state.disableEntityRender) {
+                    await executeParams.state.entityStore.renderAllEntities(executeParams);
+                }
+            }
+            return executeParams.state.showHitboxDebug
+                ? html `
+                      <canvas class="hitbox-debug-canvas"></canvas>
+                  `
+                : undefined;
+        },
+    });
+    return {
+        /**
+         * Updates entity data an/or transient render state, depending on the options you provided
+         * to `createAnthaEntity2dSuite`.
+         */
+        updateEntitiesMod,
+        defineEntity: createDefiner(ViewEntity2d),
+        defineLogicEntity: createDefiner(BaseEntity2d),
+        entityKeys,
+    };
+}

package/dist/entity.d.ts

@@ -1,12 +1,11 @@
 import { type Asset, type AssetLoader, type AssetValue } from '@antha/asset';
 import { type ModExecuteParams } from '@antha/engine';
 import { type PixiApplication } from '@antha/graphics-2d';
-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 { ConstructorInstanceMap, type AbstractConstructor, type AnyObject, type Constructor, type EmptyObject, type ExtractKeysWithMatchingValues, type IsAny, 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 { GenericListenTarget } from 'typed-event-target';
-import { type StaticEntity2dParts } from './entity-suite.js';
 export { System as HitboxSystem, type Response as Collision } from 'detect-collisions';
 /**
  * Definition of entity assets used when defining an entity.
@@ -74,6 +73,37 @@ export type EntityStore2dConstructorParams<State extends AnyObject = any> = {
  * @category Internal
  */
 export type Entity2dConstructor = Constructor<BaseEntity2d> & StaticEntity2dParts<any, any, BaseEntityAssetDefinitions>;
+/**
+ * Static members of both view and logic entity constructors.
+ *
+ * @category Internal
+ */
+export type StaticEntity2dParts<State extends AnyObject = any, ParamsShape extends Shape | undefined = any, EntityAssets extends BaseEntityAssetDefinitions | undefined = any> = {
+    /** Entity classes this entity observes collisions with. Omit to observe none. */
+    collidesWith: EntityCollisionDefinition | undefined;
+    /** Cached entity classes this entity observes collisions with. */
+    collidesWithSet: ReadonlySet<Entity2dConstructor>;
+    /**
+     * This key is used for deserialization of entities to track which class needs to be
+     * constructed. You cannot have duplicate keys loaded at the same time.
+     *
+     * This is used instead of inferring the entity key from the class name so that you can still
+     * minify your class names without making debugging nigh impossible (you'll still know which
+     * entities are being serialized and deserialized even if your class names are minified).
+     */
+    entityKey: string;
+    /** Shape definition of this entity's parameters. */
+    paramsShape: ParamsShape;
+    /**
+     * Defines which properties from {@link BaseEntity2d.params} will be mapped to hitbox and/or view
+     * properties.
+     */
+    paramsMap: IsAny<ParamsShape> extends true ? any : ParamsMap<ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
+    /** Parses the serialized params generated by {@link BaseEntity2d.serialize}. */
+    deserialize(serialized: string | undefined): AnyObject | undefined;
+    assets: MappedEntityAssets<EntityAssets>;
+    ConstructorArgsType: Entity2dConstructorParams<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
+};
 /**
  * Defines which entity classes this entity observes collisions with.
  *
@@ -139,10 +169,10 @@ export declare class EntityStore2d<State extends AnyObject = any> {
      * Runs `.update()` on all current entities and runs collision detection for all hitboxes. If
      * any entities get marked as destroyed during their update, then they will be removed from the
      * set of entities.
-     *
-     * @returns All detected hitbox collisions (if any).
      */
     updateAllEntities(updateParams: Readonly<ModExecuteParams<NoInfer<State>>>): Promise<void>;
+    /** Runs presentation-only updates for every entity without simulating collisions. */
+    renderAllEntities(renderParams: Readonly<ModExecuteParams<NoInfer<State>>>): Promise<void>;
     /** Get all current instances of the given entity class constructor. */
     getEntities<T>(entityClassConstructor: AbstractConstructor<T> | Constructor<T>): Set<T>;
     /** Remove an entity from the store. */
@@ -299,6 +329,12 @@ export declare const position2dParamsMap: {
  * @category Internal
  */
 export type ReverseParamsMap = Record<string, Partial<Record<'hitbox' | 'view', string[]>>>;
+/**
+ * Converts {@link ParamsMap} to {@link ReverseParamsMap}.
+ *
+ * @category Internal
+ */
+export declare function reverseParamsMap(paramsMap: ParamsMap | undefined): ReverseParamsMap | undefined;
 /**
  * Base entity class, types, and functionality.
  *
@@ -357,6 +393,12 @@ export declare abstract class BaseEntity2d<State extends AnyObject = any, Params
      * entity definition classes.
      */
     abstract update(updateParams: Readonly<ModExecuteParams<NoInfer<State>>>): MaybePromise<void>;
+    /**
+     * This is meant to be used to update transient render state without changing the authoritative
+     * entity state or logic. This is optional. `updateEntitiesMod` calls it (if it exists) after
+     * each entity data update unless `disableEntityRender` is `true`.
+     */
+    render(_renderParams: Readonly<ModExecuteParams<NoInfer<State>>>): MaybePromise<void>;
     /** Called after construction to perform async initialization (e.g. creating views). */
     initInstance(): MaybePromise<void>;
     /** The game's current state. */

package/dist/entity.js

@@ -1,5 +1,5 @@
 import { assert, check } from '@augment-vir/assert';
-import { ConstructorInstanceMap, getObjectTypedEntries, makeWritable, mapObjectValues, } from '@augment-vir/common';
+import { ConstructorInstanceMap, getObjectTypedEntries, getOrSet, makeWritable, mapObjectValues, } from '@augment-vir/common';
 import { System as HitboxSystem, Response, } from 'detect-collisions';
 import { assertValidShape, defineShape } from 'object-shape-tester';
 import { ParticleContainer } from 'pixi.js';
@@ -174,8 +174,6 @@ export class EntityStore2d {
      * Runs `.update()` on all current entities and runs collision detection for all hitboxes. If
      * any entities get marked as destroyed during their update, then they will be removed from the
      * set of entities.
-     *
-     * @returns All detected hitbox collisions (if any).
      */
     async updateAllEntities(updateParams) {
         if (this.isDestroyed) {
@@ -229,6 +227,18 @@ export class EntityStore2d {
         });
         await Promise.all(collisionPromises);
     }
+    /** Runs presentation-only updates for every entity without simulating collisions. */
+    async renderAllEntities(renderParams) {
+        if (this.isDestroyed) {
+            throw new Error('Cannot operate on a destroyed entity store.');
+        }
+        for (const entity of this.currentEntityInstances) {
+            if (entity.isDestroyed) {
+                return;
+            }
+            await entity.render(renderParams);
+        }
+    }
     /** Get all current instances of the given entity class constructor. */
     getEntities(entityClassConstructor) {
         return this.entityInstanceMap.getInstances(entityClassConstructor);
@@ -361,6 +371,34 @@ export const position2dParamsMap = {
         y: true,
     },
 };
+/**
+ * Converts {@link ParamsMap} to {@link ReverseParamsMap}.
+ *
+ * @category Internal
+ */
+export function reverseParamsMap(paramsMap) {
+    if (!paramsMap) {
+        return undefined;
+    }
+    const reverseParamsMap = {};
+    getObjectTypedEntries(paramsMap).forEach(([topKey, mappings,]) => {
+        getObjectTypedEntries(mappings).forEach(([mapToKey, mapFromKey,]) => {
+            if (!mapFromKey) {
+                return;
+            }
+            const paramMapping = getOrSet(reverseParamsMap, check.isString(mapFromKey) ? mapFromKey : mapToKey, () => {
+                return {};
+            });
+            const mapToArray = getOrSet(paramMapping, topKey, () => {
+                return [];
+            });
+            if (!mapToArray.includes(mapToKey)) {
+                mapToArray.push(mapToKey);
+            }
+        });
+    });
+    return reverseParamsMap;
+}
 /**
  * Base entity class, types, and functionality.
  *
@@ -438,6 +476,13 @@ export class BaseEntity2d {
             entityAssets: assets,
         });
     }
+    /**
+     * This is meant to be used to update transient render state without changing the authoritative
+     * entity state or logic. This is optional. `updateEntitiesMod` calls it (if it exists) after
+     * each entity data update unless `disableEntityRender` is `true`.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    render(_renderParams) { }
     /** Called after construction to perform async initialization (e.g. creating views). */
     initInstance() {
         return;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export * from './antha-entity.mod.js';
-export * from './entity-suite.js';
+export * from './antha-entity-2d.mod.js';
 export * from './entity.js';
 export * from './load-antha-assets.js';

package/dist/index.js

@@ -1,4 +1,3 @@
-export * from './antha-entity.mod.js';
-export * from './entity-suite.js';
+export * from './antha-entity-2d.mod.js';
 export * from './entity.js';
 export * from './load-antha-assets.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/entity-2d",
-    "version": "0.16.0",
+    "version": "0.18.0",
     "description": "An Antha mod for handling 2D entities.",
     "keywords": [
         "vir",
@@ -39,8 +39,11 @@
         "@augment-vir/common": "^32.3.0"
     },
     "devDependencies": {
-        "@antha/engine": "^0.16.0",
-        "@antha/web-test-runner-plugin-pixi": "^0.16.0",
+        "@antha/asset": "^0.18.0",
+        "@antha/audio": "^0.18.0",
+        "@antha/engine": "^0.18.0",
+        "@antha/graphics-2d": "^0.18.0",
+        "@antha/web-test-runner-plugin-pixi": "^0.18.0",
         "@augment-vir/test": "^32.3.0",
         "@web/dev-server-esbuild": "^2.0.0",
         "@web/test-runner": "^1.0.0",
@@ -52,10 +55,10 @@
         "typed-event-target": "^4.3.3"
     },
     "peerDependencies": {
-        "@antha/asset": "^0.16.0",
-        "@antha/audio": "^0.16.0",
-        "@antha/engine": "^0.16.0",
-        "@antha/graphics-2d": "^0.16.0",
+        "@antha/asset": "^0.18.0",
+        "@antha/audio": "^0.18.0",
+        "@antha/engine": "^0.18.0",
+        "@antha/graphics-2d": "^0.18.0",
         "detect-collisions": "^10",
         "element-vir": "^27",
         "object-shape-tester": "^6",

package/dist/antha-entity.mod.d.ts

@@ -1,36 +0,0 @@
-import { type AnthaAssetModState } from '@antha/asset';
-import { type AnthaMod } from '@antha/engine';
-import { type AnthaGraphics2dModState } from '@antha/graphics-2d';
-import { type AnyObject, type PartialWithUndefined } from '@augment-vir/common';
-import { type EntityStore2d, type EntityStore2dConstructorParams } from './entity.js';
-/**
- * State for {@link createAnthaEntityMod2d}.
- *
- * @category Internal
- */
-export type AnthaEntity2dModState<State extends AnyObject = AnyObject> = {
-    entityStore: EntityStore2d<Partial<AnthaEntity2dModState<State>>>;
-    /** If true, entity updates and collision checks are skipped. */
-    disableEntityUpdates: boolean;
-    /** If `true`, hit boxes are visually rendered for debugging purposes. */
-    debugHitboxes: boolean;
-} & State & AnthaGraphics2dModState & AnthaAssetModState;
-/**
- * Options for {@link createAnthaEntityMod2d}.
- *
- * @category Internal
- */
-export type AnthaEntity2dModOptions = PartialWithUndefined<EntityStore2dConstructorParams & {
-    debug: boolean;
-}>;
-/**
- * A mod for rendering entities and handling collisions between them.
- *
- * @category Pre-built Mods
- */
-export declare function createAnthaEntityMod2d<ExtraState extends AnyObject>(options?: Readonly<AnthaEntity2dModOptions>): {
-    defineEntity: import("./entity-suite.js").DefineViewEntity2d<AnthaEntity2dModState<ExtraState>>;
-    defineLogicEntity: import("./entity-suite.js").DefineLogicEntity2d<AnthaEntity2dModState<ExtraState>>;
-    entityKeys: Set<string>;
-    mod: AnthaMod<AnthaEntity2dModState<ExtraState>>;
-};

package/dist/antha-entity.mod.js

@@ -1,60 +0,0 @@
-import { anthaAssetModName, AssetLoader } from '@antha/asset';
-import { defineAnthaMod, SkipExecution } from '@antha/engine';
-import { mergeDefinedProperties, } from '@augment-vir/common';
-import { html } from 'element-vir';
-import { defineEntitySuite2d } from './entity-suite.js';
-/**
- * A mod for rendering entities and handling collisions between them.
- *
- * @category Pre-built Mods
- */
-export function createAnthaEntityMod2d(options = {}) {
-    const { EntityStore, ...entitySuite } = defineEntitySuite2d();
-    const mod = defineAnthaMod({
-        modName: 'antha-entity-2d',
-        initState: {
-            debugHitboxes: !!options.debug,
-        },
-        cleanup({ state }) {
-            state.entityStore?.destroy();
-        },
-        async execute(executeParams) {
-            /**
-             * If we don't have a mod that is expected to create the asset loader, then we create
-             * one ourself.
-             */
-            if (!executeParams.state.assetLoader &&
-                !executeParams.engine.currentMods.some((mod) => mod.modName === anthaAssetModName)) {
-                executeParams.state.assetLoader = new AssetLoader();
-            }
-            const pixiApplication = executeParams.state.pixi?.pixiApplication;
-            if (!pixiApplication) {
-                return SkipExecution;
-            }
-            if (executeParams.state.entityStore) {
-                if (!executeParams.state.disableEntityUpdates) {
-                    await executeParams.state.entityStore.updateAllEntities(executeParams);
-                }
-            }
-            else if (executeParams.state.assetLoader) {
-                executeParams.state.entityStore = new EntityStore(mergeDefinedProperties({
-                    pixi: pixiApplication,
-                    state: executeParams.state,
-                    assetLoader: executeParams.state.assetLoader,
-                }, options));
-            }
-            if (executeParams.state.debugHitboxes) {
-                return html `
-                    <canvas class="hitbox-debug-canvas"></canvas>
-                `;
-            }
-            else {
-                return undefined;
-            }
-        },
-    });
-    return {
-        mod,
-        ...entitySuite,
-    };
-}

package/dist/entity-suite.js

@@ -1,79 +0,0 @@
-import { check } from '@augment-vir/assert';
-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
- * needed to define new entities and the store needed to add entity instances.
- *
- * @category Main
- */
-export function defineEntitySuite2d() {
-    const entityKeys = new Set();
-    function createDefiner(entityParent) {
-        return (params) => {
-            if (params.assets) {
-                getObjectTypedEntries(params.assets).forEach(([key, rawAsset,]) => {
-                    rawAsset.assetName = [
-                        params.key,
-                        key,
-                    ].join(':');
-                });
-            }
-            return defineEntity(entityParent, params);
-        };
-    }
-    function defineEntity(entityParent, { collidesWith, key, paramsShape, paramsMap, assets }) {
-        if (entityKeys.has(key)) {
-            throw new Error(`Entity key '${key}' has already been attached to an entity class.`);
-        }
-        entityKeys.add(key);
-        const classWrapper = {
-            // @ts-expect-error: abstract methods are intentionally not implemented here
-            [key]: class extends entityParent {
-                static collidesWith = collidesWith;
-                static collidesWithSet = new Set(collidesWith?.collidesWithOtherEntities);
-                static entityKey = key;
-                static paramsShape = paramsShape;
-                static assets = assets || {};
-                static paramsMap = paramsMap;
-                static reverseParamsMap = reverseParamsMap(paramsMap);
-            },
-        };
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return classWrapper[key];
-    }
-    return {
-        EntityStore: EntityStore2d,
-        defineEntity: createDefiner(ViewEntity2d),
-        defineLogicEntity: createDefiner(BaseEntity2d),
-        entityKeys,
-    };
-}
-/**
- * Converts {@link ParamsMap} to {@link ReverseParamsMap}.
- *
- * @category Internal
- */
-export function reverseParamsMap(paramsMap) {
-    if (!paramsMap) {
-        return undefined;
-    }
-    const reverseParamsMap = {};
-    getObjectTypedEntries(paramsMap).forEach(([topKey, mappings,]) => {
-        getObjectTypedEntries(mappings).forEach(([mapToKey, mapFromKey,]) => {
-            if (!mapFromKey) {
-                return;
-            }
-            const paramMapping = getOrSet(reverseParamsMap, check.isString(mapFromKey) ? mapFromKey : mapToKey, () => {
-                return {};
-            });
-            const mapToArray = getOrSet(paramMapping, topKey, () => {
-                return [];
-            });
-            if (!mapToArray.includes(mapToKey)) {
-                mapToArray.push(mapToKey);
-            }
-        });
-    });
-    return reverseParamsMap;
-}