@adatechnology/game-crowd-three 0.3.8 → 0.4.0

package/dist/index.d.ts

@@ -1,301 +1,22 @@
-import { InstancePose } from '@adatechnology/game-characters';
-import { CrowdStore, Corpse, Civilian, Crowd, CrowdType, Herd, Flock, CrowdPack, InfectionModelLike } from '@adatechnology/game-crowd';
-import { BodyVariant, BakeBuilders, BakeSpec, Three } from '@adatechnology/game-characters-three';
-import * as THREE_NS from 'three';
+import { C as CrowdInstance, V as VariantSize } from './testing-sTAa84Ib.js';
+export { A as AnimalDrawer, a as CROWD_AREA_ID, b as CROWD_EFFECTS, c as CROWD_RENDER_DEFAULTS, d as CrowdBenchSpecies, e as CrowdBenchText, f as CrowdEffectMap, g as CrowdFrame, h as CrowdInstanceSink, i as CrowdInstances, j as CrowdInstancesOptions, k as CrowdPoseMap, l as CrowdRenderNumbers, m as CrowdRenderer, n as CrowdRendererOptions, o as CrowdRendererVariety, p as CrowdScenarioLike, q as CrowdTestModule, r as CrowdTestModuleOptions, s as CrowdVarietyNumbers, D as DrawnAnimal, H as HerdView, t as HerdViewOptions, P as PlainCorpseSink, u as VARIETY_DEFAULTS, v as createCrowdInstances, w as createCrowdRenderer, x as createCrowdTestModule, y as createHerdView, z as crowdBenchTextOf, B as lookOfAgent } from './testing-sTAa84Ib.js';
 import { SoundBank } from '@adatechnology/game-audio';
-import { TestableModule } from '@adatechnology/game-contracts';
-import { Player } from '@adatechnology/game-player';
+import '@adatechnology/game-crowd';
+import '@adatechnology/game-characters-three';
+import '@adatechnology/game-contracts';
+import '@adatechnology/game-player';
+import 'three';
+import '@adatechnology/game-characters';
 
-var numbers = {
-	lodDistances: [
-		18,
-		55
-	],
-	lodHysteresis: 1.5,
-	behindFrom: 30,
-	behindFactor: 0.35,
-	behindMargin: 3,
-	farCull: 200,
-	gaitMax: 1.4,
-	attackEnter: 2.56,
-	attackLeave: 4.84,
-	swell: 0.9,
-	swellPivot: 0.5,
-	ageBase: 0.75,
-	agePer: 0.08,
-	armBase: 1,
-	armPer: 0.4,
-	corpseNear: 18,
-	corpseFade: 60,
-	corpseDarken: 0.7,
-	corpseRise: 1.8,
-	corpseAgeBase: 0.8,
-	corpseAgeDark: 0.2,
-	childHeight: 0.66,
-	childBuild: 0.75,
-	bittenLook: 0.3,
-	civilianSkinStep: 0.25,
-	civilianBake: 0.8,
-	civilianBatch: 4
-};
-var poses = {
-	dormant: "fallen",
-	airborne: "leap",
-	eating: "eat",
-	pileStep: "attack",
-	swing: "scream",
-	crawl: "crawl",
-	grab: "attack",
-	calling: "scream",
-	"default": "walk",
-	corpse: "fallen",
-	civilian: "walk"
-};
-var defaults = {
-	numbers: numbers,
-	poses: poses
-};
-
-type CrowdRenderNumbers = typeof defaults.numbers;
-type CrowdPoseMap = {
-    readonly [K in keyof typeof defaults.poses]: InstancePose;
-};
-/** The game's numbers for the drawing (G 67098 `hordeRender`, G 70177 `npcRender`) and the instance pose of each state. */
-declare const CROWD_RENDER_DEFAULTS: {
-    readonly sources: Readonly<Record<string, string>>;
-    readonly numbers: CrowdRenderNumbers;
-    readonly poses: CrowdPoseMap;
-};
-/**
- * One body for a batch: the 12 numbers of the shader's `iA`, `iB` and `iC` (`a`: x, z, yaw, phase; `b`: height and build over the variant's,
- * stride, pose; `c`: missing parts, age look, arms, skin), the shirt colour as hex with the shade it is multiplied by, the eye colour (none:
- * no glow) and the ground height.
- */
-type CrowdInstance = {
-    readonly a: readonly [number, number, number, number];
-    readonly b: readonly [number, number, number, number];
-    readonly c: readonly [number, number, number, number];
-    readonly color: number;
-    readonly shade: number;
-    readonly eye: number | null;
-    readonly y: number;
-};
-/** A baked variant as the drawing reads it: its own height and build (the instance scales the agent's against them). */
-type VariantSize = {
-    readonly s: number;
-    readonly bulk: number;
-};
-/** Where the frame is seen from. `target` is who the agents attack (the attack pose); `hidden` leaves an agent out (a floor the viewer is not on). */
-type CrowdFrame = {
-    readonly camera: {
-        readonly x: number;
-        readonly z: number;
-    };
-    /** The view's yaw: forward is `(-sin, -cos)`. */
-    readonly viewYaw: number;
-    readonly target?: {
-        readonly x: number;
-        readonly z: number;
-        readonly alive: boolean;
-    } | null;
-    readonly hidden?: (i: number) => boolean;
-};
-/** Takes one instance for the batch of `variant` at level `level` (0 near, 1 middle, 2 far). */
-type CrowdInstanceSink = (variant: number, level: number, instance: CrowdInstance) => void;
-/** Takes one body on the ground that was not an agent (a civilian killed outright): the plain body batch. */
-type PlainCorpseSink = (instance: CrowdInstance) => void;
-type CrowdInstancesOptions = {
-    readonly numbers?: Partial<CrowdRenderNumbers>;
-    readonly poses?: Partial<CrowdPoseMap>;
-    /** The eye colour of each crowd type, by type index (G `_eye`); null for a type that has none. */
-    readonly eyes: readonly (number | null)[];
-};
-type CrowdInstances = {
-    readonly numbers: CrowdRenderNumbers;
-    /** Writes the agents seen this frame, keeps each one's level of detail and attack pose in the store (`lod`, `attackPose`) and returns how many went out. */
-    agents(store: CrowdStore, variants: readonly VariantSize[], frame: CrowdFrame, sink: CrowdInstanceSink): number;
-    /** Writes the bodies on the ground: an agent's on its variant, the others on the plain batch. `life` is the seconds a body lasts (the crowd's `corpseSeconds`). */
-    corpses(entries: readonly {
-        readonly age: number;
-        readonly data: Corpse;
-    }[], variants: readonly VariantSize[], frame: CrowdFrame, life: number, sink: CrowdInstanceSink, plain: PlainCorpseSink): void;
-    /** Writes the civilians that are still people (not dead, turned or gone); `colorOf` gives each one's shirt. */
-    civilians(list: readonly Civilian[], colorOf: (civilian: Civilian) => number, sink: (civilian: Civilian, instance: CrowdInstance) => void): void;
-};
 /**
- * The drawing of a crowd as instances, without three.js: a literal port of the team game's `hordeRender` (G 67098-67136) and `npcRender`
- * (G 70177-70184). The renderer of `game-crowd-three` hands each instance to a `BodyBatch` of `game-characters-three`; any other drawing can take them.
+ * The look of an instance as one number: type, variant, shirt, trousers, size, wounds and accessories (the signature of the variety test, T4b.9).
+ * Two instances with the same signature look the same to the eye.
  */
-declare function createCrowdInstances(options: CrowdInstancesOptions): CrowdInstances;
-
-type CrowdRendererOptions = {
-    readonly crowd: Crowd;
-    /** The rich builders the bodies are baked from (`game-characters-three`: the Bestiário builder, optionally the survivors'). */
-    readonly builders: BakeBuilders;
-    /** The name the rich builder knows a crowd type by (default its id). */
-    readonly typeName?: (type: CrowdType, index: number) => string;
-    /** The civilians to draw and the body each one is baked from (G 68469 `PB`: a human spec or a portrait). Without it no civilian is drawn. */
-    readonly civilians?: {
-        readonly list: () => readonly Civilian[];
-        readonly body: (civilian: Civilian) => BakeSpec;
-        readonly color?: (civilian: Civilian) => number;
-    };
-    /** The plain body for bodies on the ground that were not agents (default the instanced body at the middle level, G `BODY_LOD[1]`). */
-    readonly plainBody?: THREE_NS.BufferGeometry;
-    /** Whether the bodies on the ground are drawn this frame (default always). */
-    readonly drawCorpses?: () => boolean;
-    readonly numbers?: Partial<CrowdRenderNumbers>;
-    readonly poses?: Partial<CrowdPoseMap>;
-};
-type CrowdRenderer = {
-    /** Holds every batch; add it to the scene. */
-    readonly group: THREE_NS.Group;
-    readonly instances: CrowdInstances;
-    /** Bakes every type's variants now (otherwise a type is baked the first time one of its bodies is drawn). */
-    bake(): void;
-    /** Draws the frame: the agents, the bodies on the ground and the civilians. */
-    update(dt: number, frame: CrowdFrame): void;
-    /** Agents drawn at each level of detail in the last frame (G `lodCounts`). */
-    readonly lodCounts: readonly [number, number, number];
-    /** Batches with something to draw. */
-    readonly drawCalls: number;
-    readonly bakeMs: number;
-    readonly variants: readonly BodyVariant[];
-    dispose(): void;
-};
-/**
- * The crowd drawn on the instanced path: every type's variants baked at the three levels of detail (G 67079 `ZVAR`, the variants and seeds of
- * `game-characters`), a few draw calls for thousands of agents, the bodies on the ground and the civilians. The instances are `createCrowdInstances`
- * (the port of `hordeRender` and `npcRender`); the batches are `game-characters-three`'s.
- */
-declare function createCrowdRenderer(three: Three, options: CrowdRendererOptions): CrowdRenderer;
-
-/** One drawn animal, as `game-animals-three` builds it (structural: this package does not depend on it). */
-type DrawnAnimal = {
-    readonly root: THREE_NS.Object3D;
-    readonly wings: readonly {
-        readonly shoulder: THREE_NS.Object3D;
-        readonly elbow: THREE_NS.Object3D;
-        readonly side: number;
-    }[];
-    phase: number;
-};
-/** What draws the animals: `game-animals-three`'s `createAnimalsThree(THREE)` is one as it is. */
-type AnimalDrawer<TSpecies = unknown> = {
-    build(species: TSpecies, options?: {
-        readonly phase?: number;
-    }): DrawnAnimal;
-    animate(rig: DrawnAnimal, params: {
-        readonly time: number;
-        readonly delta: number;
-        readonly clip: string;
-    }): void;
-    setVisualState?(rig: DrawnAnimal, state: 'alive' | 'infected' | 'dead'): void;
-};
-type HerdViewOptions<TSpecies> = {
-    readonly herd: Herd;
-    readonly drawer: AnimalDrawer<TSpecies>;
-    /** The species card of an animal's species id (`game-animals-species` `getSpecies`). */
-    readonly species: (id: string) => TSpecies | undefined;
-    /** The vultures: the flock that moves the herd's sky animals, in the order they were added. */
-    readonly flock?: Flock;
-};
-type HerdView = {
-    readonly group: THREE_NS.Group;
-    /** Builds what is new in the herd and moves every drawn animal to its place this frame (G 66697-66708). */
-    update(dt: number): void;
-    readonly count: number;
-    clear(): void;
-};
-/**
- * The herd drawn with the animals' own rigs: each animal where `game-crowd`'s herd put it, turned to its heading and animated with its clip (G 66697
- * `E.pele.mesh.position.set(E.x, 0, E.z)`, `animQuad`); the vultures where the flock puts them, gliding with the wings half open (G 66704-66708).
- */
-declare function createHerdView<TSpecies>(three: {
-    readonly Group: new () => THREE_NS.Group;
-}, options: HerdViewOptions<TSpecies>): HerdView;
+declare const appearanceSignature: (typeIndex: number, variant: number, instance: CrowdInstance, size: VariantSize) => number;
 
 /** The crowd's sound bank: register it in the host's engine (`host.audio.register`) and the crowd's and the herd's sound ids play. */
 declare const CROWD_SOUND_BANK: SoundBank;
 /** The herd's sound ids (`HERD_ROLES`) to the bank's recipes; the crowd's own ids (`groan`, `runner_groan`, `scream_hoarse`) are the recipes' ids already. */
 declare const HERD_SOUND_IDS: Readonly<Record<string, string>>;
 
-declare const CROWD_AREA_ID = "crowd_area";
-/** The species card the bench reads: the gait rates (`game-animals-species` cards are these). */
-type CrowdBenchSpecies = {
-    readonly walkHz: number;
-    readonly runHz: number;
-};
-/** What a crowd effect is in the host's effect catalogue (`host.effects`): its id and, optionally, the option it plays with. */
-type CrowdEffectMap = Readonly<Record<string, {
-    readonly effect: string;
-    readonly param?: number | string;
-} | null>>;
-/** The room's effects for the crowd's (the Oficina de VFX recipes of `game-vfx`): blood on a hit, a severed limb, the bloater's cloud, a spark, dust. */
-declare const CROWD_EFFECTS: CrowdEffectMap;
-type CrowdTestModuleOptions = {
-    readonly locale?: string;
-    /** The bodies the crowd draws from (types, ages, outfits): the host's content (`game-characters-undead` `undeadCrowdPack()`, or a game's own). */
-    readonly pack: CrowdPack;
-    /** The rich builders the bodies are baked from, made once three.js is lent. Without it the crowd runs and nothing is drawn. */
-    readonly builders?: (three: Three) => BakeBuilders;
-    /** The name the rich builder knows a type by (default its id). */
-    readonly typeName?: (type: CrowdType, index: number) => string;
-    /** The bench's name of a type (default its id). */
-    readonly typeLabel?: (type: CrowdType, locale: string) => string;
-    /** The bodies of the civilians (baked human specs), one per civilian, in order; without them the civilians run but are not drawn. */
-    readonly civilianBodies?: readonly BakeSpec[];
-    /** The animals: the species card of an id, its size (`game-animals` `quadrupedLayout(body).size`, `birdSize(body)`) and, optionally, what draws them. */
-    readonly animals?: {
-        readonly species: (id: string) => CrowdBenchSpecies | undefined;
-        readonly size: (species: CrowdBenchSpecies) => number;
-        readonly drawer?: (three: Three) => AnimalDrawer<CrowdBenchSpecies>;
-    };
-    /** A region model to bring agents from (`game-infection` `create(...)`) and the region the area is in. */
-    readonly infection?: {
-        readonly create: () => InfectionModelLike;
-        readonly region: string;
-        readonly active?: (model: InfectionModelLike) => number;
-    };
-    /** The effect ids of the host for the crowd's effects (default `CROWD_EFFECTS`; null leaves one out). */
-    readonly effects?: CrowdEffectMap;
-    readonly seed?: number;
-    /** Agents when the area opens (default 0, so a room that only carries the module stays calm). */
-    readonly startCount?: number;
-    /** Where the crowd is born around (default 0, -45: in front of the room's start). */
-    readonly center?: readonly [number, number];
-};
-/** What the scenarios use of the context the test room passes. */
-interface CrowdScenarioLike {
-    expect(condition: boolean, label: string, data?: Record<string, unknown>): void;
-}
-type CrowdTestModule = TestableModule<CrowdScenarioLike> & {
-    readonly crowd: Crowd;
-    readonly player: Player;
-    readonly renderer: CrowdRenderer | null;
-};
-/**
- * The crowd area of a test room, against the generic contracts only: a horde of any pack drawn on the instanced path (the baked variants of
- * `game-characters-three`), the room's camera as the `game-player` body it hunts, civilians, the herd and the vultures, and a bridge to a region
- * model. Sounds go to `host.audio` (the crowd's bank is registered there), effects to `host.effects`. The pack and the bodies come in by option:
- * this package knows no game.
- */
-declare function createCrowdTestModule(options: CrowdTestModuleOptions): CrowdTestModule;
-
-type Keys<K extends string> = Readonly<Record<K, string>>;
-type CrowdBenchText = {
-    readonly group: string;
-    readonly name: string;
-    readonly mix: string;
-    readonly controls: Keys<'count' | 'type' | 'night' | 'seed' | 'spawn' | 'noise' | 'hit' | 'kill_all' | 'join' | 'flee' | 'herd' | 'materialize' | 'push' | 'reset'>;
-    readonly hints: Keys<'count' | 'type' | 'night' | 'noise' | 'hit' | 'join' | 'flee' | 'herd' | 'materialize' | 'push'>;
-    readonly layers: Keys<'corpses' | 'civilians' | 'animals'>;
-    readonly metrics: Keys<'agents' | 'drawn' | 'lod_near' | 'lod_middle' | 'lod_far' | 'draw_calls' | 'bake_ms' | 'active' | 'kills' | 'corpses' | 'civilians' | 'health' | 'grabbed' | 'message'>;
-    readonly scenarios: Keys<'relevance' | 'lod' | 'attack_pose' | 'corpse_darkens' | 'civilians_flee' | 'herd_calls' | 'vultures' | 'infection' | 'determinism'>;
-    readonly messages: Keys<'called' | 'burst_hit' | 'swing_knock' | 'pounce_knock' | 'migration' | 'door_broken' | 'alarm' | 'bark' | 'growl' | 'bitten' | 'turned' | 'died'>;
-    readonly yes: string;
-    readonly no: string;
-};
-declare const crowdBenchTextOf: (locale: string) => CrowdBenchText;
-
-export { type AnimalDrawer, CROWD_AREA_ID, CROWD_EFFECTS, CROWD_RENDER_DEFAULTS, CROWD_SOUND_BANK, type CrowdBenchSpecies, type CrowdBenchText, type CrowdEffectMap, type CrowdFrame, type CrowdInstance, type CrowdInstanceSink, type CrowdInstances, type CrowdInstancesOptions, type CrowdPoseMap, type CrowdRenderNumbers, type CrowdRenderer, type CrowdRendererOptions, type CrowdScenarioLike, type CrowdTestModule, type CrowdTestModuleOptions, type DrawnAnimal, HERD_SOUND_IDS, type HerdView, type HerdViewOptions, type PlainCorpseSink, type VariantSize, createCrowdInstances, createCrowdRenderer, createCrowdTestModule, createHerdView, crowdBenchTextOf };
+export { CROWD_SOUND_BANK, CrowdInstance, HERD_SOUND_IDS, VariantSize, appearanceSignature };