@antha/entity-2d 0.6.1 → 0.7.0

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

@@ -9,6 +9,8 @@ import { type EntityStore2d, type EntityStore2dConstructorParams } from './entit
  */
 export type AnthaEntity2dModState<State extends AnyObject = any> = {
     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;

package/dist/antha-entity.mod.js

@@ -32,9 +32,11 @@ export function createAnthaEntityMod2d(options = {}) {
                 return SkipExecution;
             }
             if (state.entityStore) {
-                await state.entityStore.updateAllEntities({
-                    msSinceLastUpdate: msSinceLastExecute,
-                });
+                if (!state.disableEntityUpdates) {
+                    await state.entityStore.updateAllEntities({
+                        msSinceLastUpdate: msSinceLastExecute,
+                    });
+                }
             }
             else if (state.assetLoader) {
                 state.entityStore = new EntityStore(mergeDefinedProperties({

package/dist/entity.d.ts

@@ -1,4 +1,4 @@
-import { type Asset, type AssetBulkLoaderLoadOptions, type AssetLoader, type AssetValue } from '@antha/asset';
+import { type Asset, type AssetLoader, type AssetValue } from '@antha/asset';
 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';
@@ -84,12 +84,6 @@ export type EntityCollisionDefinition = PartialWithUndefined<{
     /** Other entity classes this entity observes collisions with. */
     collidesWithOtherEntities: ReadonlyArray<Entity2dConstructor>;
 }>;
-/** Loads assets declared by the given entity classes. */
-export declare function loadEntityAssets({ assetLoader, entities, otherAssets, }: Readonly<{
-    assetLoader: AssetLoader;
-    entities: ReadonlyArray<Entity2dConstructor>;
-    otherAssets?: ReadonlyArray<Readonly<Asset>> | undefined;
-}>, options?: Readonly<AssetBulkLoaderLoadOptions> | undefined): Promise<readonly unknown[]>;
 /** A collision system that skips pairs no entity observes before running SAT collision checks. */
 export declare class EntityHitboxSystem extends HitboxSystem {
     protected checkedHitboxPairs: WeakMap<Hitbox, WeakSet<Hitbox>> | undefined;
@@ -161,7 +155,7 @@ export declare class EntityStore2d<State extends AnyObject = any> {
 /**
  * Shape definition for {@link EntityPositionParams}.
  *
- * @category Util
+ * @category Main
  */
 export declare const entityPositionParamsShape: Shape<{
     x: number;

package/dist/entity.js

@@ -1,20 +1,10 @@
 import { assert, check } from '@augment-vir/assert';
-import { ConstructorInstanceMap, getObjectTypedEntries, getObjectTypedValues, makeWritable, mapObjectValues, } from '@augment-vir/common';
+import { ConstructorInstanceMap, getObjectTypedEntries, 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';
 import { defineTypedCustomEvent, GenericListenTarget } from 'typed-event-target';
 export { System as HitboxSystem } from 'detect-collisions';
-/** Loads assets declared by the given entity classes. */
-export async function loadEntityAssets({ assetLoader, entities, otherAssets, }, options) {
-    const assets = [
-        ...(otherAssets || []),
-        ...entities.flatMap((entity) => {
-            return getObjectTypedValues(entity.assets);
-        }),
-    ];
-    return await assetLoader.bulkLoadAssets(assets, options);
-}
 function extractEntityFromHitbox(hitbox) {
     return hitbox.userData instanceof BaseEntity2d ? hitbox.userData : undefined;
 }
@@ -306,7 +296,7 @@ export class EntityStore2d {
 /**
  * Shape definition for {@link EntityPositionParams}.
  *
- * @category Util
+ * @category Main
  */
 export const entityPositionParamsShape = defineShape({
     x: -1,

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/load-antha-assets.d.ts

@@ -0,0 +1,31 @@
+import { type Asset, type AssetBulkLoaderLoadOptions, type AssetLoader } from '@antha/asset';
+import { type AudioPlayer, type AudioSetupParams } from '@antha/audio';
+import { type PartialWithUndefined } from '@augment-vir/common';
+import { type Entity2dConstructor } from './entity.js';
+/** Audio files and their player to include in {@link loadAnthaAssets}. */
+export type AnthaAudioFilesToLoad = {
+    audioPlayer: Pick<AudioPlayer, 'loadFiles'>;
+    files: ReadonlyArray<Readonly<AudioSetupParams>>;
+} & PartialWithUndefined<{
+    /** Label shown for this audio load on the loading screen. */
+    assetName: string;
+    /** Whether audio files should load sequentially. */
+    serial: boolean;
+}>;
+/** Inputs for {@link loadAnthaAssets}. */
+export type LoadAnthaAssetsParams = {
+    assetLoader: AssetLoader;
+} & PartialWithUndefined<{
+    /** Assets declared by these entity classes are loaded. */
+    entities: ReadonlyArray<Entity2dConstructor>;
+    /** Audio files to load through their audio player. */
+    audio: AnthaAudioFilesToLoad;
+    /** Additional assets to load. */
+    assets: ReadonlyArray<Readonly<Asset>>;
+}>;
+/**
+ * Loads assets declared by entities, audio files, and any additional assets in one load session.
+ *
+ * @category Main
+ */
+export declare function loadAnthaAssets({ assetLoader, assets, audio, entities }: Readonly<LoadAnthaAssetsParams>, options?: Readonly<AssetBulkLoaderLoadOptions> | undefined): Promise<readonly unknown[]>;

package/dist/load-antha-assets.js

@@ -0,0 +1,37 @@
+import { defineAsset, } from '@antha/asset';
+import { getObjectTypedValues } from '@augment-vir/common';
+function createAudioLoadAsset({ assetName = 'Audio files', audioPlayer, files, serial, }) {
+    return defineAsset({
+        assetName,
+        maxProgress: files.length,
+        async load({ incrementProgressCallback }) {
+            await audioPlayer.loadFiles(files, {
+                progressCallback() {
+                    incrementProgressCallback();
+                },
+                serial: !!serial,
+            });
+            return {
+                value: undefined,
+            };
+        },
+    });
+}
+/**
+ * Loads assets declared by entities, audio files, and any additional assets in one load session.
+ *
+ * @category Main
+ */
+export async function loadAnthaAssets({ assetLoader, assets, audio, entities }, options) {
+    return await assetLoader.bulkLoadAssets([
+        ...(audio
+            ? [
+                createAudioLoadAsset(audio),
+            ]
+            : []),
+        ...(assets || []),
+        ...(entities || []).flatMap((entity) => {
+            return getObjectTypedValues(entity.assets);
+        }),
+    ], options);
+}

package/package.json

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