@adatechnology/game-contracts 0.14.0 → 0.16.0

package/dist/index.d.ts

@@ -620,6 +620,8 @@ interface Fragment {
     mass: number;
     /** Holes the part had where this fragment came from, in the fragment's own axes: the renderer keeps them on the debris. */
     marks?: readonly FragmentMark[];
+    /** Cut from inside the part (a page of a book, not its cover): the renderer draws it in the material's inner colour. */
+    inner?: boolean;
 }
 interface FragmentMark {
     /** Relative to the fragment's centre, in the fragment's axes. */
@@ -2190,4 +2192,33 @@ declare const checkCategorized: <TEntry extends {
     readonly id: string;
 }>(entries: readonly TEntry[], registry: CategoryRegistry, checkers: readonly ContractChecker<TEntry>[], options?: CategorizedOptions) => CategorizedReport;
 
-export { type ActionControl, type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type AudioListener, type AudioSink, type BallisticExtras, type BenchChange, type BenchDeclaration, type BenchReport, type BenchSheet, type BlastOptions, type BlastReport, type BlastShove, type BlastShoveOptions, type BlastSource, type BodyRegion, type BodySlot, 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 Crack, DEFAULT_BLAST_SHOVE, DEFAULT_ENVIRONMENT, DEFAULT_IGNITION_RULES, type DamageStage, type DamageType, type DebrisKind, type DeepPartial, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type EffectHandle, type EffectRequest, type EffectSink, type EnvironmentBus, type EnvironmentKey, type EnvironmentState, type ExplosionChain, type FluidKind, type FractureStyle, type Fragment, type FragmentHitOptions, type FragmentMark, type HandPose, type HandTargetSource, type HandTargets, type Hit, type HitIgnition, type HitResult, type Hole, type HostEvent, type HostTool, type HostToolAttachment, IMPACT_CONTRACT, type IgnitionRules, type ImpactContract, type ItemAnimationContract, type ItemUseDef, type JointKind, type JointSpec, type JointState, type LiquidId, type LoopHandle, MISSING_BITS, type MaterialId, type ModuleArea, type ModuleBench, type ModuleControl, type ModuleHost, type ModuleItemFluid, type ModuleLayer, type ModuleMetric, type ModuleScenario, 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, type SegmentKind, type ShelterOptions, type Shot, type SoilLayer, type SoilProfile, type SoilState, type SoundHandle, type SoundRequest, type SpecReport, type StructureRole, type SurfaceLayer, TOOL_CLIP, 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 Use, type Vec3, type WarmUpProbes, type WindExposure, type WindState, applyPatches, blastShove, checkAnimation, checkBench, checkCategorized, checkDestructible, checkHit, checkSpec, checkToolClips, createEnvironmentBus, createToolClipPlayer, deepMerge, defineCategories, fillFactor, ignitionChance, mergeById, removeIds, resolveEntry, resolveIgnitionRules, sampleClip, scaleClip, shotExtras, shotToHit, sparkTargetFactor, toolAnimationStep, useToHit };
+/**
+ * Where a drawn object comes from. Every builder of the kit that draws a piece (a car of the fleet, a house or a wall, a piece of furniture, a person, an
+ * animal, a plant, an item, a weapon) marks the root it returns, and every renderer that draws for the room (effects, debris, liquids, the room itself)
+ * marks its own roots, so a host can tell a piece of the kit from something drawn on the spot. Duck-typed on three.js objects (`userData`, `parent`,
+ * `children`), so the contracts stay free of three.js.
+ */
+declare const KIT_ORIGIN_KEY = "kitOrigin";
+/** What drew an object: the package and the kind of piece (`vehicle`, `structure`, `furniture`, `person`... or `effect`, `room` for what is not a piece). */
+interface KitOrigin {
+    readonly owner: string;
+    readonly kind: string;
+    /** The catalogue id of the piece, when it has one. */
+    readonly id?: string;
+    /** Drawn as a simple stand-in shape because the kit has no model of the piece yet (an item with no team model): a model still to make. */
+    readonly standIn?: boolean;
+}
+/** Marks `object` as drawn by `origin.owner` and returns it. */
+declare function markKitOrigin<T>(object: T, origin: KitOrigin): T;
+/** The origin of the object or of its nearest marked ancestor; null when nothing up the tree is marked. */
+declare function kitOriginOf(object: unknown): KitOrigin | null;
+/** A drawn thing that no builder of the kit marked: what was drawn on the spot. */
+interface UnmarkedDrawing {
+    /** The names of the object and its named ancestors, outermost first. */
+    readonly path: string;
+    readonly object: unknown;
+}
+/** Every visible mesh, line, point cloud or sprite under `root` with no marked ancestor (`root` itself not counted as one). */
+declare function unmarkedDrawings(root: unknown): UnmarkedDrawing[];
+
+export { type ActionControl, type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type AudioListener, type AudioSink, type BallisticExtras, type BenchChange, type BenchDeclaration, type BenchReport, type BenchSheet, type BlastOptions, type BlastReport, type BlastShove, type BlastShoveOptions, type BlastSource, type BodyRegion, type BodySlot, 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 Crack, DEFAULT_BLAST_SHOVE, DEFAULT_ENVIRONMENT, DEFAULT_IGNITION_RULES, type DamageStage, type DamageType, type DebrisKind, type DeepPartial, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type EffectHandle, type EffectRequest, type EffectSink, type EnvironmentBus, type EnvironmentKey, type EnvironmentState, type ExplosionChain, type FluidKind, type FractureStyle, type Fragment, type FragmentHitOptions, type FragmentMark, type HandPose, type HandTargetSource, type HandTargets, type Hit, type HitIgnition, type HitResult, type Hole, type HostEvent, type HostTool, type HostToolAttachment, IMPACT_CONTRACT, type IgnitionRules, type ImpactContract, type ItemAnimationContract, type ItemUseDef, type JointKind, type JointSpec, type JointState, KIT_ORIGIN_KEY, type KitOrigin, type LiquidId, type LoopHandle, MISSING_BITS, type MaterialId, type ModuleArea, type ModuleBench, type ModuleControl, type ModuleHost, type ModuleItemFluid, type ModuleLayer, type ModuleMetric, type ModuleScenario, 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, type SegmentKind, type ShelterOptions, type Shot, type SoilLayer, type SoilProfile, type SoilState, type SoundHandle, type SoundRequest, type SpecReport, type StructureRole, type SurfaceLayer, TOOL_CLIP, 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 UnmarkedDrawing, type Use, type Vec3, type WarmUpProbes, type WindExposure, type WindState, applyPatches, blastShove, checkAnimation, checkBench, checkCategorized, checkDestructible, checkHit, checkSpec, checkToolClips, createEnvironmentBus, createToolClipPlayer, deepMerge, defineCategories, fillFactor, ignitionChance, kitOriginOf, markKitOrigin, mergeById, removeIds, resolveEntry, resolveIgnitionRules, sampleClip, scaleClip, shotExtras, shotToHit, sparkTargetFactor, toolAnimationStep, unmarkedDrawings, useToHit };

package/dist/index.global.js

@@ -25,6 +25,7 @@ var GameContracts = (() => {
     DEFAULT_ENVIRONMENT: () => DEFAULT_ENVIRONMENT,
     DEFAULT_IGNITION_RULES: () => DEFAULT_IGNITION_RULES,
     IMPACT_CONTRACT: () => IMPACT_CONTRACT,
+    KIT_ORIGIN_KEY: () => KIT_ORIGIN_KEY,
     MISSING_BITS: () => MISSING_BITS,
     STAGE_EVENT: () => STAGE_EVENT,
     TOOL_CLIP: () => TOOL_CLIP,
@@ -43,6 +44,8 @@ var GameContracts = (() => {
     defineCategories: () => defineCategories,
     fillFactor: () => fillFactor,
     ignitionChance: () => ignitionChance,
+    kitOriginOf: () => kitOriginOf,
+    markKitOrigin: () => markKitOrigin,
     mergeById: () => mergeById,
     removeIds: () => removeIds,
     resolveEntry: () => resolveEntry,
@@ -53,6 +56,7 @@ var GameContracts = (() => {
     shotToHit: () => shotToHit,
     sparkTargetFactor: () => sparkTargetFactor,
     toolAnimationStep: () => toolAnimationStep,
+    unmarkedDrawings: () => unmarkedDrawings,
     useToHit: () => useToHit
   });
 
@@ -837,6 +841,38 @@ var GameContracts = (() => {
     }
     return { ok: problems.length === 0, problems: [...new Set(problems)], allowed };
   };
+
+  // src/origin.ts
+  var KIT_ORIGIN_KEY = "kitOrigin";
+  function markKitOrigin(object, origin) {
+    const node = object;
+    node.userData = node.userData ?? {};
+    node.userData[KIT_ORIGIN_KEY] = { ...origin };
+    return object;
+  }
+  function kitOriginOf(object) {
+    for (let node = object; node; node = node.parent) {
+      const origin = node.userData?.[KIT_ORIGIN_KEY];
+      if (origin && typeof origin.owner === "string") return origin;
+    }
+    return null;
+  }
+  function unmarkedDrawings(root) {
+    const out = [];
+    const pathOf = (node) => {
+      const names = [];
+      for (let n = node; n && n !== root; n = n.parent) if (n.name) names.push(n.name);
+      return names.reverse().join(" > ") || "(no name)";
+    };
+    const walk = (node, marked) => {
+      if (node.visible === false) return;
+      const here = marked || node !== root && Boolean(node.userData?.[KIT_ORIGIN_KEY]?.owner);
+      if (!here && (node.isMesh || node.isPoints || node.isLine || node.isSprite)) out.push({ path: pathOf(node), object: node });
+      for (const child of node.children ?? []) walk(child, here);
+    };
+    walk(root, false);
+    return out;
+  }
   return __toCommonJS(index_exports);
 })();
 //# sourceMappingURL=index.global.js.map