@adatechnology/game-weapons-three 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -562,6 +562,8 @@ interface WeaponsTestModuleOptions {
     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_";
@@ -579,6 +581,25 @@ declare function createWeaponsTestModule(options?: WeaponsTestModuleOptions): Te
     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. */
@@ -681,4 +702,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, 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, 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, deriveFrames, fitAttachmentModels, hasWeaponModel, mechanicalSoundOf, modelKit, mountFrame, partRegistry, rigStock, rigUnderbarrel, weaponProp, 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_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 };