@adatechnology/game-characters-three 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { T as Three, R as RichRig, B as BloodLook, F as FluidsBridge, C as CharacterSound, A as AvatarItemUsePose, a as AvatarViewMode, b as ReachView, P as PlayerAvatar } from './testing-DyQw8dCw.js';
-export { c as AVATAR_AREA_ID, d as AreaContext, e as AvatarEvent, f as AvatarTestOptions, g as AvatarUpdate, h as BODY_MATERIAL_DEF, i as BODY_SOUNDS, j as BloodAge, k as BloodLookOptions, l as BloodSink, m as BodySoundRule, n as CHARACTERS_AREA_ID, o as CharacterSoundOptions, p as CharacterSoundSink, q as CharacterSoundStyle, r as CharactersTestOptions, s as FilmSink, t as FluidsBridgeOptions, H as HIT_PRESETS, u as HitPreset, v as PERSON_ITEM_PREFIX, w as PLAYER_SOUNDS, x as PlayPoseOptions, y as PlayerAvatarColors, z as PlayerAvatarOptions, D as PlayerAvatarSpec, E as PoseTargets, G as ProfessionCard, I as RigAnimator, J as RigAnimatorOptions, U as UNDEAD_VOICES, K as UNDEAD_VOICE_SOURCES, L as UndeadCard, M as UndeadLike, N as UndeadVoice, V as VoiceMoment, O as VoiceStep, W as WoundSpray, Z as ZOMBIE_ITEM_PREFIX, Q as bloodLookOfAge, S as createAvatarTestModule, X as createCharacterSound, Y as createCharactersTestModule, _ as createFluidsBridge, $ as createPlayerAvatar, a0 as createRigAnimator, a1 as personSpecOf, a2 as registerBodyMaterial } from './testing-DyQw8dCw.js';
+import { T as Three, B as BestSpec, a as BestPose, P as PersonSpec, b as PersonCharacter, c as PersonGroupSpec, L as LegRig, A as ArmRig, d as PersonExtra, R as RichRig, e as BloodLook, F as FluidsBridge, C as CharacterSound, f as AvatarItemUsePose, g as AvatarViewMode, h as ReachView, i as PlayerAvatar } from './testing-CsC-BhNN.js';
+export { j as AVATAR_AREA_ID, k as AreaContext, l as AvatarEvent, m as AvatarTestOptions, n as AvatarUpdate, o as BODY_MATERIAL_DEF, p as BODY_SOUNDS, q as BloodAge, r as BloodLookOptions, s as BloodSink, t as BodySegment, u as BodySoundRule, v as CHARACTERS_AREA_ID, w as CharacterSoundOptions, x as CharacterSoundSink, y as CharacterSoundStyle, z as CharactersTestOptions, D as FilmSink, E as FluidsBridgeOptions, H as HIT_PRESETS, G as HitPreset, I as PERSON_ITEM_PREFIX, J as PLAYER_SOUNDS, K as PlayPoseOptions, M as PlayerAvatarColors, N as PlayerAvatarOptions, O as PlayerAvatarSpec, Q as PoseTargets, S as ProfessionCard, U as RigAnimator, V as RigAnimatorOptions, W as UNDEAD_VOICES, X as UNDEAD_VOICE_SOURCES, Y as UndeadCard, Z as UndeadLike, _ as UndeadVoice, $ as VoiceMoment, a0 as VoiceStep, a1 as WoundSpray, a2 as ZOMBIE_ITEM_PREFIX, a3 as bloodLookOfAge, a4 as createAvatarTestModule, a5 as createCharacterSound, a6 as createCharactersTestModule, a7 as createFluidsBridge, a8 as createPlayerAvatar, a9 as createRigAnimator, aa as personSpecOf, ab as registerBodyMaterial } from './testing-CsC-BhNN.js';
 import { BodySpec, SegmentId, PoseClip, PoseClipEvent, FirstPersonClip } from '@adatechnology/game-characters';
 import * as THREE_NS from 'three';
 import { LightBudget, SourceHandle } from '@adatechnology/game-render-three';
@@ -563,12 +563,13 @@ type BestBuilderOptions = {
     readonly random?: () => number;
 };
 type BestBuilder = {
-    build(spec: Record<string, any>): any;
-    TYPES: Record<string, Record<string, number | boolean>>;
+    /** The body's root (`userData.rig` holds its `BestRig`); a lying body comes wrapped in a group. */
+    build(spec: BestSpec): THREE_NS.Group;
+    TYPES: Record<string, BestPose>;
     /** Level of detail: 1 full, 0.5, 0.28 (segments and sphere resolution scale with it). */
     setLOD(factor: number): void;
     /** The shirt material of the last body built (the bake marks it as material 1). */
-    topM(): any;
+    topM(): THREE_NS.MeshLambertMaterial | null;
 };
 declare const createBestBuilder: (host: Three, { types, random }: BestBuilderOptions) => BestBuilder;
 
@@ -586,58 +587,96 @@ type PersonBuilderOptions = {
     readonly lights?: LightBudget;
 };
 type PersonBuilder = {
-    build(spec: Record<string, any>, index?: number): any;
-    pose(character: any, zombie: boolean, walk: number, time: number): void;
-    zombify(character: any, category?: string): void;
-    buildPerson(person: Record<string, any>, zombie: boolean): {
-        root: any;
-        chars: any[];
+    build(spec: PersonSpec, index?: number): PersonCharacter;
+    pose(character: PersonCharacter, zombie: boolean, walk: number, time: number): void;
+    zombify(character: PersonCharacter, category?: string): void;
+    buildPerson(person: PersonGroupSpec, zombie: boolean): {
+        root: THREE_NS.Group;
+        chars: PersonCharacter[];
     };
 };
 declare const createPersonBuilder: (host: Three, options?: PersonBuilderOptions) => PersonBuilder;
 
-type ExtraContext = {
-    THREE: any;
+type Obj = THREE_NS.Object3D;
+type Geo = THREE_NS.BufferGeometry;
+type Mat = THREE_NS.Material;
+type MatOptions = THREE_NS.MeshStandardMaterialParameters;
+/** Where a stain goes: the skin (wet, shiny) or cloth. */
+type StainKind = 'skin' | 'cloth';
+type PersonKitOptions = {
+    /** The stream the blood stains and the person's own phase draw from. The page used one shared `rng(77)` for the whole cast. */
+    readonly random: () => number;
+    /** A canvas for the plaid texture (default: the document's). */
+    readonly createCanvas?: () => HTMLCanvasElement;
+};
+/** The page's primitives: materials are cached by colour, `add` puts a mesh in a parent, and the `ball`/`ring`/`limb` shapes of the anatomical body. */
+declare const createPersonKit: (host: Three, { random: R, createCanvas }: PersonKitOptions) => {
+    THREE: typeof THREE_NS;
     PI: number;
-    U: any;
-    Hd: any;
-    root: any;
-    add: any;
-    Bx: any;
-    cmat: any;
-    ring: any;
-    torsoGeo: any;
-    legs: any[];
-    arms: any[];
+    SEG: number;
+    R: () => number;
+    scaleHex: (hex: number, factor: number) => number;
+    Bx: (x: number, y: number, z: number) => THREE_NS.BoxGeometry;
+    add: (parent: Obj, geo: Geo, m: Mat, x: number, y: number, z: number, rx?: number, ry?: number, rz?: number) => THREE_NS.Mesh;
+    cmat: (c: number, o?: MatOptions) => THREE_NS.MeshStandardMaterial;
+    ball: (parent: Obj, r: number, m: Mat, x?: number, y?: number, z?: number) => THREE_NS.Mesh<THREE_NS.BufferGeometry<THREE_NS.NormalBufferAttributes>, THREE_NS.Material | THREE_NS.Material[], THREE_NS.Object3DEventMap>;
+    ring: (parent: Obj, r: number, h: number, m: Mat, y: number, sx?: number, sz?: number) => THREE_NS.Mesh<THREE_NS.BufferGeometry<THREE_NS.NormalBufferAttributes>, THREE_NS.Material | THREE_NS.Material[], THREE_NS.Object3DEventMap>;
+    cap: (r: number, len?: number) => THREE_NS.SphereGeometry;
+    limb: (parent: Obj, r1: number, r2: number, len: number, m: Mat) => THREE_NS.Mesh<THREE_NS.BufferGeometry<THREE_NS.NormalBufferAttributes>, THREE_NS.Material | THREE_NS.Material[], THREE_NS.Object3DEventMap>;
+    mlimb: (parent: Obj, prof: readonly number[], len: number, m: Mat) => THREE_NS.Mesh<THREE_NS.BufferGeometry<THREE_NS.NormalBufferAttributes>, THREE_NS.Material | THREE_NS.Material[], THREE_NS.Object3DEventMap>;
+    torsoGeo: (fem: boolean) => THREE_NS.LatheGeometry;
+    splat: (parent: Obj, x: number, y: number, z: number, r: number, color: number, n?: number, out?: Obj[] | null, kind?: StainKind) => Obj;
+    stainM: (c: number, o?: MatOptions) => THREE_NS.MeshStandardMaterial;
+    chessTex: (c1: THREE_NS.ColorRepresentation, c2: THREE_NS.ColorRepresentation) => THREE_NS.CanvasTexture;
+};
+type PersonKit = ReturnType<typeof createPersonKit>;
+
+type Common$3 = {
+    THREE: PersonKit['THREE'];
+    PI: number;
+    add: PersonKit['add'];
+    Bx: PersonKit['Bx'];
+    cmat: PersonKit['cmat'];
+};
+type ExtraContext = Common$3 & {
+    U: THREE_NS.Group;
+    Hd: THREE_NS.Group;
+    root: THREE_NS.Group;
+    ring: PersonKit['ring'];
+    torsoGeo: PersonKit['torsoGeo'];
+    legs: LegRig[];
+    arms: ArmRig[];
     fem: boolean;
-    topM: any;
-    m: any;
-    e: any[];
+    topM: THREE_NS.Material;
+    m: THREE_NS.Material;
+    e: PersonExtra;
     k: string;
-    sp: any;
-    splat: any;
+    sp: PersonSpec;
+    splat: PersonKit['splat'];
     R: () => number;
-    ball: any;
-    cap: any;
-    hc: any;
-    headG: any;
-    fig: any;
-    upper: any;
-    skinM: any;
+    ball: PersonKit['ball'];
+    cap: PersonKit['cap'];
+    hc: THREE_NS.Material;
+    headG: THREE_NS.Group;
+    fig: THREE_NS.Group;
+    upper: THREE_NS.Group;
+    skinM: THREE_NS.MeshStandardMaterial;
 };
 /** Clothing and gear by id (`sp.ex` entries `[id, colour?]`), each drawn onto the body parts it names. */
 declare const EXTRAS: Record<string, (context: ExtraContext) => void>;
 
-type FaceContext = {
-    THREE: any;
+type Common$2 = {
+    THREE: PersonKit['THREE'];
     PI: number;
-    Hd: any;
-    add: any;
-    Bx: any;
-    cmat: any;
-    hc: any;
-    sp: any;
-    f: string[];
+    add: PersonKit['add'];
+    Bx: PersonKit['Bx'];
+    cmat: PersonKit['cmat'];
+};
+type FaceContext = Common$2 & {
+    Hd: THREE_NS.Object3D;
+    hc: THREE_NS.Material;
+    sp: PersonSpec;
+    f: readonly string[];
     scaleHex: (hex: number, factor: number) => number;
 };
 /** Face features in the order the page draws them (the order is part of the scene hash): `ids` are the `sp.face` entries that switch one on. */
@@ -646,17 +685,19 @@ declare const FACE_FEATURES: {
     apply: ({ Bx, Hd, THREE, add, cmat, f }: FaceContext) => void;
 }[];
 
-type HatContext = {
-    THREE: any;
+type Common$1 = {
+    THREE: PersonKit['THREE'];
     PI: number;
-    Hd: any;
-    add: any;
-    Bx: any;
-    cmat: any;
-    cap: any;
-    c: any;
+    add: PersonKit['add'];
+    Bx: PersonKit['Bx'];
+    cmat: PersonKit['cmat'];
+};
+type HatContext = Common$1 & {
+    Hd: THREE_NS.Object3D;
+    cap: PersonKit['cap'];
+    c: THREE_NS.Material;
     k: string;
-    sp: any;
+    sp: PersonSpec;
 };
 /** Hats by kind (`sp.hat.k`); `c` is the hat's material. */
 declare const HATS: {
@@ -664,16 +705,18 @@ declare const HATS: {
     apply: ({ Bx, Hd, PI, add, c, cap, k }: HatContext) => void;
 }[];
 
-type HandItemContext = {
-    THREE: any;
+type Common = {
+    THREE: PersonKit['THREE'];
     PI: number;
-    add: any;
-    Bx: any;
-    cmat: any;
-    g: any;
-    metal: any;
-    dark: any;
-    woodM: any;
+    add: PersonKit['add'];
+    Bx: PersonKit['Bx'];
+    cmat: PersonKit['cmat'];
+};
+type HandItemContext = Common & {
+    g: THREE_NS.Group;
+    metal: THREE_NS.Material;
+    dark: THREE_NS.Material;
+    woodM: THREE_NS.Material;
     /** The host's LightBudget: the flare asks it for a light instead of creating a PointLight. */
     lights?: LightBudget;
     /** Where an item that took a source from `lights` leaves it, so the builder can hand it to whoever removes the person. */
@@ -1155,4 +1198,4 @@ type TwoBone = {
  */
 declare const solveTwoBone: (root: THREE_NS.Vector3, target: THREE_NS.Vector3, upper: number, lower: number, pole: THREE_NS.Vector3, out: TwoBone) => TwoBone;
 
-export { ACCESSORY_BIT, type AccessoryAttach, AvatarItemUsePose, AvatarViewMode, BAKE_NEUTRAL_POSE, BODY_CHUNK, type BakeBuilders, type BakeSpec, type BakedBody, type BestBuilder, type BestBuilderOptions, type BestTypeCard, type BlobShadowBatch, type BlobShadowOptions, BloodLook, type BodyBatch, type BodyBatchMesh, type BodyBatchOptions, type BodyChunkOptions, type BodyInstance, type BodyJoints, type BodyMaterialParams, type BodyVariant, type BuildInstancedBodyParams, CHARACTER_SOUNDS, CHARACTER_SOUND_BANK, CLIPS_BIT, CLIP_BONES, CLIP_LIMIT, CLIP_RATE, CLIP_TEXELS, CharacterSound, type ClipLimp, EXTRAS, type EyeOptions, type Eyes, FACE_FEATURES, FIRST_PERSON_BOB, FIRST_PERSON_COLORS, FIRST_PERSON_RIG, FIRST_PERSON_STANCES, type FirstPersonArms, type FirstPersonArmsOptions, type FirstPersonArmsState, type FirstPersonBob, type FirstPersonColors, type FirstPersonEvent, type FirstPersonRig, FluidsBridge, type FlyingLimb, type FlyingLimbs, type FlyingLimbsOptions, type FlyingPiece, type FlyingPieces, type FlyingPiecesOptions, GAIT_STYLE, type GaitStyle, HAND_ITEMS, HATS, IMPOSTOR_ANGLES, IMPOSTOR_FRAMES, type IdentityLook, type ImpostorAtlas, type ImpostorAtlasOptions, type ImpostorBatch, type ImpostorBatchOptions, type ImpostorBody, type ImpostorBox, type ImpostorInstance, KIT_ACCESSORIES, type KitAccessory, LOD_BAKE, LOD_BATCH_CAPACITY, LOD_CASTS_SHADOW, LOD_DISTANCES, LOD_SEGMENTS, type LimbEffects, type LimbLaunch, PENDULUM, type Pendulum, type PersonBuilder, type PersonBuilderOptions, PlayerAvatar, ReachView, type RestPose, RichRig, type RoomAvatarLike, SEGMENT_CLIPS, STAGGER_POSE, type SegmentClipSet, type SegmentClipSpec, type SegmentClipUniforms, type StanceDef, TROUSER_PALETTE, Three, type ToRoomAvatarOptions, type TwoBone, UNDEAD_VOICE_GROUP, type VariantBatchesOptions, type VariantType, type WoundBody, type WoundMaterials, type WoundNode, type Wounds, type WoundsOptions, accessoryPlacement, bakeBody, bakeImpostorAtlas, bakeSegmentClips, bakeVariants, blobGeometry, blobRadii, buildInstancedBody, buildKitAccessory, clipIndexOf, clipSpeedOf, createBestBuilder, createBlobShadowBatch, createBodyBatch, createBodyChunk, createBodyChunkExt, createBodyMaterial, createEye, createFirstPersonArms, createFlyingLimbs, createFlyingPieces, createGlowTexture, createImpostorBatch, createPendulum, createPersonBuilder, createSegmentClipUniforms, createVariantBatches, createWoundMaterials, createWounds, exitWound, explodeChunks, findEyes, gouge, jointsOf, lodAt, makeCut, makeStump, packIdentity, ringWound, solveTwoBone, starGeometry, stepPendulum, toRoomAvatar, unpackIdentity, walkPoseVertex, woundBodyOf, woundDecal };
+export { ACCESSORY_BIT, type AccessoryAttach, ArmRig, AvatarItemUsePose, AvatarViewMode, BAKE_NEUTRAL_POSE, BODY_CHUNK, type BakeBuilders, type BakeSpec, type BakedBody, type BestBuilder, type BestBuilderOptions, type BestTypeCard, type BlobShadowBatch, type BlobShadowOptions, BloodLook, type BodyBatch, type BodyBatchMesh, type BodyBatchOptions, type BodyChunkOptions, type BodyInstance, type BodyJoints, type BodyMaterialParams, type BodyVariant, type BuildInstancedBodyParams, CHARACTER_SOUNDS, CHARACTER_SOUND_BANK, CLIPS_BIT, CLIP_BONES, CLIP_LIMIT, CLIP_RATE, CLIP_TEXELS, CharacterSound, type ClipLimp, EXTRAS, type EyeOptions, type Eyes, FACE_FEATURES, FIRST_PERSON_BOB, FIRST_PERSON_COLORS, FIRST_PERSON_RIG, FIRST_PERSON_STANCES, type FirstPersonArms, type FirstPersonArmsOptions, type FirstPersonArmsState, type FirstPersonBob, type FirstPersonColors, type FirstPersonEvent, type FirstPersonRig, FluidsBridge, type FlyingLimb, type FlyingLimbs, type FlyingLimbsOptions, type FlyingPiece, type FlyingPieces, type FlyingPiecesOptions, GAIT_STYLE, type GaitStyle, HAND_ITEMS, HATS, IMPOSTOR_ANGLES, IMPOSTOR_FRAMES, type IdentityLook, type ImpostorAtlas, type ImpostorAtlasOptions, type ImpostorBatch, type ImpostorBatchOptions, type ImpostorBody, type ImpostorBox, type ImpostorInstance, KIT_ACCESSORIES, type KitAccessory, LOD_BAKE, LOD_BATCH_CAPACITY, LOD_CASTS_SHADOW, LOD_DISTANCES, LOD_SEGMENTS, LegRig, type LimbEffects, type LimbLaunch, PENDULUM, type Pendulum, type PersonBuilder, type PersonBuilderOptions, PersonCharacter, PersonExtra, PersonGroupSpec, PersonSpec, PlayerAvatar, ReachView, type RestPose, RichRig, type RoomAvatarLike, SEGMENT_CLIPS, STAGGER_POSE, type SegmentClipSet, type SegmentClipSpec, type SegmentClipUniforms, type StanceDef, TROUSER_PALETTE, Three, type ToRoomAvatarOptions, type TwoBone, UNDEAD_VOICE_GROUP, type VariantBatchesOptions, type VariantType, type WoundBody, type WoundMaterials, type WoundNode, type Wounds, type WoundsOptions, accessoryPlacement, bakeBody, bakeImpostorAtlas, bakeSegmentClips, bakeVariants, blobGeometry, blobRadii, buildInstancedBody, buildKitAccessory, clipIndexOf, clipSpeedOf, createBestBuilder, createBlobShadowBatch, createBodyBatch, createBodyChunk, createBodyChunkExt, createBodyMaterial, createEye, createFirstPersonArms, createFlyingLimbs, createFlyingPieces, createGlowTexture, createImpostorBatch, createPendulum, createPersonBuilder, createSegmentClipUniforms, createVariantBatches, createWoundMaterials, createWounds, exitWound, explodeChunks, findEyes, gouge, jointsOf, lodAt, makeCut, makeStump, packIdentity, ringWound, solveTwoBone, starGeometry, stepPendulum, toRoomAvatar, unpackIdentity, walkPoseVertex, woundBodyOf, woundDecal };