@adatechnology/game-weapons-three 0.16.0 → 0.17.1

package/dist/index.js

@@ -23,6 +23,8 @@ import {
   RELOAD_SAMPLE,
   RELOAD_SAMPLE_HITS,
   SHIPPED_WEAPON_ITEM_MODELS,
+  VIEW_HOLD,
+  VIEW_MOTION,
   WEAPON_ITEM_PREFIX,
   WEAPON_THUMBNAILS,
   WEIGHT_INTENSITY,
@@ -69,6 +71,7 @@ import {
   registerWeaponItemModel,
   rigStock,
   rigUnderbarrel,
+  toWorldLens,
   weaponProp,
   weaponPropsOver,
   weaponSampleBank,
@@ -79,7 +82,7 @@ import {
   worldExplosiveItem,
   worldExplosiveShell,
   worldExplosiveValve
-} from "./chunk-KWJQO6JS.js";
+} from "./chunk-BDYIF7JD.js";
 
 // src/projectile-model.ts
 import { markKitOrigin } from "@adatechnology/game-contracts";
@@ -136,6 +139,8 @@ export {
   P13_VALVE_MESH,
   RELOAD_SAMPLE,
   RELOAD_SAMPLE_HITS,
+  VIEW_HOLD,
+  VIEW_MOTION,
   WEAPON_ITEM_PREFIX,
   WEAPON_THUMBNAILS,
   WEIGHT_INTENSITY,
@@ -183,6 +188,7 @@ export {
   registerWeaponItemModel,
   rigStock,
   rigUnderbarrel,
+  toWorldLens,
   weaponProp,
   weaponSampleBank,
   weaponSampleDefaults,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/projectile-model.ts","../src/weapon-props.ts"],"sourcesContent":["import { markKitOrigin } from '@adatechnology/game-contracts'\nimport type * as THREE_NS from 'three'\n\nimport { buildWeaponModelById } from './models'\nimport { buildExplosiveModel } from './models/explosives'\nimport { modelKit } from './models/kit'\nimport { buildFlyingRocket } from './models/launcher-rounds'\n\n/** What a host asks for a thrown or set down explosive: the weapon in the hand, the explosive it carries and how it is used (`rocket`, `grenade`, `molotov`, `charge`). */\nexport interface ProjectileQuery {\n  readonly weapon: string\n  readonly explosive?: string | undefined\n  readonly kind: string\n}\n\n/** The model of a projectile and the axis along its length. */\nexport interface ProjectileModel {\n  readonly model: THREE_NS.Object3D\n  readonly axis: [number, number, number]\n}\n\n/**\n * 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\n * 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.\n * Answers `null` where the gallery has no model (the 40 mm grenade of a launcher), and a host keeps its primitive for it.\n */\nexport function projectileModel(THREE: typeof THREE_NS, query: ProjectileQuery): ProjectileModel | null {\n  if (query.kind !== 'rocket') return explosiveProjectile(THREE, query)\n  const launcher = buildWeaponModelById(THREE, query.weapon)\n  if (!launcher || launcher.parts.family !== 'rocket') return null\n  const round = launcher.parts.makeRound ? launcher.parts.makeRound() : buildFlyingRocket(modelKit(THREE), launcher.parts.launcherType)\n  return { model: round, axis: [1, 0, 0] }\n}\n\n// a thrown or set down explosive the gallery drew: its model centred on its middle (it tumbles about it in flight), standing axis +y\nfunction explosiveProjectile(THREE: typeof THREE_NS, query: ProjectileQuery): ProjectileModel | null {\n  const model = query.explosive === undefined ? undefined : buildExplosiveModel(THREE, query.explosive)\n  if (!model) return null\n  const centre = new THREE.Box3().setFromObject(model).getCenter(new THREE.Vector3())\n  const holder = markKitOrigin(new THREE.Group(), { owner: 'game-weapons-three', kind: 'explosive', id: model.name })\n  holder.name = model.name\n  model.position.sub(centre)\n  holder.add(model)\n  return { model: holder, axis: [0, 1, 0] }\n}\n","import { applyPatches, mergeById, removeIds } from '@adatechnology/game-contracts'\nimport type { DeepPartial } from '@adatechnology/game-contracts'\n\nimport { SHIPPED_WEAPON_ITEM_MODELS, weaponPropsOver } from './weapon-item-model'\nimport type { WeaponItemModel, WeaponProps } from './weapon-item-model'\n\nexport interface WeaponPropsOptions {\n  /** Item model overrides by weapon id, added to the shipped ones (`null` keeps the low-poly prop); later packs replace earlier ones. */\n  readonly packs?: readonly Readonly<Record<string, WeaponItemModel | null>>[]\n  /** Changes to an override by weapon id, merged field by field. */\n  readonly patch?: Readonly<Record<string, DeepPartial<WeaponItemModel>>>\n  /** Weapon ids whose override is taken out (the weapon id itself is then the item model id). */\n  readonly remove?: readonly string[]\n}\n\ntype Entry = { readonly id: string; readonly model: WeaponItemModel }\n\n/** 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. */\nexport function createWeaponProps(options: WeaponPropsOptions = {}): WeaponProps {\n  const entryOf = ([id, model]: readonly [string, WeaponItemModel | null]): Entry => ({ id, model: model ?? { item: '' } })\n  const entries = mergeById<Entry>(SHIPPED_WEAPON_ITEM_MODELS.map(entryOf), (options.packs ?? []).flatMap((pack) => Object.entries(pack).map(entryOf)))\n  const patches: Record<string, { model: DeepPartial<WeaponItemModel> }> = {}\n  for (const [id, model] of Object.entries(options.patch ?? {})) patches[id] = { model }\n  applyPatches(entries, patches)\n  removeIds(entries, options.remove)\n  return weaponPropsOver(new Map([...entries].map(([id, entry]) => [id, entry.model])))\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,qBAAqB;AA0BvB,SAAS,gBAAgB,OAAwB,OAAgD;AACtG,MAAI,MAAM,SAAS,SAAU,QAAO,oBAAoB,OAAO,KAAK;AACpE,QAAM,WAAW,qBAAqB,OAAO,MAAM,MAAM;AACzD,MAAI,CAAC,YAAY,SAAS,MAAM,WAAW,SAAU,QAAO;AAC5D,QAAM,QAAQ,SAAS,MAAM,YAAY,SAAS,MAAM,UAAU,IAAI,kBAAkB,SAAS,KAAK,GAAG,SAAS,MAAM,YAAY;AACpI,SAAO,EAAE,OAAO,OAAO,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE;AACzC;AAGA,SAAS,oBAAoB,OAAwB,OAAgD;AACnG,QAAM,QAAQ,MAAM,cAAc,SAAY,SAAY,oBAAoB,OAAO,MAAM,SAAS;AACpG,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,SAAS,IAAI,MAAM,KAAK,EAAE,cAAc,KAAK,EAAE,UAAU,IAAI,MAAM,QAAQ,CAAC;AAClF,QAAM,SAAS,cAAc,IAAI,MAAM,MAAM,GAAG,EAAE,OAAO,sBAAsB,MAAM,aAAa,IAAI,MAAM,KAAK,CAAC;AAClH,SAAO,OAAO,MAAM;AACpB,QAAM,SAAS,IAAI,MAAM;AACzB,SAAO,IAAI,KAAK;AAChB,SAAO,EAAE,OAAO,QAAQ,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE;AAC1C;;;AC5CA,SAAS,cAAc,WAAW,iBAAiB;AAkB5C,SAAS,kBAAkB,UAA8B,CAAC,GAAgB;AAC/E,QAAM,UAAU,CAAC,CAAC,IAAI,KAAK,OAAyD,EAAE,IAAI,OAAO,SAAS,EAAE,MAAM,GAAG,EAAE;AACvH,QAAM,UAAU,UAAiB,2BAA2B,IAAI,OAAO,IAAI,QAAQ,SAAS,CAAC,GAAG,QAAQ,CAAC,SAAS,OAAO,QAAQ,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC;AACpJ,QAAM,UAAmE,CAAC;AAC1E,aAAW,CAAC,IAAI,KAAK,KAAK,OAAO,QAAQ,QAAQ,SAAS,CAAC,CAAC,EAAG,SAAQ,EAAE,IAAI,EAAE,MAAM;AACrF,eAAa,SAAS,OAAO;AAC7B,YAAU,SAAS,QAAQ,MAAM;AACjC,SAAO,gBAAgB,IAAI,IAAI,CAAC,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,CAAC;AACtF;","names":[]}
+{"version":3,"sources":["../src/projectile-model.ts","../src/weapon-props.ts"],"sourcesContent":["import { markKitOrigin } from '@adatechnology/game-contracts'\nimport type * as THREE_NS from 'three'\n\nimport { buildWeaponModelById } from './models'\nimport { buildExplosiveModel } from './models/explosives'\nimport { modelKit } from './models/kit'\nimport { buildFlyingRocket } from './models/launcher-rounds'\n\n/** What a host asks for a thrown or set down explosive: the weapon in the hand, the explosive it carries and how it is used (`rocket`, `grenade`, `molotov`, `charge`). */\nexport interface ProjectileQuery {\n  readonly weapon: string\n  readonly explosive?: string | undefined\n  readonly kind: string\n}\n\n/** The model of a projectile and the axis along its length. */\nexport interface ProjectileModel {\n  readonly model: THREE_NS.Object3D\n  readonly axis: [number, number, number]\n}\n\n/**\n * 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\n * 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.\n * Answers `null` where the gallery has no model (the 40 mm grenade of a launcher), and a host keeps its primitive for it.\n */\nexport function projectileModel(THREE: typeof THREE_NS, query: ProjectileQuery): ProjectileModel | null {\n  if (query.kind !== 'rocket') return explosiveProjectile(THREE, query)\n  const launcher = buildWeaponModelById(THREE, query.weapon)\n  if (!launcher || launcher.parts.family !== 'rocket') return null\n  const round = launcher.parts.makeRound ? launcher.parts.makeRound() : buildFlyingRocket(modelKit(THREE), launcher.parts.launcherType)\n  return { model: round, axis: [1, 0, 0] }\n}\n\n// a thrown or set down explosive the gallery drew: its model centred on its middle (it tumbles about it in flight), standing axis +y\nfunction explosiveProjectile(THREE: typeof THREE_NS, query: ProjectileQuery): ProjectileModel | null {\n  const model = query.explosive === undefined ? undefined : buildExplosiveModel(THREE, query.explosive)\n  if (!model) return null\n  const centre = new THREE.Box3().setFromObject(model).getCenter(new THREE.Vector3())\n  const holder = markKitOrigin(new THREE.Group(), { owner: 'game-weapons-three', kind: 'explosive', id: model.name })\n  holder.name = model.name\n  model.position.sub(centre)\n  holder.add(model)\n  return { model: holder, axis: [0, 1, 0] }\n}\n","import { applyPatches, mergeById, removeIds } from '@adatechnology/game-contracts'\nimport type { DeepPartial } from '@adatechnology/game-contracts'\n\nimport { SHIPPED_WEAPON_ITEM_MODELS, weaponPropsOver } from './weapon-item-model'\nimport type { WeaponItemModel, WeaponProps } from './weapon-item-model'\n\nexport interface WeaponPropsOptions {\n  /** Item model overrides by weapon id, added to the shipped ones (`null` keeps the low-poly prop); later packs replace earlier ones. */\n  readonly packs?: readonly Readonly<Record<string, WeaponItemModel | null>>[]\n  /** Changes to an override by weapon id, merged field by field. */\n  readonly patch?: Readonly<Record<string, DeepPartial<WeaponItemModel>>>\n  /** Weapon ids whose override is taken out (the weapon id itself is then the item model id). */\n  readonly remove?: readonly string[]\n}\n\ntype Entry = { readonly id: string; readonly model: WeaponItemModel }\n\n/** 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. */\nexport function createWeaponProps(options: WeaponPropsOptions = {}): WeaponProps {\n  const entryOf = ([id, model]: readonly [string, WeaponItemModel | null]): Entry => ({ id, model: model ?? { item: '' } })\n  const entries = mergeById<Entry>(SHIPPED_WEAPON_ITEM_MODELS.map(entryOf), (options.packs ?? []).flatMap((pack) => Object.entries(pack).map(entryOf)))\n  const patches: Record<string, { model: DeepPartial<WeaponItemModel> }> = {}\n  for (const [id, model] of Object.entries(options.patch ?? {})) patches[id] = { model }\n  applyPatches(entries, patches)\n  removeIds(entries, options.remove)\n  return weaponPropsOver(new Map([...entries].map(([id, entry]) => [id, entry.model])))\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,qBAAqB;AA0BvB,SAAS,gBAAgB,OAAwB,OAAgD;AACtG,MAAI,MAAM,SAAS,SAAU,QAAO,oBAAoB,OAAO,KAAK;AACpE,QAAM,WAAW,qBAAqB,OAAO,MAAM,MAAM;AACzD,MAAI,CAAC,YAAY,SAAS,MAAM,WAAW,SAAU,QAAO;AAC5D,QAAM,QAAQ,SAAS,MAAM,YAAY,SAAS,MAAM,UAAU,IAAI,kBAAkB,SAAS,KAAK,GAAG,SAAS,MAAM,YAAY;AACpI,SAAO,EAAE,OAAO,OAAO,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE;AACzC;AAGA,SAAS,oBAAoB,OAAwB,OAAgD;AACnG,QAAM,QAAQ,MAAM,cAAc,SAAY,SAAY,oBAAoB,OAAO,MAAM,SAAS;AACpG,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,SAAS,IAAI,MAAM,KAAK,EAAE,cAAc,KAAK,EAAE,UAAU,IAAI,MAAM,QAAQ,CAAC;AAClF,QAAM,SAAS,cAAc,IAAI,MAAM,MAAM,GAAG,EAAE,OAAO,sBAAsB,MAAM,aAAa,IAAI,MAAM,KAAK,CAAC;AAClH,SAAO,OAAO,MAAM;AACpB,QAAM,SAAS,IAAI,MAAM;AACzB,SAAO,IAAI,KAAK;AAChB,SAAO,EAAE,OAAO,QAAQ,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE;AAC1C;;;AC5CA,SAAS,cAAc,WAAW,iBAAiB;AAkB5C,SAAS,kBAAkB,UAA8B,CAAC,GAAgB;AAC/E,QAAM,UAAU,CAAC,CAAC,IAAI,KAAK,OAAyD,EAAE,IAAI,OAAO,SAAS,EAAE,MAAM,GAAG,EAAE;AACvH,QAAM,UAAU,UAAiB,2BAA2B,IAAI,OAAO,IAAI,QAAQ,SAAS,CAAC,GAAG,QAAQ,CAAC,SAAS,OAAO,QAAQ,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC;AACpJ,QAAM,UAAmE,CAAC;AAC1E,aAAW,CAAC,IAAI,KAAK,KAAK,OAAO,QAAQ,QAAQ,SAAS,CAAC,CAAC,EAAG,SAAQ,EAAE,IAAI,EAAE,MAAM;AACrF,eAAa,SAAS,OAAO;AAC7B,YAAU,SAAS,QAAQ,MAAM;AACjC,SAAO,gBAAgB,IAAI,IAAI,CAAC,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,CAAC;AACtF;","names":[]}

package/dist/{testing-CEcZ-zzz.d.ts → testing-BKDGK6cq.d.ts}

@@ -1009,6 +1009,12 @@ type ModelFamily = 'pistol' | 'revolver' | 'rifle' | 'semiint' | 'semi12' | 'p90
 /** The named parts a model exposes to the animation: pivots and marks inside the model, never copies. */
 interface ModelParts {
     family: ModelFamily;
+    /** Where the right hand takes a gun that names it (a rotary gun's rear spade grip, a horizontal handle along z): the top of the handle. */
+    holdRight?: THREE_NS.Object3D;
+    /** Where the supporting hand takes a gun that names it (the carry handle on top): the top of the handle, the palm on it. */
+    holdLeft?: THREE_NS.Object3D;
+    /** How the body carries it: `hip`, too heavy for the shoulder (a hand-held rotary gun), low at the right hip, level ahead. */
+    carry?: 'hip';
     /** Recoil strength of the model (the page's `kick`). */
     kick?: number;
     /** How far the slide or bolt travels back, in metres. */
@@ -1283,6 +1289,15 @@ interface WeaponFxOptions {
     bodyHold?: () => HandPose | null;
     /** Whether the view is the player's own eye: the gallery's guns are then framed in the view (`VIEW_HOLD`) instead of held on the body. */
     firstPerson?: () => boolean;
+    /** The lens the host draws the first-person layer with (`ModuleHost.setViewmodelFov`): the gun in the hands sets the one of its family, and null when it leaves the view. */
+    viewmodelFov?: (degrees: number | null) => void;
+    /** How far the gun is brought to the eye, 0 at the hip to 1 aimed down the sights. */
+    aim?: () => number;
+    /** How the body moves, for the bob of the step and the sway of the gun in the view. */
+    motion?: () => {
+        readonly speed: number;
+        readonly running: boolean;
+    };
     /** The host's effects: the muzzle flash, smoke, backblast and flame jet of the gallery models are recipes it plays; without it the viewmodel makes a world of its own for them. */
     effects?: EffectSink;
     /** The most casings and magazines alive at once (`host.particleLimit`), read at each spawn; without it the viewmodel keeps a cap of its own. */

package/dist/testing.d.ts

@@ -1,4 +1,4 @@
-export { i as COUNTER_ITEM_ID, m as DEFAULT_EXPLOSIVES_SCENE, E as EXPLOSIVES_AREA_ID, o as EXPLOSIVES_TEXT, q as ExplosivesRoom, r as ExplosivesScene, s as ExplosivesTestModuleOptions, t as ExplosivesText, N as MOUNTED_M134_ITEM_ID, $ as WEAPON_ITEM_PREFIX, a7 as WeaponsTestModuleOptions, af as createExplosivesTestModule, ai as createWeaponsTestModule, al as explosivesTextOf, au as weaponsLayout } from './testing-CEcZ-zzz.js';
+export { i as COUNTER_ITEM_ID, m as DEFAULT_EXPLOSIVES_SCENE, E as EXPLOSIVES_AREA_ID, o as EXPLOSIVES_TEXT, q as ExplosivesRoom, r as ExplosivesScene, s as ExplosivesTestModuleOptions, t as ExplosivesText, N as MOUNTED_M134_ITEM_ID, $ as WEAPON_ITEM_PREFIX, a7 as WeaponsTestModuleOptions, af as createExplosivesTestModule, ai as createWeaponsTestModule, al as explosivesTextOf, au as weaponsLayout } from './testing-BKDGK6cq.js';
 import '@adatechnology/game-contracts';
 import '@adatechnology/game-weapons';
 import '@adatechnology/game-audio';

package/dist/testing.js

@@ -9,7 +9,7 @@ import {
   createWeaponsTestModule,
   explosivesTextOf,
   weaponsLayout
-} from "./chunk-KWJQO6JS.js";
+} from "./chunk-BDYIF7JD.js";
 export {
   COUNTER_ITEM_ID,
   DEFAULT_EXPLOSIVES_SCENE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adatechnology/game-weapons-three",
-  "version": "0.16.0",
+  "version": "0.17.1",
   "license": "MIT AND CC-BY-SA-4.0 AND CC-BY-SA-3.0 AND CC-BY-3.0 AND CC0-1.0 AND LicenseRef-Public-Domain",
   "description": "three.js presentation for @adatechnology/game-weapons: the real models of the Galeria 3D do Arsenal (78 weapons, a cartridge and a case per calibre), the weapon in the hands playing the tool-animation clips (fire, burst, cycle, jam, clear, safety and the seven reloads), ejected casings and dropped magazines, worn-metal conditions, synthesized sounds, and the weapons test area (counters with every weapon) as a TestableModule.",
   "keywords": [
@@ -44,15 +44,15 @@
     "assets"
   ],
   "dependencies": {
-    "@adatechnology/game-audio": "^0.9.0",
-    "@adatechnology/game-contracts": "^0.26.0",
-    "@adatechnology/game-floorplan-three": "^0.10.1",
-    "@adatechnology/game-items-three": "^0.7.4",
+    "@adatechnology/game-audio": "^0.9.1",
+    "@adatechnology/game-contracts": "^0.27.0",
+    "@adatechnology/game-floorplan-three": "^0.10.2",
+    "@adatechnology/game-items-three": "^0.7.5",
     "@adatechnology/game-render-three": "^0.2.0",
     "@adatechnology/game-shapes-three": "^0.3.1",
-    "@adatechnology/game-vfx": "^0.8.0",
-    "@adatechnology/game-vfx-three": "^0.7.1",
-    "@adatechnology/game-weapons": "^0.7.1"
+    "@adatechnology/game-vfx": "^0.9.0",
+    "@adatechnology/game-vfx-three": "^0.7.3",
+    "@adatechnology/game-weapons": "^0.8.0"
   },
   "peerDependencies": {
     "three": "^0.160.0"
@@ -65,7 +65,7 @@
     "tsup": "^8.5.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.4",
-    "@adatechnology/game-test-room": "^0.27.0",
+    "@adatechnology/game-test-room": "^0.28.1",
     "@adatechnology/golden-tool": "^0.0.0"
   },
   "scripts": {