@adatechnology/game-weapons-three 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { HostTool, HostEvent, TestableModule, AreaPlacement, TestableItem, DestructibleSpec, ToolClipSet } from '@adatechnology/game-contracts';
+import { HostTool, HostEvent, TestableModule, AreaPlacement, TestableItem, EffectSink, DestructibleSpec, ToolClipSet } from '@adatechnology/game-contracts';
 import { CaliberDef, ReloadStageId, WeaponEvent, MountKind, AttachmentDef, FittedAttachment, Arsenal, ExplosiveDef, WeaponDef, CartridgeDims, CaseType, ReloadFamily } from '@adatechnology/game-weapons';
 import * as THREE_NS from 'three';
 
@@ -607,6 +607,27 @@ 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;
 
+/** The effect ids a weapon of a case type shows when it is seen from outside: its muzzle flash and its ejected case (the host's catalogue names them). */
+interface WorldEffectIds {
+    readonly muzzle: string;
+    readonly casing: string;
+}
+declare const WORLD_EFFECTS: Readonly<Record<string, WorldEffectIds>>;
+interface WorldEffectsOptions {
+    readonly arsenal: Arsenal;
+    /** The case type of a weapon (`pistol`, `rifle`, `shell`, `big`, `tiny`); default from its caliber. */
+    readonly caseTypeOf?: (weapon: string) => string | undefined;
+    /** The ids by case type; default `WORLD_EFFECTS`. A game adds or changes entries. */
+    readonly ids?: Readonly<Record<string, WorldEffectIds>>;
+}
+/**
+ * The shooter's flash and ejected case for a shot the viewer sees from outside (a `shot` event that carries `origin`), played through the host's
+ * effect sink. The player's own first-person shot has no `origin` and is drawn by the weapon in the hands, so nothing doubles.
+ */
+declare function createWorldEffects(options: WorldEffectsOptions): {
+    handle(event: HostEvent, sink: EffectSink | undefined): number;
+};
+
 /** A low-poly prop: its destruction spec (box parts only) and one colour per part. */
 interface WeaponProp {
     spec: DestructibleSpec;
@@ -702,4 +723,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 { 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 };
+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_EFFECTS, WORLD_EXPLOSIVE_IDS, WORLD_EXPLOSIVE_PREFIX, type WeaponAudio, type WeaponAudioOptions, type WeaponFx, type WeaponFxOptions, type WeaponModel, type WeaponProp, type WeaponThumbnailEntry, type WeaponsTestModuleOptions, type WorldEffectIds, type WorldEffectsOptions, applyCondition, buildCartridge, buildCasing, buildProp, buildRound, buildToolClips, buildWeaponModel, buildWeaponModelById, cartridgeShape, computeShotSound, createWeaponAudio, createWeaponFx, createWeaponsTestModule, createWorldEffects, deriveFrames, fitAttachmentModels, hasWeaponModel, mechanicalSoundOf, modelKit, mountFrame, partRegistry, rigStock, rigUnderbarrel, weaponProp, weaponThumbnailCredit, weaponThumbnailUrl, weaponsLayout, worldExplosiveItem };

package/dist/index.global.js

@@ -35,6 +35,7 @@ var GameWeaponsThree = (() => {
     MOUNTED_M134_ITEM_ID: () => MOUNTED_M134_ITEM_ID,
     WEAPON_ITEM_PREFIX: () => WEAPON_ITEM_PREFIX,
     WEAPON_THUMBNAILS: () => WEAPON_THUMBNAILS,
+    WORLD_EFFECTS: () => WORLD_EFFECTS,
     WORLD_EXPLOSIVE_IDS: () => WORLD_EXPLOSIVE_IDS,
     WORLD_EXPLOSIVE_PREFIX: () => WORLD_EXPLOSIVE_PREFIX,
     applyCondition: () => applyCondition,
@@ -50,6 +51,7 @@ var GameWeaponsThree = (() => {
     createWeaponAudio: () => createWeaponAudio,
     createWeaponFx: () => createWeaponFx,
     createWeaponsTestModule: () => createWeaponsTestModule,
+    createWorldEffects: () => createWorldEffects,
     deriveFrames: () => deriveFrames,
     fitAttachmentModels: () => fitAttachmentModels,
     hasWeaponModel: () => hasWeaponModel,
@@ -19984,7 +19986,7 @@ ${problems.map((problem) => `  - ${problem}`).join("\n")}`);
     shape: shape.shape,
     position: shape.position,
     ...SHELL,
-    explodes: { energy: def.energy, radius: def.injuryRadius, ...def.chain ? { chain: { ...def.chain } } : {} }
+    explodes: { energy: def.energy, radius: def.injuryRadius, effect: def.id, ...def.chain ? { chain: { ...def.chain } } : {} }
   });
   var meshOf = (THREE, shape) => {
     const geometry = shape.shape.kind === "cylinder" ? new THREE.CylinderGeometry(shape.shape.radius, shape.shape.radius, shape.shape.height, 16) : shape.shape.kind === "box" ? new THREE.BoxGeometry(...shape.shape.size) : new THREE.SphereGeometry(0.2);
@@ -20012,6 +20014,51 @@ ${problems.map((problem) => `  - ${problem}`).join("\n")}`);
     };
   };
 
+  // src/data/world-effects.json
+  var world_effects_default = {
+    pistol: { muzzle: "muzzle_glock", casing: "casing_brass" },
+    tiny: { muzzle: "muzzle_glock", casing: "casing_brass" },
+    rifle: { muzzle: "muzzle_ak", casing: "casing_brass" },
+    shell: { muzzle: "muzzle_r870", casing: "casing_shell" },
+    big: { muzzle: "muzzle_barrett", casing: "casing_50" }
+  };
+
+  // src/world-effects.ts
+  var WORLD_EFFECTS = world_effects_default;
+  var PORT_BACK = 0.35;
+  var PORT_RIGHT = 0.04;
+  function createWorldEffects(options) {
+    const ids = options.ids ?? WORLD_EFFECTS;
+    const caseTypeOf = options.caseTypeOf ?? ((weapon) => {
+      const def = options.arsenal.weapons.get(weapon);
+      return def && def.action.kind === "firearm" ? options.arsenal.calibers.get(def.action.caliber)?.caseType : void 0;
+    });
+    let counter = 0;
+    return {
+      /** Plays what the event asks for and answers how many effects started. */
+      handle(event, sink) {
+        if (!sink || event.type !== "shot" || !event.origin) return 0;
+        const caseType = caseTypeOf(event.weapon) ?? "rifle";
+        const entry = ids[caseType];
+        if (!entry) return 0;
+        const direction = event.direction ?? [0, 0, -1];
+        const seed = ++counter;
+        let started = 0;
+        for (let shot = 0; shot < Math.max(1, event.rounds ?? 1); shot++) {
+          if (sink.play({ effect: entry.muzzle, point: event.origin, direction, seed: seed * 8 + shot }) !== null) started++;
+        }
+        const side = [direction[2], 0, -direction[0]];
+        const port = [
+          event.origin[0] - direction[0] * PORT_BACK + side[0] * PORT_RIGHT,
+          event.origin[1] - direction[1] * PORT_BACK,
+          event.origin[2] - direction[2] * PORT_BACK + side[2] * PORT_RIGHT
+        ];
+        if (sink.play({ effect: entry.casing, point: port, direction, seed: seed * 8 + 7 }) !== null) started++;
+        return started;
+      }
+    };
+  }
+
   // src/area.ts
   var WEAPON_ITEM_PREFIX = "weapon_";
   var COUNTER_ITEM_ID = "counter_weapons";
@@ -20288,7 +20335,9 @@ ${problems.map((problem) => `  - ${problem}`).join("\n")}`);
           } else if (change.kind === "control" && change.id === "sound_distance" && typeof change.value === "number") soundDistance = change.value;
           else if (change.kind === "control" && change.id === "fuse_length" && typeof change.value === "number") lent.configureTool?.({ fuse_length: String(change.value) });
         });
+        const worldEffects = createWorldEffects({ arsenal });
         const offEvents = lent.on((event) => {
+          worldEffects.handle(event, lent.effects);
           if (event.type === "explosion") {
             const away = Math.hypot(event.point[0] - camera.position.x, event.point[1] - camera.position.y, event.point[2] - camera.position.z);
             audio?.play("explosion", Math.min(1, EXPLOSION_VOLUME_BASE + event.radius * EXPLOSION_VOLUME_PER_METRE), away);