@adatechnology/game-contracts 0.24.0 → 0.26.0

package/dist/index.d.ts

@@ -835,6 +835,8 @@ type DestructionEvent = (EventBase & {
  * One unit of a wall of units (`PartSpec.units`: a brick, a block) came out under shots or blows: `center` in world space, `size` in the part's own
  * axes and `rotation` the part's world rotation (the box of the unit that left), `fragments` the unit itself. The part stays: draw the gap, do not hide it.
  * With `torn`, nothing left the part but what a blow tore off its face (splinters of wood, lumps of MDF): the hole and the marks around it stay drawn.
+ * With `units`, a blast knocked many units out at once: each one's box (`center` in world space, `size` in the part's axes, turned by `rotation`), and
+ * `center` and `size` are the box around them all.
  */
  | (EventBase & {
     type: 'chip';
@@ -844,6 +846,10 @@ type DestructionEvent = (EventBase & {
     rotation: Quat;
     fragments: readonly Fragment[];
     torn?: true;
+    units?: readonly {
+        center: Vec3;
+        size: Vec3;
+    }[];
 })
 /** Rebar of a reinforced part is bare: segments in world space. Empty `bars` means the cage is gone. */
  | (EventBase & {
@@ -990,7 +996,7 @@ interface BlastShove {
 }
 /**
  * The shove a blast gives to a body of `mass` kg whose centre is at `position`: away from the centre, lifted a little, with the speed
- * `min(maxSpeed, sqrt(2 * energy * reach * coupling / mass)) * (1 - distance / radius) ^ 2`. Undefined when the body is outside the radius or the speed is under `minSpeed`.
+ * `sqrt(reach) * min(maxSpeed, sqrt(2 * energy * coupling / mass)) * (1 - distance / radius) ^ 2`. Undefined when the body is outside the radius or the speed is under `minSpeed`.
  * The same rule moves the loose items and furniture of the test room and the people of the characters module, so a game that tunes the options tunes all of them.
  */
 declare function blastShove(blast: BlastSource, target: {
@@ -1075,6 +1081,17 @@ declare function stepKnock(knock: Knock, position: {
     y: number;
     z: number;
 }, dt: number, groundAt: (x: number, z: number) => number, alive: boolean): boolean;
+/**
+ * Throws a body at `velocity` (m/s, world): an occupant leaving a car through the glass, a pedestrian run over. The module that animates the body
+ * takes it on its next frame (`takeLaunch`) and moves it as it moves a body a blast knocked down: flying, landing, sliding, lying, getting up.
+ */
+declare function launchBody(root: {
+    userData: Record<string, unknown>;
+}, velocity: Vec3): void;
+/** The throw `launchBody` left on the root, as a knock (knocked down, in the air), once; undefined when nothing threw it. */
+declare function takeLaunch(root: {
+    userData: Record<string, unknown>;
+}): Knock | undefined;
 
 interface CostOptions {
     /** Reads of `state()` and of `describe()` to time. Default 10 000. */
@@ -1550,6 +1567,16 @@ interface HandTargets {
 }
 /** Read every frame by whoever draws the arms; answers null while nothing is held. */
 type HandTargetSource = () => HandTargets | null;
+/** The muzzle of the tool in the hands as it is drawn now (world space): where a shot's flash and tracer leave, and which way the barrel points. */
+interface MuzzlePose {
+    readonly position: Vec3;
+    /** Unit vector along the barrel, out of the muzzle. */
+    readonly direction: Vec3;
+    /** The module draws the muzzle flash itself: the host draws none of its own. */
+    readonly drawsFlash: boolean;
+}
+/** Read by the host at each shot; null while the tool in the hands has no muzzle (a knife, a bare hand). */
+type MuzzleSource = () => MuzzlePose | null;
 
 /** How a hand turns something round in strokes (a screw cap, a tap handle, a knob): what `twistStroke` answers for one moment of the turning. */
 interface TwistStroke {
@@ -1896,6 +1923,11 @@ interface AudioSink {
     setListener?(listener: AudioListener): void;
     /** Adds a sound bank to the host's engine. `bank` is the engine's own type, `unknown` here because the contracts do not know it. */
     register?(bank: unknown): void;
+    /**
+     * Fetches and decodes the recorded files of these sounds now, so their first play is the recording and not the synthesized fallback (a door
+     * opened the moment the area loads). A host without recordings leaves it out; ids without files are ignored.
+     */
+    preload?(sounds: readonly string[]): void;
 }
 
 /** The weather, light and ground as the world is right now. Written by whoever drives the weather, read by whoever reacts to it. */
@@ -2197,6 +2229,8 @@ interface AreaPlacement {
 interface GroundZone {
     readonly rect: readonly [number, number, number, number];
     readonly surface: string;
+    /** Sign a renderer lays on the front edge of the zone (the side of +z). */
+    readonly label?: string;
 }
 /** What the floor is made of. `surface` is a ground profile id (`lawn`, `road`, `concrete_slab`, `tile_floor`...); a host that does not know it uses its default. */
 interface GroundLayout {
@@ -2557,6 +2591,11 @@ interface ModuleHost {
      * frame hooks have run, and puts the hands there. Pass null (or call the returned function) to let go. A host without arms leaves it out.
      */
     setHandTargets?(source: HandTargetSource | null): () => void;
+    /**
+     * Lends the host the muzzle of the tool the module draws in the hands: the host reads `source` at each shot and puts the tracer (and, unless the module draws one, the flash) there, at the
+     * muzzle of the model and not at a guess in front of the eye. Pass null (or call the returned function) to let go. A host that draws no shot effects leaves it out.
+     */
+    setMuzzleSource?(source: MuzzleSource | null): () => void;
     /**
      * Where the player's body holds a tool now (world space), in every view (the weapon is the body's own): `position` is the pocket of the right shoulder a stock rests on, `quaternion` turns
      * to the aim (-z the aim, x right, y up, as a camera). A module draws the tool there at its real size. Null for a host with no body (the module puts the same pocket under the camera's eye);
@@ -2585,6 +2624,8 @@ interface ModuleHost {
      * the panels and the room's other keys keep working. A host without a walking player leaves it out.
      */
     holdPlayer?(held: boolean): void;
+    /** True while a module holds the player (`holdPlayer(true)`): the keys then belong to that module, and another module's own keys (a weapon's accessories) stay out of its way. */
+    playerHeld?(): boolean;
     /** Lent only to a module that declares controls, layers or metrics. */
     bench?: ModuleBench;
     /** The host's shared sound engine; a module that makes sound uses it when lent and stays silent (or brings its own) when not. */
@@ -2870,4 +2911,4 @@ declare function footprintBlocker(object: FootprintObject | (() => FootprintObje
 /** @deprecated Import it from `@adatechnology/game-contracts/testing`. */
 declare const resetWarnOnce: () => void;
 
-export { type ActionControl, type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type AudioListener, type AudioSink, BLOW_IDS, BODY_FOLEY_IDS, BODY_SOUND_IDS, type BallisticExtras, type BenchChange, type BenchDeclaration, type BenchReport, type BenchSheet, type BlastImpulseOptions, type BlastOptions, type BlastReport, type BlastShove, type BlastShoveOptions, type BlastSource, type BlowId, type BlowTarget, type BodyFoleyId, type BodyRegion, type BodySlot, type BodySoundId, type BooleanControl, type BusyOptions, type BusySink, type BusyTask, type CategorizedOptions, type CategorizedReport, type CategoryDef, type CategoryOptions, type CategoryRegistry, type ChainDelay, type CheckOptions, type CheckSpecOptions, type ChoiceControl, type ChoiceOption, type ConfinementOptions, type ContainerSpec, type ContractChecker, type ContractContext, type ControlPatch, type ControlValue, type CostOptions, type Crack, DEFAULT_BLAST_IMPULSE, DEFAULT_BLAST_SHOVE, DEFAULT_ENVIRONMENT, DEFAULT_IGNITION_RULES, DEFAULT_SURFACE, DEFERRED_PRIORITY, DEFERRED_QUEUE_ID, type DamageStage, type DamageType, type DebrisKind, type DeepPartial, type DeferredQueue, type DeferredQueueOptions, type DeferredQueueReport, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type EffectHandle, type EffectRequest, type EffectSink, type Enclosure, type EnclosureBox, type EnvironmentBus, type EnvironmentKey, type EnvironmentState, type ExplosionChain, FOOTSTEP_SOUND_IDS, FRAGMENT_COVER, FRAME_PHASES, type FluidKind, type Footprint, type FootprintObject, type FootstepSoundId, type FractureStyle, type Fragment, type FragmentHitOptions, type FragmentMark, type FrameOptions, type FramePhase, GAIT_IDS, type GaitId, type GroundLayout, type GroundZone, HEAVY_LANDING_SPEED, type HandPose, type HandTargetSource, type HandTargets, type Hit, type HitIgnition, type HitResult, type Hole, type HostEvent, type HostGraphics, type HostReach, type HostTool, type HostToolAttachment, IMPACT_CONTRACT, type IgnitionRules, type ImpactContract, type ItemAnimationContract, type ItemSeat, type ItemSounds, type ItemUseDef, type JointKind, type JointSpec, type JointState, KIT_ORIGIN_KEY, KNOCKED_DOWN_ANGLE, KNOCK_CHEST, KNOCK_DOWN_SPEED, type KitOrigin, type Knock, LANDING_IDS, LAND_SOUND_IDS, type LandSoundId, type LandingId, type LiquidId, type LoopHandle, MATERIAL_SURFACES, MISSING_BITS, type MaterialId, type ModuleArea, type ModuleBench, type ModuleControl, type ModuleHost, type ModuleItemFluid, type ModuleItemSeal, type ModuleLayer, type ModuleMetric, type ModuleScenario, type ModuleView, type NumberControl, type ObjectState, type PartBreach, type PartShape, type PartSpec, type PartState, type PartStatus, type PartUnits, type PileSpec, type PlayerState, type Quat, type RayHit, type Reinforcement, STAGE_EVENT, SURFACE_IDS, SWING_LEAD_SECONDS, type SealBlock, type SealSpec, type SealState, type SegmentKind, type ShelterOptions, type Shot, type SoilLayer, type SoilProfile, type SoilState, type SoundHandle, type SoundRequest, type SpecReport, type StructureRole, type SurfaceId, type SurfaceLayer, type SurfaceRay, type SurfaceRayHit, TOOL_CLIP, TWIST_LIFT, type TensionRebar, type TestableItem, type TestableModule, type Thumbnail, type ToolAnimationStep, type ToolAnimator, type ToolClipId, type ToolClipPlayer, type ToolClipPlayerOptions, type ToolClipSet, type ToolCommand, type ToolCommandResult, type ToolKind, type ToolRig, type TunedMassDamper, type TwistOptions, type TwistStroke, type UnmarkedDrawing, type Use, type Vec3, type WarmUpProbes, type WindExposure, type WindState, applyPatches, blastBodySpeed, blastShove, bodyImpulse, bodyMass, checkAnimation, checkBench, checkCategorized, checkDeferredQueue, checkDestructible, checkHit, checkSpec, checkToolClips, createEnvironmentBus, createToolClipPlayer, deepMerge, defineCategories, fillFactor, footprintBlocker, footstepSoundId, hitSoundId, ignitionChance, isSurfaceId, kitOriginOf, knockOf, landSoundId, leadClipEvents, markKitOrigin, mergeById, removeIds, resetWarnOnce, resolveEntry, resolveIgnitionRules, sampleClip, scaleClip, sealBlock, sealOpener, shotExtras, shotToHit, sideOnImpulse, sparkTargetFactor, stepKnock, surfaceOfMaterial, swingSoundId, toolAnimationStep, twistStroke, unmarkedDrawings, useToHit };
+export { type ActionControl, type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type AudioListener, type AudioSink, BLOW_IDS, BODY_FOLEY_IDS, BODY_SOUND_IDS, type BallisticExtras, type BenchChange, type BenchDeclaration, type BenchReport, type BenchSheet, type BlastImpulseOptions, type BlastOptions, type BlastReport, type BlastShove, type BlastShoveOptions, type BlastSource, type BlowId, type BlowTarget, type BodyFoleyId, type BodyRegion, type BodySlot, type BodySoundId, type BooleanControl, type BusyOptions, type BusySink, type BusyTask, type CategorizedOptions, type CategorizedReport, type CategoryDef, type CategoryOptions, type CategoryRegistry, type ChainDelay, type CheckOptions, type CheckSpecOptions, type ChoiceControl, type ChoiceOption, type ConfinementOptions, type ContainerSpec, type ContractChecker, type ContractContext, type ControlPatch, type ControlValue, type CostOptions, type Crack, DEFAULT_BLAST_IMPULSE, DEFAULT_BLAST_SHOVE, DEFAULT_ENVIRONMENT, DEFAULT_IGNITION_RULES, DEFAULT_SURFACE, DEFERRED_PRIORITY, DEFERRED_QUEUE_ID, type DamageStage, type DamageType, type DebrisKind, type DeepPartial, type DeferredQueue, type DeferredQueueOptions, type DeferredQueueReport, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type EffectHandle, type EffectRequest, type EffectSink, type Enclosure, type EnclosureBox, type EnvironmentBus, type EnvironmentKey, type EnvironmentState, type ExplosionChain, FOOTSTEP_SOUND_IDS, FRAGMENT_COVER, FRAME_PHASES, type FluidKind, type Footprint, type FootprintObject, type FootstepSoundId, type FractureStyle, type Fragment, type FragmentHitOptions, type FragmentMark, type FrameOptions, type FramePhase, GAIT_IDS, type GaitId, type GroundLayout, type GroundZone, HEAVY_LANDING_SPEED, type HandPose, type HandTargetSource, type HandTargets, type Hit, type HitIgnition, type HitResult, type Hole, type HostEvent, type HostGraphics, type HostReach, type HostTool, type HostToolAttachment, IMPACT_CONTRACT, type IgnitionRules, type ImpactContract, type ItemAnimationContract, type ItemSeat, type ItemSounds, type ItemUseDef, type JointKind, type JointSpec, type JointState, KIT_ORIGIN_KEY, KNOCKED_DOWN_ANGLE, KNOCK_CHEST, KNOCK_DOWN_SPEED, type KitOrigin, type Knock, LANDING_IDS, LAND_SOUND_IDS, type LandSoundId, type LandingId, type LiquidId, type LoopHandle, MATERIAL_SURFACES, MISSING_BITS, type MaterialId, type ModuleArea, type ModuleBench, type ModuleControl, type ModuleHost, type ModuleItemFluid, type ModuleItemSeal, type ModuleLayer, type ModuleMetric, type ModuleScenario, type ModuleView, type MuzzlePose, type MuzzleSource, type NumberControl, type ObjectState, type PartBreach, type PartShape, type PartSpec, type PartState, type PartStatus, type PartUnits, type PileSpec, type PlayerState, type Quat, type RayHit, type Reinforcement, STAGE_EVENT, SURFACE_IDS, SWING_LEAD_SECONDS, type SealBlock, type SealSpec, type SealState, type SegmentKind, type ShelterOptions, type Shot, type SoilLayer, type SoilProfile, type SoilState, type SoundHandle, type SoundRequest, type SpecReport, type StructureRole, type SurfaceId, type SurfaceLayer, type SurfaceRay, type SurfaceRayHit, TOOL_CLIP, TWIST_LIFT, type TensionRebar, type TestableItem, type TestableModule, type Thumbnail, type ToolAnimationStep, type ToolAnimator, type ToolClipId, type ToolClipPlayer, type ToolClipPlayerOptions, type ToolClipSet, type ToolCommand, type ToolCommandResult, type ToolKind, type ToolRig, type TunedMassDamper, type TwistOptions, type TwistStroke, type UnmarkedDrawing, type Use, type Vec3, type WarmUpProbes, type WindExposure, type WindState, applyPatches, blastBodySpeed, blastShove, bodyImpulse, bodyMass, checkAnimation, checkBench, checkCategorized, checkDeferredQueue, checkDestructible, checkHit, checkSpec, checkToolClips, createEnvironmentBus, createToolClipPlayer, deepMerge, defineCategories, fillFactor, footprintBlocker, footstepSoundId, hitSoundId, ignitionChance, isSurfaceId, kitOriginOf, knockOf, landSoundId, launchBody, leadClipEvents, markKitOrigin, mergeById, removeIds, resetWarnOnce, resolveEntry, resolveIgnitionRules, sampleClip, scaleClip, sealBlock, sealOpener, shotExtras, shotToHit, sideOnImpulse, sparkTargetFactor, stepKnock, surfaceOfMaterial, swingSoundId, takeLaunch, toolAnimationStep, twistStroke, unmarkedDrawings, useToHit };

package/dist/index.global.js

@@ -76,6 +76,7 @@ var GameContracts = (() => {
     kitOriginOf: () => kitOriginOf,
     knockOf: () => knockOf,
     landSoundId: () => landSoundId,
+    launchBody: () => launchBody,
     leadClipEvents: () => leadClipEvents,
     markKitOrigin: () => markKitOrigin,
     mergeById: () => mergeById,
@@ -94,6 +95,7 @@ var GameContracts = (() => {
     stepKnock: () => stepKnock,
     surfaceOfMaterial: () => surfaceOfMaterial,
     swingSoundId: () => swingSoundId,
+    takeLaunch: () => takeLaunch,
     toolAnimationStep: () => toolAnimationStep,
     twistStroke: () => twistStroke,
     unmarkedDrawings: () => unmarkedDrawings,
@@ -103,6 +105,7 @@ var GameContracts = (() => {
 
   // src/blast-shove.ts
   var DEFAULT_BLAST_SHOVE = { coupling: 0.02, maxSpeed: 20, lift: 0.3, minSpeed: 0.3, falloffPower: 2 };
+  var clampShare = (share) => Math.min(1, Math.max(0, share));
   function blastShove(blast, target, options = {}) {
     const o = { ...DEFAULT_BLAST_SHOVE, ...options };
     const dx = target.position[0] - blast.point[0];
@@ -112,7 +115,8 @@ var GameContracts = (() => {
     if (!(blast.radius > 0) || distance > blast.radius) return void 0;
     const falloff = (1 - distance / blast.radius) ** o.falloffPower;
     const mass = Math.max(target.mass, 0.05);
-    const speed = Math.min(o.maxSpeed, Math.sqrt(2 * blast.energy * (blast.reach ?? 1) * o.coupling / mass)) * falloff;
+    const reach = clampShare(blast.reach ?? 1);
+    const speed = Math.sqrt(reach) * Math.min(o.maxSpeed, Math.sqrt(2 * blast.energy * o.coupling / mass)) * falloff;
     if (!(speed >= o.minSpeed)) return void 0;
     const direction = distance > 1e-4 ? [dx / distance, dy / distance + o.lift, dz / distance] : [0, 1, 0];
     const length = Math.hypot(direction[0], direction[1], direction[2]);
@@ -218,6 +222,16 @@ var GameContracts = (() => {
     } else if (knock.lying > 0) knock.lying = Math.max(0, knock.lying - dt / RISE_SECONDS);
     return !moving && !knock.down && knock.lying === 0;
   }
+  var LAUNCHED = "launched";
+  function launchBody(root, velocity) {
+    root.userData[LAUNCHED] = [velocity[0], velocity[1], velocity[2]];
+  }
+  function takeLaunch(root) {
+    const velocity = root.userData[LAUNCHED];
+    if (!velocity) return void 0;
+    delete root.userData[LAUNCHED];
+    return { velocity: [velocity[0], velocity[1], velocity[2]], airborne: true, lying: 0, lieLeft: 0, down: true };
+  }
 
   // src/impact-cost.ts
   var DEFAULT_COST_READS = 1e4;
@@ -1242,6 +1256,8 @@ var GameContracts = (() => {
     mortar: "concrete",
     stone: "concrete",
     brick: "concrete",
+    cobble: "concrete",
+    paver: "concrete",
     plaster: "concrete",
     asphalt: "asphalt",
     wood_soft: "wood",
@@ -1252,6 +1268,8 @@ var GameContracts = (() => {
     ceramic: "tile",
     plastic: "tile",
     soil: "dirt",
+    mud: "dirt",
+    clay: "dirt",
     wax: "dirt",
     flesh_fruit: "dirt",
     turf: "grass",
@@ -1259,6 +1277,8 @@ var GameContracts = (() => {
     cactus: "grass",
     gravel: "gravel",
     sand: "sand",
+    // no snow surface yet: packed snow crunches closest to sand underfoot
+    snow: "sand",
     steel: "metal",
     cast_iron: "metal",
     aluminium: "metal",