@antha/entity-2d 0.12.0 → 0.14.0

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

@@ -1,4 +1,5 @@
 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';
@@ -7,7 +8,7 @@ import { type EntityStore2d, type EntityStore2dConstructorParams } from './entit
  *
  * @category Internal
  */
-export type AnthaEntity2dModState<State extends AnyObject = any> = {
+export type AnthaEntity2dModState<State extends AnyObject = AnyObject> = {
     entityStore: EntityStore2d<Partial<AnthaEntity2dModState<State>>>;
     /** If true, entity updates and collision checks are skipped. */
     disableEntityUpdates: boolean;
@@ -31,5 +32,5 @@ export declare function createAnthaEntityMod2d<ExtraState extends AnyObject>(opt
     defineEntity: import("./entity-suite.js").DefineViewEntity2d<AnthaEntity2dModState<ExtraState>>;
     defineLogicEntity: import("./entity-suite.js").DefineLogicEntity2d<AnthaEntity2dModState<ExtraState>>;
     entityKeys: Set<string>;
-    mod: import("@antha/engine").AnthaMod<any>;
+    mod: AnthaMod<AnthaEntity2dModState<ExtraState>>;
 };

package/dist/antha-entity.mod.js

@@ -18,34 +18,32 @@ export function createAnthaEntityMod2d(options = {}) {
         cleanup({ state }) {
             state.entityStore?.destroy();
         },
-        async execute({ state, engine, msSinceLastExecute }) {
+        async execute(executeParams) {
             /**
              * If we don't have a mod that is expected to create the asset loader, then we create
              * one ourself.
              */
-            if (!state.assetLoader &&
-                !engine.currentMods.some((mod) => mod.modName === anthaAssetModName)) {
-                state.assetLoader = new AssetLoader();
+            if (!executeParams.state.assetLoader &&
+                !executeParams.engine.currentMods.some((mod) => mod.modName === anthaAssetModName)) {
+                executeParams.state.assetLoader = new AssetLoader();
             }
-            const pixiApplication = state.pixi?.pixiApplication;
+            const pixiApplication = executeParams.state.pixi?.pixiApplication;
             if (!pixiApplication) {
                 return SkipExecution;
             }
-            if (state.entityStore) {
-                if (!state.disableEntityUpdates) {
-                    await state.entityStore.updateAllEntities({
-                        msSinceLastUpdate: msSinceLastExecute,
-                    });
+            if (executeParams.state.entityStore) {
+                if (!executeParams.state.disableEntityUpdates) {
+                    await executeParams.state.entityStore.updateAllEntities(executeParams);
                 }
             }
-            else if (state.assetLoader) {
-                state.entityStore = new EntityStore(mergeDefinedProperties({
+            else if (executeParams.state.assetLoader) {
+                executeParams.state.entityStore = new EntityStore(mergeDefinedProperties({
                     pixi: pixiApplication,
-                    state,
-                    assetLoader: state.assetLoader,
+                    state: executeParams.state,
+                    assetLoader: executeParams.state.assetLoader,
                 }, options));
             }
-            if (state.debugHitboxes) {
+            if (executeParams.state.debugHitboxes) {
                 return html `
                     <canvas class="hitbox-debug-canvas"></canvas>
                 `;

package/dist/entity-suite.d.ts

@@ -6,7 +6,7 @@ import { BaseEntity2d, type BaseEntityAssetDefinitions, type Entity2dConstructor
  *
  * @category Internal
  */
-export type DefineEntity2dArgs<ParamsShape extends Shape<AnyObject> | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = {
+export type DefineEntity2dArgs<ParamsShape extends Shape | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = {
     /** Entity classes this entity observes collisions with. Omit to observe none. */
     collidesWith?: EntityCollisionDefinition | undefined;
     /**
@@ -89,7 +89,7 @@ export type DefineEntity2dArgs<ParamsShape extends Shape<AnyObject> | undefined,
      *
      * @default undefined // no mapping
      */
-    paramsMap?: ParamsMap<NoInfer<ParamsShape> extends Shape<AnyObject> ? NoInfer<ParamsShape>['runtimeType'] : undefined> | undefined;
+    paramsMap?: ParamsMap<NoInfer<ParamsShape> extends Shape ? NoInfer<ParamsShape>['runtimeType'] : undefined> | undefined;
     assets?: EntityAssets;
 };
 /**
@@ -97,7 +97,7 @@ export type DefineEntity2dArgs<ParamsShape extends Shape<AnyObject> | undefined,
  *
  * @category Internal
  */
-export type StaticEntity2dParts<State extends AnyObject = any, ParamsShape extends Shape<AnyObject> | undefined = any, EntityAssets extends BaseEntityAssetDefinitions | undefined = any> = {
+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. */
@@ -117,11 +117,11 @@ export type StaticEntity2dParts<State extends AnyObject = any, ParamsShape exten
      * 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<AnyObject> ? ParamsShape['runtimeType'] : undefined>;
+    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<AnyObject> ? ParamsShape['runtimeType'] : undefined>;
+    ConstructorArgsType: Entity2dConstructorParams<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
 };
 /**
  * ========================
@@ -143,13 +143,13 @@ export type DefinedViewEntity2dInstance<State extends AnyObject, ParamsShape ext
  *
  * @category Internal
  */
-export type DefinedViewEntity2dConstructor<State extends AnyObject, ParamsShape extends Shape<AnyObject> | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = Constructor<DefinedViewEntity2dInstance<State, ParamsShape, EntityAssets>, ConstructorParameters<typeof ViewEntity2d<State, ParamsShape extends Shape<AnyObject> ? ParamsShape['runtimeType'] : undefined>>> & StaticEntity2dParts<State, ParamsShape>;
+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}.
  *
  * @category Internal
  */
-export type DefineViewEntity2d<State extends AnyObject> = <const ParamsShape extends Shape<AnyObject> | undefined, const EntityAssets extends BaseEntityAssetDefinitions | undefined>(params: DefineEntity2dArgs<ParamsShape, EntityAssets>) => DefinedViewEntity2dConstructor<State, NoInfer<ParamsShape>, NoInfer<EntityAssets>> & StaticEntity2dParts<NoInfer<State>, NoInfer<ParamsShape>>;
+export type DefineViewEntity2d<State extends AnyObject> = <const ParamsShape extends Shape | undefined, const EntityAssets extends BaseEntityAssetDefinitions | undefined>(params: DefineEntity2dArgs<ParamsShape, EntityAssets>) => DefinedViewEntity2dConstructor<State, NoInfer<ParamsShape>, NoInfer<EntityAssets>> & StaticEntity2dParts<NoInfer<State>, NoInfer<ParamsShape>>;
 /**
  * ========================
  *
@@ -165,19 +165,19 @@ export type DefineViewEntity2d<State extends AnyObject> = <const ParamsShape ext
  *
  * @category Internal
  */
-export type DefinedLogicEntity2dInstance<State extends AnyObject, ParamsShape extends Shape<AnyObject> | undefined> = BaseEntity2d<State, ParamsShape extends Shape<AnyObject> ? ParamsShape['runtimeType'] : undefined>;
+export type DefinedLogicEntity2dInstance<State extends AnyObject, ParamsShape extends Shape | undefined> = BaseEntity2d<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined>;
 /**
  * Output of {@link DefineLogicEntity2d}.
  *
  * @category Internal
  */
-export type DefinedLogicEntity2dConstructor<State extends AnyObject, ParamsShape extends Shape<AnyObject> | undefined> = Constructor<DefinedLogicEntity2dInstance<State, ParamsShape>, ConstructorParameters<typeof BaseEntity2d<State, ParamsShape extends Shape<AnyObject> ? ParamsShape['runtimeType'] : undefined>>> & StaticEntity2dParts<State, ParamsShape>;
+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`.
  *
  * @category Internal
  */
-export type DefineLogicEntity2d<State extends AnyObject> = <const ParamsShape extends Shape<AnyObject> | undefined, const EntityAssets extends BaseEntityAssetDefinitions | undefined>(params: DefineEntity2dArgs<ParamsShape, EntityAssets>) => DefinedLogicEntity2dConstructor<NoInfer<State>, NoInfer<ParamsShape>>;
+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>>;
 /**
  * ========================
  *

package/dist/entity.d.ts

@@ -1,4 +1,5 @@
 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 { System as HitboxSystem, type Response as Collision, type Body as Hitbox } from 'detect-collisions';
@@ -141,7 +142,7 @@ export declare class EntityStore2d<State extends AnyObject = any> {
      *
      * @returns All detected hitbox collisions (if any).
      */
-    updateAllEntities(updateParams: Readonly<EntityUpdateParams>): Promise<void>;
+    updateAllEntities(updateParams: 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. */
@@ -153,6 +154,8 @@ export declare class EntityStore2d<State extends AnyObject = any> {
     deserializeEntity(entityKey: string, serializedParams: string | undefined): Promise<BaseEntity2d>;
     /** Create a new instance of the given entity class and add it to this entity store. */
     addEntity<const NewEntityConstructor extends Entity2dConstructor>(entityClass: NewEntityConstructor, ...params: AddEntity2dParams<NoInfer<NewEntityConstructor>>): Promise<InstanceType<NewEntityConstructor>>;
+    /** Immediately destroys every current entity while leaving the entity store usable. */
+    destroyAllEntities(): void;
     /** Destroys the entity store and all entities contained inside it. */
     destroy(): void;
 }
@@ -296,14 +299,6 @@ export declare const position2dParamsMap: {
  * @category Internal
  */
 export type ReverseParamsMap = Record<string, Partial<Record<'hitbox' | 'view', string[]>>>;
-/**
- * The parameters given to entity update methods.
- *
- * @category Internal
- */
-export type EntityUpdateParams = {
-    msSinceLastUpdate: number;
-};
 /**
  * Base entity class, types, and functionality.
  *
@@ -320,7 +315,7 @@ export declare abstract class BaseEntity2d<State extends AnyObject = any, Params
     /** Cached entity classes this entity observes collisions with. */
     static readonly collidesWithSet: ReadonlySet<Entity2dConstructor>;
     /** Shape definition of this entity's parameters. */
-    static readonly paramsShape: Shape<AnyObject> | undefined;
+    static readonly paramsShape: Shape | undefined;
     static readonly assets: MappedEntityAssets<BaseEntityAssetDefinitions | undefined> | undefined;
     /**
      * Defines which properties from {@link BaseEntity2d.params} will be mapped to hitbox and/or view
@@ -361,7 +356,7 @@ export declare abstract class BaseEntity2d<State extends AnyObject = any, Params
      * Called every game tick. Run all entity updates in here. This should be overridden in all
      * entity definition classes.
      */
-    abstract update(updateParams: Readonly<EntityUpdateParams>): MaybePromise<void>;
+    abstract update(updateParams: 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

@@ -282,6 +282,13 @@ export class EntityStore2d {
         this.entityInstanceMap.add(child);
         return child;
     }
+    /** Immediately destroys every current entity while leaving the entity store usable. */
+    destroyAllEntities() {
+        if (this.isDestroyed) {
+            throw new Error('Cannot operate on a destroyed entity store.');
+        }
+        this.currentEntityInstances.forEach((entity) => entity.immediatelyDestroy());
+    }
     /** Destroys the entity store and all entities contained inside it. */
     destroy() {
         if (this.isDestroyed) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/entity-2d",
-    "version": "0.12.0",
+    "version": "0.14.0",
     "description": "An Antha mod for handling 2D entities.",
     "keywords": [
         "vir",
@@ -35,13 +35,13 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^32.2.3",
-        "@augment-vir/common": "^32.2.3"
+        "@augment-vir/assert": "^32.2.4",
+        "@augment-vir/common": "^32.2.4"
     },
     "devDependencies": {
-        "@antha/engine": "^0.12.0",
-        "@antha/web-test-runner-plugin-pixi": "^0.12.0",
-        "@augment-vir/test": "^32.2.3",
+        "@antha/engine": "^0.14.0",
+        "@antha/web-test-runner-plugin-pixi": "^0.14.0",
+        "@augment-vir/test": "^32.2.4",
         "@web/dev-server-esbuild": "^2.0.0",
         "@web/test-runner": "^1.0.0",
         "@web/test-runner-playwright": "^1.0.0",
@@ -52,10 +52,10 @@
         "typed-event-target": "^4.3.3"
     },
     "peerDependencies": {
-        "@antha/asset": "^0.12.0",
-        "@antha/audio": "^0.12.0",
-        "@antha/engine": "^0.12.0",
-        "@antha/graphics-2d": "^0.12.0",
+        "@antha/asset": "^0.14.0",
+        "@antha/audio": "^0.14.0",
+        "@antha/engine": "^0.14.0",
+        "@antha/graphics-2d": "^0.14.0",
         "detect-collisions": ">=10",
         "element-vir": ">=26",
         "object-shape-tester": ">=6",