@johnmorrisdotca/uchusen-rockets 0.9.0 → 0.10.0

package/dist/model/fleet/modules.d.ts

@@ -0,0 +1,76 @@
+import type { Piece } from "../pieces.ts";
+import { type CollarClass } from "./collars.ts";
+import { type LiveryName } from "./detail.ts";
+import { type Ctx } from "./hull.ts";
+import type { KitModule } from "./types.ts";
+declare function engineCluster(count: 1 | 3 | 4 | 7, id: string, name: string, mass: number): KitModule;
+declare function tank(id: string, name: string, R: number, L: number, top: CollarClass, bottom: CollarClass, mass: number, propellant: number, note: string): KitModule;
+/** A standard container: 6 by 6 metres across and `L` long, with an M collar at each end so it stands on a spine or a cradle. */
+declare function container(id: string, name: string, L: number, cold: boolean, mass: number): KitModule;
+declare function habitatRing(id: string, name: string, major: number, mass: number): KitModule;
+/** A pressurised drum: crew or passenger quarters, or farms with glass bands. */
+declare function habitatDrum(id: string, name: string, R: number, L: number, mass: number, farm: boolean): KitModule;
+/** A radiator array: a hub drum with six wings, each stowed against the hull or deployed. */
+declare function radiatorArray(id: string, name: string, deployed: boolean, mass: number): KitModule;
+/** A docking node: a hub drum with ports looking up on a ring round it, so modules can stand parallel to the spine. */
+declare function dockingNode(id: string, name: string, count: number, cls: CollarClass, mass: number): KitModule;
+/** A truss: an open spine segment with four longerons, bays and a cable run, so long ships have a real skeleton between modules. */
+declare function truss(id: string, name: string, L: number, cls: CollarClass, mass: number): KitModule;
+/** An adapter: a cone from one collar class to the next, with a stiffening ring and bolt band. */
+declare function adapter(id: string, from: CollarClass, to: CollarClass, mass: number): KitModule;
+type Furniture = "bunks" | "bench" | "farm" | "cargo" | "bridge";
+/** A pressurised bay on M collars, with a band of windows and a stencilled number, and decks inside when opened. */
+declare function bay(o: {
+    id: string;
+    name: string;
+    note: string;
+    R: number;
+    L: number;
+    mass: number;
+    furniture: Furniture;
+    digits: string;
+    glass: "glass" | "plant" | "none";
+    livery: LiveryName;
+    spacing?: number;
+    slot?: string;
+    extra?: (ctx: Ctx, y0: number, y1: number) => Piece[];
+}): KitModule;
+/** A mission pod: a pod-sized drum on M collars that swaps for another of its slot; `survey` carries sample drones and a sensor boom, `medical` a rescue bay and a winch. */
+declare function missionPod(kind: "survey" | "medical"): KitModule;
+/**
+ * Every module of the fleet kit, by id: name, mass and size in metres, collars, ports and how to draw it.
+ *
+ * @example
+ * ```ts
+ * import { KIT } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(KIT).length, KIT["engine-fusion-7"].mass);
+ * ```
+ */
+export declare const KIT: Readonly<Record<string, KitModule>>;
+/**
+ * The kit's builders, for a ship that needs a module of its own size: a 40 m container, an 80 m tank, a 165 m ring, a 24 m truss bay. Each takes the numbers a module is made from and gives a `KitModule` with the same collars,
+ * detail and cutaway; the ship adds it to its list by putting it in its own table, or by `shipParts`.
+ *
+ * @example
+ * ```ts
+ * import { BUILDERS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const container40 = BUILDERS.container("my-container-40", "Container, 40 m", 40, false, 400);
+ * console.log(container40.length, container40.pieces({ detail: 0.4 }).length > 100);
+ * ```
+ */
+export declare const BUILDERS: {
+    readonly container: typeof container;
+    readonly tank: typeof tank;
+    readonly habitatRing: typeof habitatRing;
+    readonly habitatDrum: typeof habitatDrum;
+    readonly truss: typeof truss;
+    readonly radiatorArray: typeof radiatorArray;
+    readonly engineCluster: typeof engineCluster;
+    readonly adapter: typeof adapter;
+    readonly dockingNode: typeof dockingNode;
+    readonly bay: typeof bay;
+    readonly missionPod: typeof missionPod;
+};
+export {};