@adatechnology/game-destruction 0.9.0 → 0.11.0

package/dist/index.d.ts

@@ -35,6 +35,28 @@ interface MaterialThermal {
     /** Smoke the material gives while burning (`black` for plastic and rubber). */
     smoke?: 'white' | 'grey' | 'black';
 }
+/** What one kind of blow does to a material where it lands (`MaterialDef.hits`). */
+interface MaterialHit {
+    /**
+     * Pieces torn out at the point hit: `splinters` (solid wood, plywood: long thin pieces along the grain), `lumps` (pressed fibre such as MDF:
+     * short crumbly pieces) or `none`. A round tears them out of the exit (and one in three out of the entry), a blow out of the face it lands on.
+     */
+    tear?: 'splinters' | 'lumps' | 'none';
+    /** Joules per torn piece (default 150). A blow weaker than one piece's worth tears nothing; a round always tears at least one. */
+    tearJoules?: number;
+    /**
+     * Joules per kilogram of a unit (`PartSpec.units`: a brick, a block of concrete) that knock it out of its part; blows of this kind wear the unit they
+     * land on (and a little the ones around it) until one comes out (`chip`). Default `breach.chipEnergy` of the world.
+     */
+    unitJoules?: number;
+    /**
+     * Joules of each blow that only scar the surface and wear no unit: a small round or a fist leaves a crater in concrete and takes nothing out, a heavy
+     * round takes what it carries above this (default 0).
+     */
+    floor?: number;
+    /** The blow leaves a crater in the bare surface of the material (a `spall` with `layer` -1) where it lands, with its dust and chips. */
+    crater?: boolean;
+}
 interface MaterialDef {
     id: MaterialId;
     /** Density in kg/m³ (used when a part has no `mass`). */
@@ -67,6 +89,11 @@ interface MaterialDef {
      * a ream, a magazine) and comes apart as thin loose scraps (`Fragment.inner` for the pages) instead of slabs as thick as the part.
      */
     sheet?: number;
+    /**
+     * What a blow of each damage type takes out of the material where it lands (the same blow does different things to different materials, and a shot
+     * is not a punch). See `MaterialHit`.
+     */
+    hits?: Partial<Record<DamageType, MaterialHit>>;
     /** Damage multipliers per damage type (default 1); `shelter` multiplies the resistance the material adds between a blast and a target (`blast.shelter`). */
     damageScale?: Partial<Record<DamageType | 'shelter', number>>;
     /** Debris emitted on a hit that does not break the part. */
@@ -336,6 +363,12 @@ interface DestructionOptions {
         radius?: number;
         /** Multiplier of the breach area a blast makes over a blow of the same damage: a blast loads the whole crater (default 6). */
         blastFactor?: number;
+        /**
+         * Joules per kilogram of a unit (`PartSpec.units`: a brick, a block) that knock it out of its wall: shots and blows wear the unit they land on and
+         * a little the ones around it, and a unit that took this much comes out (`chip` event). Default 200 (a 4 kg brick: two 9 mm rounds, one
+         * rifle round); 0 turns it off.
+         */
+        chipEnergy?: number;
     };
     /**
      * Speed of the blast front in m/s. A glass part at distance `d` from an explosion breaks `d / blastFrontSpeed` seconds later, in `update`
@@ -421,6 +454,17 @@ interface DestructionWorld {
     explode(point: Vec3, energy: number, radius: number, source?: string, options?: BlastOptions): HitResult[];
     /** Raycast against every part shape (world space). */
     raycast(origin: Vec3, direction: Vec3, maxDistance?: number): RayHit | null;
+    /**
+     * The first thing a world-axis box meets moving `distance` metres along `direction`, or null: a grid of rays leaves its leading faces, no gap wider than `spacing`
+     * (default 0.2 m). `ignore` is the object that is moving. What the box already overlaps does not stop it, so it can always back out.
+     */
+    sweepBox(box: {
+        readonly min: Vec3;
+        readonly max: Vec3;
+    }, direction: Vec3, distance: number, options?: {
+        readonly ignore?: string;
+        readonly spacing?: number;
+    }): RayHit | null;
     /** Ballistic shot: raycast, hit, and continue through with the exit energy (up to 4 objects/parts). */
     shoot(origin: Vec3, direction: Vec3, energy: number, caliber: number, source?: string, round?: number | BallisticExtras): HitResult[];
     /**
@@ -504,8 +548,14 @@ interface PartRuntime {
     spalls?: Array<[number, number, number, number, number, number]>;
     /** Through damage so far: `[x, y, z, area]` in object space, newest last. */
     breach?: Array<[number, number, number, number]>;
+    /** Energy each unit of the part took so far (`breach.chipEnergy`), by its index in the unit grid; -1 when the unit came out. */
+    chips?: Record<number, number>;
     /** Mass in kg that left the part in a breach. */
     removed?: number;
+    /** Damage taken by each band across a long wooden part (`splinter`), by band index from its negative end: the band that runs out breaks it there. */
+    cuts?: Record<number, number>;
+    /** Where along its long axis (part space) the part broke across (`cuts`). */
+    cutAt?: number;
     /** Plastic rotation in radians a reinforced beam or slab took in bending (blasts add it up; `flexure.failRotationDeg` breaks it). */
     hinge?: number;
 }
@@ -1304,4 +1354,4 @@ declare const tensionCapacity: (dims: Vec3, o: {
     tensileMPa?: number;
 }) => number;
 
-export { ASSEMBLIES, type AddOptions, type AssemblyDef, type AssemblyPartOptions, type BearingWallOptions, type BendGeometry, type BendSection, CONFINEMENT_DEFAULTS, type ChainTrigger, type CheckOptions, type DestructionLocale, type DestructionOptions, type DestructionSnapshot, type DestructionStrings, type DestructionWorld, type ExplosivePartOptions, FIRE_PRIME_C, FLEXURE_DEFAULTS, FRAGMENT_HIT_DEFAULTS, type FlexureOptions, type FoundationSolve, type FrameOptions, GRAVITY, type Gust, JOINT_BY_MATERIALS, JOINT_DEFAULTS, MASONRY_DEFAULTS, MATERIALS, type MasonryOptions, type MaterialDef, type MaterialStrength, type MaterialThermal, type ObjectRuntime, type PartRuntime, type ResolvedWind, SHELTER_DEFAULTS, SOILS, SOIL_DEFAULTS, type SectionMoments, type SizeStructureOptions, type SoilDef, type SoilKind, type SoilOptions, type SoilSpring, type SwayState, type SwaySystem, type TensionSteel, WIND_DEFAULTS, WIND_TERRAIN, type WallFrameSolution, type WindAnalysis, type WindCase, type WindOptions, type WindPartInput, type WindTerrainDef, type WorldExplosive, analyzeWind, assemblyDepth, assemblyPart, bearingWallThickness, bendGeometry, blastImpulse, buildFrame, checkDestructible, crackingMoment, createDestruction, damperAmplification, damperTuning, elasticEnergy, explosivePart, exposureOf, footingArea, footingSoil, fragility, getAssembly, guessMaterial, gustAt, heightFactor, impulseEnergy, inferJoints, layersBetween, locales, makeGust, meanHeightFactor, momentNodes, momentOfEnergy, partCapacity, partMass, partThickness, partVolume, pileCapacity, pileLength, pileStiffness, profileOf, quat, quatFromEuler, registerAssembly, resolveStrings, resolveWind, rotateVec, sectionMoments, shapeAt, shearNodes, sizeRebar, sizeStructure, slendernessFactor, soilAt, solveFoundation, solveWallFrame, spanMoment, spanOf, steelMoment, stepSway, stiffnessCentre, subgradeModulus, tBeamInertia, tensionCapacity, tensionSteel, toLocal, toWorld, turbulenceIntensity, vec, windClass, windPressure };
+export { ASSEMBLIES, type AddOptions, type AssemblyDef, type AssemblyPartOptions, type BearingWallOptions, type BendGeometry, type BendSection, CONFINEMENT_DEFAULTS, type ChainTrigger, type CheckOptions, type DestructionLocale, type DestructionOptions, type DestructionSnapshot, type DestructionStrings, type DestructionWorld, type ExplosivePartOptions, FIRE_PRIME_C, FLEXURE_DEFAULTS, FRAGMENT_HIT_DEFAULTS, type FlexureOptions, type FoundationSolve, type FrameOptions, GRAVITY, type Gust, JOINT_BY_MATERIALS, JOINT_DEFAULTS, MASONRY_DEFAULTS, MATERIALS, type MasonryOptions, type MaterialDef, type MaterialHit, type MaterialStrength, type MaterialThermal, type ObjectRuntime, type PartRuntime, type ResolvedWind, SHELTER_DEFAULTS, SOILS, SOIL_DEFAULTS, type SectionMoments, type SizeStructureOptions, type SoilDef, type SoilKind, type SoilOptions, type SoilSpring, type SwayState, type SwaySystem, type TensionSteel, WIND_DEFAULTS, WIND_TERRAIN, type WallFrameSolution, type WindAnalysis, type WindCase, type WindOptions, type WindPartInput, type WindTerrainDef, type WorldExplosive, analyzeWind, assemblyDepth, assemblyPart, bearingWallThickness, bendGeometry, blastImpulse, buildFrame, checkDestructible, crackingMoment, createDestruction, damperAmplification, damperTuning, elasticEnergy, explosivePart, exposureOf, footingArea, footingSoil, fragility, getAssembly, guessMaterial, gustAt, heightFactor, impulseEnergy, inferJoints, layersBetween, locales, makeGust, meanHeightFactor, momentNodes, momentOfEnergy, partCapacity, partMass, partThickness, partVolume, pileCapacity, pileLength, pileStiffness, profileOf, quat, quatFromEuler, registerAssembly, resolveStrings, resolveWind, rotateVec, sectionMoments, shapeAt, shearNodes, sizeRebar, sizeStructure, slendernessFactor, soilAt, solveFoundation, solveWallFrame, spanMoment, spanOf, steelMoment, stepSway, stiffnessCentre, subgradeModulus, tBeamInertia, tensionCapacity, tensionSteel, toLocal, toWorld, turbulenceIntensity, vec, windClass, windPressure };