@antha/entity-2d 0.0.1

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 electrovir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @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
+
+## Install
+
+```sh
+npm i @antha/entity-2d
+```

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

@@ -0,0 +1,33 @@
+import { type AnthaAssetModState } from '@antha/asset';
+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 = any> = {
+    entityStore: EntityStore2d<Partial<AnthaEntity2dModState<State>>>;
+    /** 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: import("@antha/engine").AnthaMod<any>;
+};

package/dist/antha-entity.mod.js

@@ -0,0 +1,60 @@
+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({ state, engine, msSinceLastExecute }) {
+            /**
+             * 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();
+            }
+            const pixiApplication = state.pixi?.pixiApplication;
+            if (!pixiApplication) {
+                return SkipExecution;
+            }
+            if (state.entityStore) {
+                await state.entityStore.updateAllEntities({
+                    msSinceLastUpdate: msSinceLastExecute,
+                });
+            }
+            else if (state.assetLoader) {
+                state.entityStore = new EntityStore(mergeDefinedProperties({
+                    pixi: pixiApplication,
+                    state,
+                    assetLoader: state.assetLoader,
+                }, options));
+            }
+            if (state.debugHitboxes) {
+                return html `
+                    <canvas class="hitbox-debug-canvas"></canvas>
+                `;
+            }
+            else {
+                return undefined;
+            }
+        },
+    });
+    return {
+        mod,
+        ...entitySuite,
+    };
+}

package/dist/entity-suite.d.ts

@@ -0,0 +1,223 @@
+import { type AnyObject } 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}.
+ *
+ * @category Internal
+ */
+export type DefineEntity2dArgs<ParamsShape extends Shape<AnyObject> | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = {
+    /**
+     * This key is used for deserialization of entities to track which class needs to be
+     * constructed. Do not use duplicate key strings across multiple entity classes.
+     */
+    key: string;
+    /**
+     * This should contain all parameters necessary to reconstruct this entity from scratch so it
+     * can be serialized, sent across the network in JSON format, then reconstructed on another
+     * device (for multiplayer support).
+     *
+     * Make sure to include {@link entityPositionParamsShape} as part of the shape if you want to
+     * include entity position parameters.
+     */
+    paramsShape?: ParamsShape;
+    /**
+     * A mapping of the entity's params object (defined by {@link DefineEntity2dArgs.paramsShape})
+     * keys to hitbox and/or view properties.
+     *
+     * Use `standardParamsMap` to automatically map the params `x` and `y` in `paramsShape` to both
+     * the entity's hitbox x/y and the entity's view x/y.
+     *
+     * @example
+     *
+     * ```ts
+     * const customMapping = {
+     *     paramsShape: defineShape({
+     *         left: -1,
+     *         top: -1,
+     *     }),
+     *     paramsMap: {
+     *         hitbox: {
+     *             x: 'left', // maps `left` from `paramsShape` to the entity's hitbox.x
+     *             y: 'top', // maps `top` from `paramsShape` to the entity's hitbox.y
+     *         },
+     *         view: {
+     *             x: 'left', // maps `left` from `paramsShape` to the entity's view.x
+     *             y: 'top', // maps `top` from `paramsShape` to the entity's view.y
+     *         },
+     *     },
+     * };
+     * ```
+     *
+     * @example
+     *
+     * ```ts
+     * const standardMapping = {
+     *     paramsShape: defineShape({
+     *         left: -1,
+     *         top: -1,
+     *     }),
+     *     paramsMap: standardParamsMap, // use the standard x/y mapping
+     * };
+     * ```
+     *
+     * @example
+     *
+     * ```ts
+     * const undefinedMapping = {
+     *     paramsShape: defineShape({
+     *         left: -1,
+     *         top: -1,
+     *     }),
+     *     paramsMap: undefined, // no mapping at all
+     * };
+     * ```
+     *
+     * @example
+     *
+     * ```ts
+     * const omittedMapping = {
+     *     paramsShape: defineShape({
+     *         left: -1,
+     *         top: -1,
+     *     }),
+     *     // no mapping at all
+     * };
+     * ```
+     *
+     * @default undefined // no mapping
+     */
+    paramsMap?: ParamsMap<NoInfer<ParamsShape> extends Shape<AnyObject> ? 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<AnyObject> | undefined = any, EntityAssets extends BaseEntityAssetDefinitions | undefined = any> = {
+    /**
+     * 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<AnyObject> ? 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>;
+};
+/**
+ * ========================
+ *
+ * # View Entity
+ *
+ * Types for entity definitions that have a view.
+ *
+ * ========================
+ */
+/**
+ * The constructor output of {@link DefinedViewEntity2dConstructor}.
+ *
+ * @category Internal
+ */
+export type DefinedViewEntity2dInstance<State extends AnyObject, ParamsShape extends Shape<Record<string, any>> | undefined, EntityAssets extends BaseEntityAssetDefinitions | undefined> = ViewEntity2d<State, ParamsShape extends Shape ? ParamsShape['runtimeType'] : undefined, EntityAssets>;
+/**
+ * Output of {@link DefineViewEntity2d}.
+ *
+ * @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>;
+/**
+ * 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>>;
+/**
+ * ========================
+ *
+ * # Logic Entity
+ *
+ * Types for entity definitions that don't have a view. The only difference between these types and
+ * the view types are that this uses `BaseEntity2d` instead of `ViewEntity2d`.
+ *
+ * ========================
+ */
+/**
+ * The constructor output of {@link DefinedLogicEntity2dConstructor}.
+ *
+ * @category Internal
+ */
+export type DefinedLogicEntity2dInstance<State extends AnyObject, ParamsShape extends Shape<AnyObject> | undefined> = BaseEntity2d<State, ParamsShape extends Shape<AnyObject> ? 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>;
+/**
+ * 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>>;
+/**
+ * ========================
+ *
+ * # Entity Suite
+ *
+ * ========================
+ */
+/**
+ * Output of {@link defineEntitySuite2d}, used to defining and creating entities.
+ *
+ * @category Internal
+ */
+export type EntitySuite2d<State extends AnyObject> = {
+    /**
+     * 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.
+     */
+    EntityStore: new (params: Readonly<EntityStore2dConstructorParams>) => EntityStore2d<State>;
+    /**
+     * Define a standard entity (with a view). This is intended to be extended from your entity
+     * class.
+     */
+    defineEntity: DefineViewEntity2d<State>;
+    /** Define an entity that doesn't have an attached view. These are likely to be rare. */
+    defineLogicEntity: DefineLogicEntity2d<State>;
+    /**
+     * 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.
+     */
+    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>;
+/**
+ * Converts {@link ParamsMap} to {@link ReverseParamsMap}.
+ *
+ * @category Internal
+ */
+export declare function reverseParamsMap(paramsMap: ParamsMap | undefined): ReverseParamsMap | undefined;

package/dist/entity-suite.js

@@ -0,0 +1,77 @@
+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.name = [
+                        params.key,
+                        key,
+                    ].join(':');
+                });
+            }
+            return defineEntity(entityParent, params);
+        };
+    }
+    function defineEntity(entityParent, { 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 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;
+}