@adatechnology/game-weapons-three 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { HostTool, HostEvent, TestableModule, AreaPlacement, TestableItem, DestructibleSpec, ToolClipSet } from '@adatechnology/game-contracts';
-import { CaliberDef, ReloadStageId, WeaponEvent, Arsenal, ExplosiveDef, WeaponDef, CartridgeDims, CaseType, ReloadFamily } from '@adatechnology/game-weapons';
+import { CaliberDef, ReloadStageId, WeaponEvent, MountKind, AttachmentDef, FittedAttachment, Arsenal, ExplosiveDef, WeaponDef, CartridgeDims, CaseType, ReloadFamily } from '@adatechnology/game-weapons';
 import * as THREE_NS from 'three';
 
 /** One sound of the game: [lowpass cutoff Hz, gain, seconds]. Literal from the `P` table of `sfx` in the game (jogo.js L62101-L62104). */
@@ -136,7 +136,7 @@ type SoundStep =
     readonly gain: number;
     readonly frequency: number;
 };
-type MechanicalSoundId = ReloadStageId | 'dry_fire' | 'misfire' | 'feed' | 'cycle' | 'mode' | 'safety_on' | 'safety_off' | 'jam' | 'clear_start' | 'clear_end';
+type MechanicalSoundId = ReloadStageId | 'dry_fire' | 'misfire' | 'feed' | 'cycle' | 'mode' | 'safety_on' | 'safety_off' | 'jam' | 'clear_start' | 'clear_end' | 'stock_fold' | 'light_click' | 'attach';
 /**
  * Sounds keyed by the rule: the `reload_stage` ids of `RELOAD_STAGES`, plus the other weapon events. The click of an empty weapon and the generic
  * reload tick are the game's `vazio` and `recarga` classes (jogo.js L62101-L62104; played at L68644-L68662); the gallery (sources/armas-itens__galeria-3d-arsenal.js)
@@ -186,104 +186,15 @@ interface WeaponAudio {
 }
 declare function createWeaponAudio(volume?: number, options?: WeaponAudioOptions): WeaponAudio;
 
-/** What the bench turns on or off in the presentation of the weapon: the ejected casings, the dropped magazines and the muzzle flash. */
+/** What the bench turns on or off in the presentation of the weapon: the ejected casings, the dropped magazines, the muzzle flash, the accessory models and the light and laser beams. */
 interface FxLayers {
     casings: boolean;
     magazines: boolean;
     muzzleFlash: boolean;
+    attachments: boolean;
+    beams: boolean;
 }
 
-interface WeaponFxOptions {
-    THREE: typeof THREE_NS;
-    scene: THREE_NS.Scene;
-    camera: THREE_NS.Camera;
-    arsenal: Arsenal;
-    /** Height things rest on at (x, z): casings and magazines land there. */
-    groundAt: (x: number, z: number) => number;
-    /** Sounds (`createWeaponAudio`); null or absent: silent. */
-    audio?: WeaponAudio | null;
-    /** Seed of the scatter of the effects of the gallery models. */
-    seed?: number;
-    /** The tool as it is now (barrel heat, fuel burning). */
-    tool?: () => HostTool;
-    /** Wear of the weapon: `new`, `used`, `worn` or `rusty`. */
-    condition?: string;
-    /** What is drawn: read at the moment of each event, so the bench can change it live. */
-    layers?: FxLayers;
-    /** Metres between the shooter and the listener, for the distance muffling of the shot sound (default 0). */
-    soundDistance?: () => number;
-}
-
-/** The weapon in the hands, its fire and reload motion, ejected casings and dropped magazines, and their sounds. */
-interface WeaponFx {
-    /** Feed every tool event of the host, with the tool as it is after the event. */
-    handle(event: HostEvent, tool: HostTool): void;
-    update(dt: number): void;
-    /** Dresses the weapon for its wear (`new`, `used`, `worn`, `rusty`); the gallery models show it in their metal. */
-    setCondition(condition: string): void;
-    /** What is drawn (casings, magazines, muzzle flash): change a field and the next event follows it. */
-    readonly layers: FxLayers;
-    /** Weapon shown in the hands, or null. */
-    readonly inHand: string | null;
-    /** Casings and magazines currently on the floor or in the air. */
-    readonly casings: number;
-    readonly magazines: number;
-    dispose(): void;
-}
-/**
- * The presentation of the tool in the hands. The weapons the gallery drew (`MODEL_ENTRIES`) get their model and the clips the rule's events call for
- * (fire, cycle, jam, clear, safety, the seven reloads); the generic archetypes keep their low-poly prop.
- */
-declare function createWeaponFx(options: WeaponFxOptions): WeaponFx;
-
-interface WeaponsTestModuleOptions {
-    /** `en` or `pt-BR` (default). */
-    locale?: string;
-    /** The arsenal to lay out (default `createArsenal` with the locale). */
-    arsenal?: Arsenal;
-    /** Play sounds (default true; silent anyway where there is no AudioContext). */
-    sound?: boolean;
-    /** Wear of the weapon in the hands, which the gallery models show in their metal: `new` (default), `used`, `worn` or `rusty`. */
-    condition?: string;
-    /** Seed of the scatter of casings and smoke (default 1). */
-    seed?: number;
-}
-/** Prefix of the item ids of the weapon props (`weapon_pistol_9mm`). */
-declare const WEAPON_ITEM_PREFIX = "weapon_";
-declare const COUNTER_ITEM_ID = "counter_weapons";
-/** Where the counters go and where each weapon lies on them: weapons side by side across the counters in order, each taking its strip, until the counter is full. */
-declare function weaponsLayout(weaponItemIds: string[], pitchOf?: (itemId: string) => number): AreaPlacement[];
-/**
- * The weapons test area as a `TestableModule` of @adatechnology/game-contracts: every weapon of the arsenal on counters, the real model of each one the gallery drew (aim at one and
- * press H to equip it), targets at shooting distance, and, through `attach`, the weapon in the hands with its fire and reload motion,
- * ejected casings, dropped magazines and sounds, driven by the host's tool events.
- */
-declare function createWeaponsTestModule(options?: WeaponsTestModuleOptions): TestableModule & {
-    readonly audio: WeaponAudio | null;
-    readonly fx: WeaponFx | null;
-};
-
-/** Prefix of the item ids of the explosives that sit in the world (`world_fuel_barrel`). */
-declare const WORLD_EXPLOSIVE_PREFIX = "world_";
-/** The ids of the explosives of the arsenal that the area puts in the world. */
-declare const WORLD_EXPLOSIVE_IDS: readonly string[];
-/** An explosive of the arsenal standing in the world: it goes off by a bullet, fire or another blast, after the delay its `chain` gives. */
-declare const worldExplosiveItem: (def: ExplosiveDef, name: string) => TestableItem | undefined;
-
-/** A low-poly prop: its destruction spec (box parts only) and one colour per part. */
-interface WeaponProp {
-    spec: DestructibleSpec;
-    colors: Record<string, number>;
-}
-/** Body actions of the arsenal: nothing to hold or lay on a counter. */
-declare const BODY_ACTIONS: ReadonlySet<string>;
-/** The prop of a weapon: low-poly parts by category, the real mass of the weapon spread over them. */
-declare function weaponProp(def: Pick<WeaponDef, 'id' | 'category' | 'mass'>, name?: string): WeaponProp;
-/** One mesh per box part, named after the part (what destruction renderers bind to), in a group with its origin on the floor. */
-declare function buildProp(THREE: typeof THREE_NS, prop: WeaponProp): THREE_NS.Group;
-/** The model of a weapon for the hands or a shelf: the same prop the counters show. */
-declare function buildWeaponModel(THREE: typeof THREE_NS, def: Pick<WeaponDef, 'id' | 'category' | 'mass'>): THREE_NS.Group;
-
 /** How the gallery builders describe a weapon: the short keys of `data/models.json` (the page's own option names), all optional. */
 interface ModelOptions {
     /** Total length and barrel length in mm, and the calibre text, as the weapons table gives them. */
@@ -351,6 +262,26 @@ interface ModelOptions {
     /** Launcher type: `rpg`, `m72`, `at4`, `carl`, `flame`, `flameDIY`. */
     lt?: string;
 }
+/**
+ * Numbers the builders write down while they draw, in the space of `inner` (metres along the barrel, before `fitLength` stretches it): where the accessories go.
+ * Written by the rifle and the M134 builders; the others get theirs measured from the model (`deriveFrames`).
+ */
+interface ModelFrames {
+    length: number;
+    barrelY: number;
+    barrelRadius: number;
+    receiverStart: number;
+    receiverEnd: number;
+    receiverHeight: number;
+    receiverWidth: number;
+    handguardEnd: number;
+    magazineX: number;
+    gripX: number;
+    /** The top rail is drawn (an optic sits on it without an adapter). */
+    hasRail: boolean;
+    /** Where the gun joins what is under the barrel (x, y), when the model has a place for it that the rule does not derive from the handguard. */
+    underbarrel?: readonly [number, number];
+}
 /** The moving mechanism of a model, which picks its fire, reload and clear motion. */
 type ModelFamily = 'pistol' | 'revolver' | 'rifle' | 'semiint' | 'semi12' | 'p90' | 'belt' | 'pump' | 'lever' | 'bolt' | 'boltmag' | 'break' | 'rocket' | 'flame';
 /** The named parts a model exposes to the animation: pivots and marks inside the model, never copies. */
@@ -395,11 +326,29 @@ interface ModelParts {
     roundRest?: number;
     makeRound?: () => THREE_NS.Object3D;
     gauge?: THREE_NS.Object3D;
+    /** Where the accessories go (see `ModelFrames`). */
+    frames?: ModelFrames;
+    /** The meshes of the stock the builder drew, in the order it drew them: `rigStock` moves them into one pivot. */
+    stockMeshes?: THREE_NS.Object3D[];
+    /** The stock pivot `rigStock` made, and how it moves. */
+    stock?: THREE_NS.Object3D;
+    stockMove?: StockMove;
+    /** The meshes of each part that ships on the weapon, by accessory id (`red_dot`, `bipod`, `muzzle_brake`): taking the accessory off hides them. */
+    fittings?: Record<string, THREE_NS.Object3D[]>;
+    /** The pivot a launcher under the barrel sits in (made by `rigUnderbarrel`), and its muzzle mark once one is fitted. */
+    ugl?: THREE_NS.Object3D;
+    uglMuzzle?: THREE_NS.Object3D;
+}
+/** How the stock moves when it collapses: a slide of `travel` metres along the weapon (in `inner` units), or a half turn about `axis` (`foldAxis` of the rule). */
+interface StockMove {
+    kind: 'fold' | 'retract';
+    axis: 'x' | 'y' | 'z';
+    travel: number;
 }
 
 /** One weapon of the gallery as `data/models.json` keeps it: the builder, the measures in mm and the builder's options. */
 interface ModelEntry {
-    readonly builder: 'pistol' | 'revolver' | 'rifle' | 'bullpup' | 'p90' | 'break' | 'm2' | 'launcher';
+    readonly builder: 'pistol' | 'revolver' | 'rifle' | 'bullpup' | 'p90' | 'break' | 'm2' | 'm134' | 'launcher';
     readonly caliber: string;
     readonly length: number;
     readonly barrel: number;
@@ -488,6 +437,190 @@ interface ModelKit {
 /** One kit per three.js namespace: the materials and the geometry cache are shared by every model built with it. */
 declare function modelKit(THREE: Three): ModelKit;
 
+type Vec3 = [number, number, number];
+/** The shape of a model that carries its `inner` and `root` as `buildWeaponModelById` makes them. */
+interface FramedModel {
+    readonly root: THREE_NS.Group;
+    readonly inner: THREE_NS.Group;
+    readonly parts: ModelParts;
+}
+/** Where an accessory of one kind of mount goes, in the space of the wrapper (`root`): the origin of its own frame and the sizes it needs from the weapon. */
+interface MountFrame {
+    readonly mount: MountKind;
+    readonly position: Vec3;
+    /** The other end, for what stretches between two points (a sling between its swivels). */
+    readonly secondary?: Vec3;
+    readonly barrelRadius: number;
+    readonly receiverWidth: number;
+    readonly receiverHeight: number;
+    /** The top rail is drawn: an optic needs no adapter. */
+    readonly hasRail: boolean;
+    /** The sign of z for a side rail: left is negative, right is positive (z is to the right of the weapon). */
+    readonly side: -1 | 0 | 1;
+}
+/**
+ * Frames for a model whose builder wrote none (pistols, revolvers, bullpups, launchers...): measured from the model as it is built, with `root` still at the origin.
+ * The numbers are in the space of `inner`, like the ones the rifle builder writes.
+ */
+declare function deriveFrames(THREE: typeof THREE_NS, model: FramedModel): ModelFrames;
+/** The frame of a mount of the model, or undefined for the mounts nothing is drawn on (`stock`, `barrel`). */
+declare function mountFrame(model: FramedModel, mount: MountKind): MountFrame | undefined;
+
+/** Distance in metres to what the ray hits, or null when it hits nothing within `maxDistance`: the host's raycast, which the laser asks every frame. */
+type LaserRaycast = (origin: THREE_NS.Vector3, direction: THREE_NS.Vector3, maxDistance: number) => number | null;
+/** What a builder is given: the accessory, where it sits on the weapon (`frame`, in the space of the wrapper) and the pieces of the model it may hang from or hide. */
+interface AttachmentBuildContext {
+    readonly kit: ModelKit;
+    readonly model: WeaponModel;
+    readonly attachment: AttachmentDef;
+    readonly fitted: FittedAttachment;
+    readonly frame: MountFrame;
+    readonly raycast: LaserRaycast | undefined;
+    /** The meshes the magazine pivot had before any accessory (a drum or an extension replaces or extends them). */
+    readonly factoryMagazine: readonly THREE_NS.Object3D[];
+    /** The pivot of the launcher under the barrel, which the reload clip slides (only on a weapon with a place for one). */
+    readonly slide: THREE_NS.Object3D | undefined;
+}
+/** What a builder makes: the object (its origin on the frame), and what the rig needs to know about it. */
+interface AttachmentModel {
+    readonly object: THREE_NS.Object3D;
+    /** Where the object hangs: the wrapper (default), the magazine pivot (it moves with the magazine) or the sliding pivot of the launcher. */
+    readonly hangsFrom?: 'root' | 'magazine';
+    /** Parts of the weapon that are not drawn while this one is on (a drum hides the magazine it replaces). */
+    readonly hides?: readonly THREE_NS.Object3D[];
+    /** How far forward the muzzle moves (a suppressor): the flash and the smoke come out of its end. */
+    readonly muzzleOffset?: number;
+    /** A launcher's muzzle mark, which the shot clip flashes. */
+    readonly muzzle?: THREE_NS.Object3D;
+    /** A light or laser turned on or off. */
+    setOn?(on: boolean): void;
+    /** Every frame, while the weapon is in the hands (the laser measures how far its beam goes). */
+    update?(): void;
+    dispose?(): void;
+}
+type AttachmentModelBuilder = (context: AttachmentBuildContext) => AttachmentModel | THREE_NS.Object3D | null;
+/** Builders by the `model` id of the accessory (`AttachmentDef.model`). A game replaces or adds one with `attachmentModels` of the weapons module. */
+type AttachmentModelRegistry = Readonly<Record<string, AttachmentModelBuilder>>;
+
+interface WeaponFxOptions {
+    THREE: typeof THREE_NS;
+    scene: THREE_NS.Scene;
+    camera: THREE_NS.Camera;
+    arsenal: Arsenal;
+    /** Height things rest on at (x, z): casings and magazines land there. */
+    groundAt: (x: number, z: number) => number;
+    /** Sounds (`createWeaponAudio`); null or absent: silent. */
+    audio?: WeaponAudio | null;
+    /** Seed of the scatter of the effects of the gallery models. */
+    seed?: number;
+    /** The tool as it is now (barrel heat, fuel burning). */
+    tool?: () => HostTool;
+    /** Wear of the weapon: `new`, `used`, `worn` or `rusty`. */
+    condition?: string;
+    /** What is drawn: read at the moment of each event, so the bench can change it live. */
+    layers?: FxLayers;
+    /** Metres between the shooter and the listener, for the distance muffling of the shot sound (default 0). */
+    soundDistance?: () => number;
+    /** Builders of accessory models that replace or add to the ones the kit ships (by the `model` of the accessory). */
+    attachmentModels?: AttachmentModelRegistry;
+    /** How far a laser beam goes from a point along a direction (metres), or null when it hits nothing: the dot lands where it ends. */
+    raycast?: LaserRaycast;
+}
+
+/** The weapon in the hands, its fire and reload motion, ejected casings and dropped magazines, and their sounds. */
+interface WeaponFx {
+    /** Feed every tool event of the host, with the tool as it is after the event. */
+    handle(event: HostEvent, tool: HostTool): void;
+    update(dt: number): void;
+    /** Dresses the weapon for its wear (`new`, `used`, `worn`, `rusty`); the gallery models show it in their metal. */
+    setCondition(condition: string): void;
+    /** What is drawn (casings, magazines, muzzle flash): change a field and the next event follows it. */
+    readonly layers: FxLayers;
+    /** Weapon shown in the hands, or null. */
+    readonly inHand: string | null;
+    /** Casings and magazines currently on the floor or in the air. */
+    readonly casings: number;
+    readonly magazines: number;
+    dispose(): void;
+}
+/**
+ * The presentation of the tool in the hands. The weapons the gallery drew (`MODEL_ENTRIES`) get their model and the clips the rule's events call for
+ * (fire, cycle, jam, clear, safety, the seven reloads); the generic archetypes keep their low-poly prop.
+ */
+declare function createWeaponFx(options: WeaponFxOptions): WeaponFx;
+
+interface WeaponsTestModuleOptions {
+    /** `en` or `pt-BR` (default). */
+    locale?: string;
+    /** The arsenal to lay out (default `createArsenal` with the locale). */
+    arsenal?: Arsenal;
+    /** Play sounds (default true; silent anyway where there is no AudioContext). */
+    sound?: boolean;
+    /** Wear of the weapon in the hands, which the gallery models show in their metal: `new` (default), `used`, `worn` or `rusty`. */
+    condition?: string;
+    /** Seed of the scatter of casings and smoke (default 1). */
+    seed?: number;
+    /** Builders of accessory models that replace or add to the ones the kit ships (by the `model` of the accessory). */
+    attachmentModels?: AttachmentModelRegistry;
+    /** Folder (ending with a slash) the weapon thumbnails are served from, relative to the page (default `weapon-svg/`); `false` leaves the items without a thumbnail. */
+    thumbnailBase?: string | false;
+}
+/** Prefix of the item ids of the weapon props (`weapon_pistol_9mm`). */
+declare const WEAPON_ITEM_PREFIX = "weapon_";
+declare const COUNTER_ITEM_ID = "counter_weapons";
+declare const MOUNTED_M134_ITEM_ID = "m134_tripod";
+/** Where the counters go and where each weapon lies on them: weapons side by side across the counters in order, each taking its strip, until the counter is full. */
+declare function weaponsLayout(weaponItemIds: string[], pitchOf?: (itemId: string) => number): AreaPlacement[];
+/**
+ * The weapons test area as a `TestableModule` of @adatechnology/game-contracts: every weapon of the arsenal on counters, the real model of each one the gallery drew (aim at one and
+ * press H to equip it), targets at shooting distance, and, through `attach`, the weapon in the hands with its fire and reload motion,
+ * ejected casings, dropped magazines and sounds, driven by the host's tool events.
+ */
+declare function createWeaponsTestModule(options?: WeaponsTestModuleOptions): TestableModule & {
+    readonly audio: WeaponAudio | null;
+    readonly fx: WeaponFx | null;
+};
+
+/** Where a thumbnail came from: the model of the kit (`generated`) or a freely licensed drawing of the real weapon (`commons`, with its author and licence). */
+interface WeaponThumbnailEntry {
+    readonly source: 'generated' | 'commons';
+    /** Path of the SVG inside `assets/weapon-svg`. */
+    readonly file: string;
+    readonly author?: string;
+    readonly license?: string;
+    readonly licenseUrl?: string;
+    readonly page?: string;
+}
+/** Every weapon (and world explosive) that has a thumbnail, by weapon id: the Commons file when one was kept, else the one generated from the 3D model. */
+declare const WEAPON_THUMBNAILS: Readonly<Record<string, WeaponThumbnailEntry>>;
+/** `Author, licence` of a Commons thumbnail (the credit its licence asks for), or undefined for a generated one. */
+declare function weaponThumbnailCredit(id: string): string | undefined;
+/** The folder of the thumbnails relative to the page that shows them; the site build copies `assets/weapon-svg` there. */
+declare const DEFAULT_THUMBNAIL_BASE = "weapon-svg/";
+/** The URL of a weapon's thumbnail under `base` (which ends with a slash), or undefined when it has none. */
+declare function weaponThumbnailUrl(id: string, base?: string): string | undefined;
+
+/** Prefix of the item ids of the explosives that sit in the world (`world_fuel_barrel`). */
+declare const WORLD_EXPLOSIVE_PREFIX = "world_";
+/** The ids of the explosives of the arsenal that the area puts in the world. */
+declare const WORLD_EXPLOSIVE_IDS: readonly string[];
+/** An explosive of the arsenal standing in the world: it goes off by a bullet, fire or another blast, after the delay its `chain` gives. */
+declare const worldExplosiveItem: (def: ExplosiveDef, name: string) => TestableItem | undefined;
+
+/** A low-poly prop: its destruction spec (box parts only) and one colour per part. */
+interface WeaponProp {
+    spec: DestructibleSpec;
+    colors: Record<string, number>;
+}
+/** Body actions of the arsenal: nothing to hold or lay on a counter. */
+declare const BODY_ACTIONS: ReadonlySet<string>;
+/** The prop of a weapon: low-poly parts by category, the real mass of the weapon spread over them. */
+declare function weaponProp(def: Pick<WeaponDef, 'id' | 'category' | 'mass'>, name?: string): WeaponProp;
+/** One mesh per box part, named after the part (what destruction renderers bind to), in a group with its origin on the floor. */
+declare function buildProp(THREE: typeof THREE_NS, prop: WeaponProp): THREE_NS.Group;
+/** The model of a weapon for the hands or a shelf: the same prop the counters show. */
+declare function buildWeaponModel(THREE: typeof THREE_NS, def: Pick<WeaponDef, 'id' | 'category' | 'mass'>): THREE_NS.Group;
+
 /** The shapes the gallery draws: rimfire, straight rimless (`p`), straight rimmed (`rimp`), bottleneck rimless (`r`), bottleneck rimmed (`rr`) and shotgun shell. */
 type CartridgeShape = 'shell' | 'rim' | 'p' | 'rimp' | 'r' | 'rr';
 /** The gallery's cartridge type of a calibre, from its case type, rim and dimensions. */
@@ -523,4 +656,50 @@ interface ClipContext {
 /** Every clip a weapon model brings, by the ids `toolAnimationStep` asks for (`shot`, `cycle`, `reload`, `reload_empty`, `fault_<id>`, `clear_<id>`...). */
 declare function buildToolClips(context: ClipContext): ToolClipSet;
 
-export { ARCHETYPE_MODELS, BODY_ACTIONS, CLASS_REFERENCE_ENERGY, COUNTER_ITEM_ID, type CartridgeShape, type ClipContext, DEFAULT_ENERGY_CURVE, type DistanceCurve, type EnergyCurve, type FxLayers, GAME_DISTANCE_CURVE, GAME_SOUND_CLASSES, MECHANICAL_SOUNDS, MODEL_ENTRIES, type MechanicalSoundId, type ModelEntry, type ModelFamily, type ModelKit, type ModelMaterials, type ModelOptions, type ModelParts, type ShotExtras, type ShotSound, type ShotSoundClass, type ShotSoundInput, type ShotSoundOptions, type SoundClassDef, type SoundStep, WEAPON_ITEM_PREFIX, WORLD_EXPLOSIVE_IDS, WORLD_EXPLOSIVE_PREFIX, type WeaponAudio, type WeaponAudioOptions, type WeaponFx, type WeaponFxOptions, type WeaponModel, type WeaponProp, type WeaponsTestModuleOptions, applyCondition, buildCartridge, buildCasing, buildProp, buildRound, buildToolClips, buildWeaponModel, buildWeaponModelById, cartridgeShape, computeShotSound, createWeaponAudio, createWeaponFx, createWeaponsTestModule, hasWeaponModel, mechanicalSoundOf, modelKit, partRegistry, weaponProp, weaponsLayout, worldExplosiveItem };
+interface FitAttachmentOptions {
+    /** The accessories of the game by id: where each gets its `model`, size and light or laser. */
+    readonly catalogue: ReadonlyMap<string, AttachmentDef>;
+    /** Builders that replace or add to the ones the kit ships (see `ATTACHMENT_MODELS`). */
+    readonly overrides?: AttachmentModelRegistry;
+    /** How far the laser beam goes, asked every frame. */
+    readonly raycast?: LaserRaycast;
+    /** Asked every frame: false hides the models of the accessories the rig drew (the bench layer). */
+    readonly isDrawn?: () => boolean;
+    /** Asked every frame: false puts the light and laser out whatever they are set to (the bench layer for the beams). */
+    readonly areBeamsOn?: () => boolean;
+}
+/** The accessories drawn on one model: it follows the list of fitted parts. */
+interface AttachmentRig {
+    /** Puts the models of what is fitted on the weapon and takes the others off: shows or hides what ships on it, switches the lights and lasers. */
+    sync(fitted: readonly FittedAttachment[]): void;
+    /** Call every frame. */
+    update(): void;
+    /** Ids of the accessories that have a model on the weapon now. */
+    readonly drawn: readonly string[];
+    dispose(): void;
+}
+/**
+ * Draws the accessories of `fitted` on the model: the ones the builder drew with the weapon (`parts.fittings`) show or hide with the list, the others are built by the registry
+ * (`overrides` over `ATTACHMENT_MODELS`) at the frame of their mount and hang from the wrapper (not from `inner`, whose stretch to the real length would stretch them).
+ */
+declare function fitAttachmentModels(model: WeaponModel, fitted: readonly FittedAttachment[], kit: ModelKit, options: FitAttachmentOptions): AttachmentRig;
+
+/**
+ * The model of each accessory by `AttachmentDef.model`. The ports of the gallery (optics, bipod, brakes, drum, belt box, rail) draw what the page draws; the others are creations of the
+ * kit. Accessories without a model (the barrel swaps, the integral optics the weapon already draws) are simply not drawn.
+ */
+declare const ATTACHMENT_MODELS: AttachmentModelRegistry;
+
+/**
+ * After the model is built: when the weapon has a place for a launcher under the barrel, adds the empty pivot `ugl` there. The reload clip slides it (the tube of the launcher is drawn
+ * inside it when one is fitted); done after the build so that the model the golden hashes is the one the builder made.
+ */
+declare function rigUnderbarrel(THREE: typeof THREE_NS, model: WeaponModel, def: Pick<WeaponDef, 'mounts'>): void;
+
+/**
+ * After the model is built: puts the stock the builder drew into one pivot named `stock`, so that the clips can fold it (a half turn about the side of the rule's `foldAxis`)
+ * or slide it in (`dimensions.length - lengthCollapsed`). Done after the build so that the model the golden hashes is the one the builder made. A weapon whose stock does not move is left alone.
+ */
+declare function rigStock(THREE: typeof THREE_NS, model: WeaponModel, def: Pick<WeaponDef, 'stock' | 'dimensions'>): void;
+
+export { ARCHETYPE_MODELS, ATTACHMENT_MODELS, type AttachmentBuildContext, type AttachmentModel, type AttachmentModelBuilder, type AttachmentModelRegistry, type AttachmentRig, BODY_ACTIONS, CLASS_REFERENCE_ENERGY, COUNTER_ITEM_ID, type CartridgeShape, type ClipContext, DEFAULT_ENERGY_CURVE, DEFAULT_THUMBNAIL_BASE, type DistanceCurve, type EnergyCurve, type FitAttachmentOptions, type FxLayers, GAME_DISTANCE_CURVE, GAME_SOUND_CLASSES, type LaserRaycast, MECHANICAL_SOUNDS, MODEL_ENTRIES, MOUNTED_M134_ITEM_ID, type MechanicalSoundId, type ModelEntry, type ModelFamily, type ModelKit, type ModelMaterials, type ModelOptions, type ModelParts, type MountFrame, type ShotExtras, type ShotSound, type ShotSoundClass, type ShotSoundInput, type ShotSoundOptions, type SoundClassDef, type SoundStep, WEAPON_ITEM_PREFIX, WEAPON_THUMBNAILS, WORLD_EXPLOSIVE_IDS, WORLD_EXPLOSIVE_PREFIX, type WeaponAudio, type WeaponAudioOptions, type WeaponFx, type WeaponFxOptions, type WeaponModel, type WeaponProp, type WeaponThumbnailEntry, type WeaponsTestModuleOptions, applyCondition, buildCartridge, buildCasing, buildProp, buildRound, buildToolClips, buildWeaponModel, buildWeaponModelById, cartridgeShape, computeShotSound, createWeaponAudio, createWeaponFx, createWeaponsTestModule, deriveFrames, fitAttachmentModels, hasWeaponModel, mechanicalSoundOf, modelKit, mountFrame, partRegistry, rigStock, rigUnderbarrel, weaponProp, weaponThumbnailCredit, weaponThumbnailUrl, weaponsLayout, worldExplosiveItem };