@adatechnology/game-weapons-three 0.14.1 → 0.15.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { I as ItemModels, W as WeaponProps, a as WeaponItemModel, M as ModelKit, b as WeaponModel, c as ModelParts, d as ModelFamily, A as AttachmentModelRegistry, L as LaserRaycast } from './testing-DnPjEPC5.js';
-export { e as ARCHETYPE_MODELS, f as AttachmentBuildContext, g as AttachmentModel, h as AttachmentModelBuilder, C as CLASS_REFERENCE_ENERGY, i as COUNTER_ITEM_ID, j as CUES_IN_SAMPLE, k as CasingSound, l as CuePlayed, D as DEFAULT_ENERGY_CURVE, m as DEFAULT_EXPLOSIVES_SCENE, n as DistanceCurve, E as EXPLOSIVES_AREA_ID, o as EXPLOSIVES_TEXT, p as EnergyCurve, q as ExplosivesRoom, r as ExplosivesScene, s as ExplosivesTestModuleOptions, t as ExplosivesText, F as FlybySound, u as FxLayers, G as GAME_DISTANCE_CURVE, v as GAME_SOUND_CLASSES, w as GUNSHOT_PROFILES, x as GUNSHOT_SAMPLE, y as GUNSHOT_SAMPLE_IDS, z as Gunshot, B as GunshotInput, H as GunshotPlayed, J as ItemModelRequest, K as MECHANICAL_SOUNDS, N as MODEL_ENTRIES, O as MOUNTED_M134_ITEM_ID, P as MechanicalSoundId, Q as ModelEntry, R as ModelMaterials, S as ModelOptions, T as MountFrame, U as RELOAD_SAMPLE, V as RELOAD_SAMPLE_HITS, X as ShotExtras, Y as ShotSound, Z as ShotSoundClass, _ as ShotSoundInput, $ as ShotSoundOptions, a0 as SoundClassDef, a1 as SoundStep, a2 as WEAPON_ITEM_PREFIX, a3 as WEIGHT_INTENSITY, a4 as WeaponAudio, a5 as WeaponAudioOptions, a6 as WeaponFx, a7 as WeaponFxOptions, a8 as WeaponSampleOptions, a9 as WeaponsTestModuleOptions, aa as buildItemWeaponModel, ab as buildWeaponModel, ac as buildWeaponModelById, ad as computeCasingSound, ae as computeFlyby, af as computeGunshot, ag as computeShotSound, ah as createExplosivesTestModule, ai as createWeaponAudio, aj as createWeaponFx, ak as createWeaponsTestModule, al as defaultWeaponProps, am as deriveFrames, an as explosivesTextOf, ao as hasWeaponModel, ap as itemModelOfWeapon, aq as mechanicalSoundOf, ar as modelKit, as as mountFrame, at as registerWeaponItemModel, au as weaponSampleBank, av as weaponSampleDefaults, aw as weaponsLayout } from './testing-DnPjEPC5.js';
+import { I as ItemModels, W as WeaponProps, a as WeaponItemModel, M as ModelOptions, b as WeaponModel, c as ModelKit, d as ModelParts, e as ModelFamily, A as AttachmentModelRegistry, L as LaserRaycast } from './testing-Cf1M1sWN.js';
+export { f as AttachmentBuildContext, g as AttachmentModel, h as AttachmentModelBuilder, C as CLASS_REFERENCE_ENERGY, i as COUNTER_ITEM_ID, j as CUES_IN_SAMPLE, k as CasingSound, l as CuePlayed, D as DEFAULT_ENERGY_CURVE, m as DEFAULT_EXPLOSIVES_SCENE, n as DistanceCurve, E as EXPLOSIVES_AREA_ID, o as EXPLOSIVES_TEXT, p as EnergyCurve, q as ExplosivesRoom, r as ExplosivesScene, s as ExplosivesTestModuleOptions, t as ExplosivesText, F as FlybySound, u as FxLayers, G as GAME_DISTANCE_CURVE, v as GAME_SOUND_CLASSES, w as GUNSHOT_PROFILES, x as GUNSHOT_SAMPLE, y as GUNSHOT_SAMPLE_IDS, z as Gunshot, B as GunshotInput, H as GunshotPlayed, J as ItemModelRequest, K as MECHANICAL_SOUNDS, N as MOUNTED_M134_ITEM_ID, O as MechanicalSoundId, P as ModelMaterials, Q as MountFrame, R as RELOAD_SAMPLE, S as RELOAD_SAMPLE_HITS, T as ShotExtras, U as ShotSound, V as ShotSoundClass, X as ShotSoundInput, Y as ShotSoundOptions, Z as SoundClassDef, _ as SoundStep, $ as WEAPON_ITEM_PREFIX, a0 as WEIGHT_INTENSITY, a1 as WeaponAudio, a2 as WeaponAudioOptions, a3 as WeaponFx, a4 as WeaponFxOptions, a5 as WeaponModelDef, a6 as WeaponSampleOptions, a7 as WeaponsTestModuleOptions, a8 as buildItemWeaponModel, a9 as buildThrowableModel, aa as buildWeaponModel, ab as computeCasingSound, ac as computeFlyby, ad as computeGunshot, ae as computeShotSound, af as createExplosivesTestModule, ag as createWeaponAudio, ah as createWeaponFx, ai as createWeaponsTestModule, aj as defaultWeaponProps, ak as deriveFrames, al as explosivesTextOf, am as hasThrowableModel, an as itemModelOfWeapon, ao as mechanicalSoundOf, ap as modelKit, aq as mountFrame, ar as registerWeaponItemModel, as as weaponSampleBank, at as weaponSampleDefaults, au as weaponsLayout } from './testing-Cf1M1sWN.js';
 import * as THREE_NS from 'three';
 import { TestableItem, Vec3, HostEvent, EffectSink, DestructibleSpec, DeepPartial, ToolClipSet } from '@adatechnology/game-contracts';
 import { ExplosiveDef, Arsenal, WeaponDef, CartridgeDims, CaliberDef, CaseType, ReloadFamily, FittedAttachment, AttachmentDef } from '@adatechnology/game-weapons';
@@ -61,8 +61,8 @@ interface ProjectileModel {
 }
 /**
  * The model of what a weapon throws or fires, drawn by the same code as the weapon itself: the round of a rocket launcher (the RPG-7's PG-7V, the Carl Gustaf's 84 mm round, the rocket of
- * the disposable tubes), long axis +x. Answers `null` where the gallery has no model: the throwables (grenades, molotovs, dynamite, C4, the Claymore) and the grenade launchers are
- * still the plain props of `weaponProp`, and a host keeps its primitive for them.
+ * the disposable tubes), long axis +x, and the explosives of the gallery (the M67, the molotov, the pipe bomb, the dynamite, the C4, the Claymore, the flashbang), centred, axis +y.
+ * Answers `null` where the gallery has no model (the 40 mm grenade of a launcher), and a host keeps its primitive for it.
  */
 declare function projectileModel(THREE: typeof THREE_NS, query: ProjectileQuery): ProjectileModel | null;
 
@@ -99,12 +99,18 @@ declare function weaponProp(def: Pick<WeaponDef, 'id' | 'category' | 'mass'>, na
 /** 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 explosive ids of game-weapons the gallery drew (`m67`, `molotov`, `pipe_bomb`, `dynamite`, `c4`, `claymore`, `flashbang`). */
+declare const EXPLOSIVE_MODEL_IDS: readonly string[];
+declare const hasExplosiveModel: (explosiveId: string) => boolean;
+/** The gallery model of an explosive standing on its base (y up, origin at the bottom centre, a `handle` mark where the hand closes); undefined for one the gallery did not draw. */
+declare function buildExplosiveModel(THREE: typeof THREE_NS, explosiveId: string): THREE_NS.Group | undefined;
+
 /**
  * The prop of a weapon the gallery drew (or that an item model draws, `buildItemWeaponModel`), for a counter or the floor: its model lying on the side, centred on the footprint with its underside on the floor, joined into one mesh per
  * material (the hands keep the model with its pivots, `buildWeaponModelById`), every mesh naming the one rigid part (`body`) that moves it. The size of that part is left in
  * `userData.footprint` for `modeledPropSpec`.
  */
-declare function buildModeledProp(THREE: typeof THREE_NS, def: Pick<WeaponDef, 'id'>, name: string, decorate?: (root: THREE_NS.Object3D) => void, items?: ItemModels, props?: WeaponProps): THREE_NS.Group | undefined;
+declare function buildModeledProp(THREE: typeof THREE_NS, def: Pick<WeaponDef, 'id'> & Partial<Pick<WeaponDef, 'action'>>, name: string, decorate?: (root: THREE_NS.Object3D) => void, items?: ItemModels, props?: WeaponProps): THREE_NS.Group | undefined;
 /** A modeled weapon on a tripod of three steel legs under its middle (the same legs the `tripod` accessory draws in the hands). */
 declare function buildTripodMountedProp(THREE: typeof THREE_NS, def: Pick<WeaponDef, 'id'>, name: string, items?: ItemModels, props?: WeaponProps): THREE_NS.Group | undefined;
 /** The destruction spec of a modeled prop: one steel box of its measures, with the real mass of the weapon. */
@@ -121,6 +127,25 @@ interface WeaponPropsOptions {
 /** A set of weapon prop overrides of its own: the shipped ones plus `packs`, `patch` and `remove`. Nothing is shared with any other set on the page. */
 declare function createWeaponProps(options?: WeaponPropsOptions): WeaponProps;
 
+/** 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' | 'breakLauncher' | 'm2' | 'm134' | 'launcher';
+    readonly caliber: string;
+    readonly length: number;
+    readonly barrel: number;
+    readonly options: ModelOptions;
+    readonly variantOf?: string;
+}
+declare const MODEL_ENTRIES: Readonly<Record<string, ModelEntry>>;
+/**
+ * The model each generic archetype wears: the one of the first brand weapon (lowest id) that points to it with `archetype` and fires the same way (a rocket launcher that points to
+ * `shotgun_pump_12` does not lend its tube to the shotgun). An archetype nothing points to, the melee weapons and the bow keep their simple prop.
+ */
+declare const ARCHETYPE_MODELS: Readonly<Record<string, string>>;
+declare const hasWeaponModel: (id: string) => boolean;
+/** The gallery model of a weapon (or of the brand weapon an archetype wears, see `ARCHETYPE_MODELS`), long axis along +x, rear at the origin; undefined for melee, throwables and what nothing drew. */
+declare function buildWeaponModelById(THREE: typeof THREE_NS, id: string): WeaponModel | undefined;
+
 /** 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. */
@@ -204,4 +229,4 @@ declare function rigUnderbarrel(THREE: typeof THREE_NS, model: WeaponModel, def:
  */
 declare function rigStock(THREE: typeof THREE_NS, model: WeaponModel, def: Pick<WeaponDef, 'stock' | 'dimensions'>): void;
 
-export { ATTACHMENT_MODELS, AttachmentModelRegistry, type AttachmentRig, BODY_ACTIONS, type CartridgeShape, type ClipContext, DEFAULT_THUMBNAIL_BASE, type FitAttachmentOptions, ItemModels, LaserRaycast, ModelFamily, ModelKit, ModelParts, P13_VALVE_MESH, type ProjectileModel, type ProjectileQuery, WEAPON_THUMBNAILS, WORLD_EFFECTS, WORLD_EXPLOSIVE_IDS, WORLD_EXPLOSIVE_PREFIX, WeaponItemModel, WeaponModel, type WeaponProp, WeaponProps, type WeaponPropsOptions, type WeaponThumbnailEntry, type WorldEffectIds, type WorldEffectsOptions, type WorldExplosiveOptions, applyCondition, buildCartridge, buildCasing, buildModeledProp, buildProp, buildRound, buildToolClips, buildTripodMountedProp, cartridgeShape, createWeaponProps, createWorldEffects, fitAttachmentModels, modeledPropSpec, partRegistry, projectileModel, rigStock, rigUnderbarrel, weaponProp, weaponThumbnailCredit, weaponThumbnailUrl, worldExplosiveItem, worldExplosiveShell, worldExplosiveValve };
+export { ARCHETYPE_MODELS, ATTACHMENT_MODELS, AttachmentModelRegistry, type AttachmentRig, BODY_ACTIONS, type CartridgeShape, type ClipContext, DEFAULT_THUMBNAIL_BASE, EXPLOSIVE_MODEL_IDS, type FitAttachmentOptions, ItemModels, LaserRaycast, MODEL_ENTRIES, type ModelEntry, ModelFamily, ModelKit, ModelOptions, ModelParts, P13_VALVE_MESH, type ProjectileModel, type ProjectileQuery, WEAPON_THUMBNAILS, WORLD_EFFECTS, WORLD_EXPLOSIVE_IDS, WORLD_EXPLOSIVE_PREFIX, WeaponItemModel, WeaponModel, type WeaponProp, WeaponProps, type WeaponPropsOptions, type WeaponThumbnailEntry, type WorldEffectIds, type WorldEffectsOptions, type WorldExplosiveOptions, applyCondition, buildCartridge, buildCasing, buildExplosiveModel, buildModeledProp, buildProp, buildRound, buildToolClips, buildTripodMountedProp, buildWeaponModelById, cartridgeShape, createWeaponProps, createWorldEffects, fitAttachmentModels, hasExplosiveModel, hasWeaponModel, modeledPropSpec, partRegistry, projectileModel, rigStock, rigUnderbarrel, weaponProp, weaponThumbnailCredit, weaponThumbnailUrl, worldExplosiveItem, worldExplosiveShell, worldExplosiveValve };