@adatechnology/game-weapons-three 0.4.0 → 0.5.0

package/assets/weapon-svg/CREDITS.md

@@ -1,6 +1,6 @@
 # Créditos das miniaturas das armas
 
-130 miniaturas são geradas a partir do modelo 3D do próprio kit (licença MIT do repositório).
+142 miniaturas são geradas a partir do modelo 3D do próprio kit (licença MIT do repositório).
 18 vêm do Wikimedia Commons e mantêm a licença do autor (veja `LICENSE-NOTE.md`).
 
 | Arma | Autor | Licença | Página do arquivo | Arquivo original | Modificações |

package/assets/weapon-svg/credits.html

@@ -8,7 +8,7 @@
 </head>
 <body>
 <h1>Créditos das miniaturas das armas</h1>
-<p>130 miniaturas são geradas a partir do modelo 3D do próprio kit (licença MIT). 18 vêm do Wikimedia Commons e mantêm a licença do autor: veja <a href="LICENSE-NOTE.md">LICENSE-NOTE.md</a>.</p>
+<p>142 miniaturas são geradas a partir do modelo 3D do próprio kit (licença MIT). 18 vêm do Wikimedia Commons e mantêm a licença do autor: veja <a href="LICENSE-NOTE.md">LICENSE-NOTE.md</a>.</p>
 <table>
 <thead><tr><th>Arma</th><th>Autor</th><th>Licença</th><th>Página do arquivo</th><th>Modificações</th></tr></thead>
 <tbody>

package/assets/weapon-svg/generated/cast_iron_skillet.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M590.5 12 678.5 12 678.5 188 590.5 188 590.5 122 121.5 122 121.5 78 590.5 78Z"/><path d="M121.5 78 590.5 78 590.5 122 121.5 122Z"/></svg>

package/assets/weapon-svg/generated/chainsaw.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/hatchet.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/improvised_spear.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/iron_pipe.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M590.5 12 678.5 12 678.5 188 590.5 188 590.5 122 121.5 122 121.5 78 590.5 78Z"/><path d="M121.5 78 590.5 78 590.5 122 121.5 122Z"/></svg>

package/assets/weapon-svg/generated/meat_cleaver.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/nail_bat.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M590.5 12 678.5 12 678.5 188 590.5 188 590.5 122 121.5 122 121.5 78 590.5 78Z"/><path d="M121.5 78 590.5 78 590.5 122 121.5 122Z"/></svg>

package/assets/weapon-svg/generated/pickaxe.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/police_baton.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M590.5 12 678.5 12 678.5 188 590.5 188 590.5 122 121.5 122 121.5 78 590.5 78Z"/><path d="M121.5 78 590.5 78 590.5 122 121.5 122Z"/></svg>

package/assets/weapon-svg/generated/recurve_bow.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M20 12 780 12 780 188 20 188Z"/><path d="M20 12 780 12 780 188 20 188Z"/></svg>

package/assets/weapon-svg/generated/sickle.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/generated/tactical_knife.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200" fill="currentColor" fill-rule="evenodd"><path fill-opacity=".6" d="M186 66.5 788 66.5 788 133.5 186 133.5 186 120 12 120 12 80 186 80Z"/><path d="M12 80 186 80 186 120 12 120Z"/></svg>

package/assets/weapon-svg/manifest.json

@@ -109,6 +109,10 @@
    "source": "generated",
    "file": "generated/carl_gustaf_m4.svg"
   },
+  "cast_iron_skillet": {
+   "source": "generated",
+   "file": "generated/cast_iron_skillet.svg"
+  },
   "cbc_122": {
    "source": "generated",
    "file": "generated/cbc_122.svg"
@@ -121,6 +125,10 @@
    "source": "generated",
    "file": "generated/cbc_pump_military_3_0.svg"
   },
+  "chainsaw": {
+   "source": "generated",
+   "file": "generated/chainsaw.svg"
+  },
   "cheytac_m200": {
    "source": "generated",
    "file": "generated/cheytac_m200.svg"
@@ -277,6 +285,10 @@
    "source": "generated",
    "file": "generated/hammer.svg"
   },
+  "hatchet": {
+   "source": "generated",
+   "file": "generated/hatchet.svg"
+  },
   "hk416": {
    "source": "generated",
    "file": "generated/hk416.svg"
@@ -345,6 +357,14 @@
    "source": "generated",
    "file": "generated/improvised_flamethrower.svg"
   },
+  "improvised_spear": {
+   "source": "generated",
+   "file": "generated/improvised_spear.svg"
+  },
+  "iron_pipe": {
+   "source": "generated",
+   "file": "generated/iron_pipe.svg"
+  },
   "kel_tec_ksg": {
    "source": "generated",
    "file": "generated/kel_tec_ksg.svg"
@@ -413,6 +433,10 @@
    "source": "generated",
    "file": "generated/makarov_pm.svg"
   },
+  "meat_cleaver": {
+   "source": "generated",
+   "file": "generated/meat_cleaver.svg"
+  },
   "mg3": {
    "source": "generated",
    "file": "generated/mg3.svg"
@@ -437,6 +461,14 @@
    "source": "generated",
    "file": "generated/mossberg_500_cruiser.svg"
   },
+  "nail_bat": {
+   "source": "generated",
+   "file": "generated/nail_bat.svg"
+  },
+  "pickaxe": {
+   "source": "generated",
+   "file": "generated/pickaxe.svg"
+  },
   "pipe_bomb": {
    "source": "generated",
    "file": "generated/pipe_bomb.svg"
@@ -457,6 +489,10 @@
    "source": "generated",
    "file": "generated/pkm.svg"
   },
+  "police_baton": {
+   "source": "generated",
+   "file": "generated/police_baton.svg"
+  },
   "pp19_bizon": {
    "source": "generated",
    "file": "generated/pp19_bizon.svg"
@@ -469,6 +505,10 @@
    "source": "generated",
    "file": "generated/pry_bar.svg"
   },
+  "recurve_bow": {
+   "source": "generated",
+   "file": "generated/recurve_bow.svg"
+  },
   "remington_700": {
    "source": "generated",
    "file": "generated/remington_700.svg"
@@ -545,6 +585,10 @@
    "source": "generated",
    "file": "generated/shotgun_semi_12.svg"
   },
+  "sickle": {
+   "source": "generated",
+   "file": "generated/sickle.svg"
+  },
   "sig_mpx": {
    "source": "generated",
    "file": "generated/sig_mpx.svg"
@@ -597,6 +641,10 @@
    "source": "generated",
    "file": "generated/sw_model_29.svg"
   },
+  "tactical_knife": {
+   "source": "generated",
+   "file": "generated/tactical_knife.svg"
+  },
   "taurus_82": {
    "source": "generated",
    "file": "generated/taurus_82.svg"

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 };