@sandustry-modding/types 0.1.0

package/sandkit/engine/api/coloringTool.d.ts

@@ -0,0 +1,56 @@
+/**
+ * `sandkit.engine.api.coloringTool` — paint-bucket and flood-fill structure coloring.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace coloringTool {
+  /**
+   * Apply a color to one structure.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function colorStructure(...args: unknown[]): unknown;
+  /**
+   * Flood-fill connected structures with a color.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function floodFillColor(...args: unknown[]): unknown;
+  /**
+   * Return the color on a structure.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getColor(...args: unknown[]): unknown;
+  /**
+   * Return whether a structure can be colored.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function isColorableStructure(...args: unknown[]): unknown;
+  /**
+   * Return whether match-color mode is active.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function isMatchColorMode(...args: unknown[]): unknown;
+  /**
+   * Return whether paint-bucket mode is active.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function isPaintBucketMode(...args: unknown[]): unknown;
+  /**
+   * Set the color on a structure.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function setColor(...args: unknown[]): unknown;
+  /**
+   * Toggle match-color mode on or off.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function toggleMatchColorMode(...args: unknown[]): unknown;
+  /**
+   * Toggle paint-bucket mode on or off.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function togglePaintBucketMode(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/conveyors.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.conveyors` — conveyor type registration.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace conveyors {
+  /**
+   * Register a custom conveyor type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function registerType(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/debug.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.debug` — debug overlay registration.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace debug {
+  /**
+   * Register a debug overlay or helper.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function register(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/drones.d.ts

@@ -0,0 +1,21 @@
+/**
+ * `sandkit.engine.api.drones` — drone spawn and removal.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace drones {
+  /**
+   * Remove one or more drones.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function kill(...args: unknown[]): unknown;
+  /**
+   * Spawn a drone instance.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function spawn(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/entities.d.ts

@@ -0,0 +1,66 @@
+/**
+ * `sandkit.engine.api.entities` — entity type registration, spawn, and queries.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace entities {
+  /**
+   * Create a light entity attached to a parent.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function createLight(...args: unknown[]): unknown;
+  /**
+   * Return all live entities.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAll(...args: unknown[]): unknown;
+  /**
+   * Return all entities of one type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAllByType(...args: unknown[]): unknown;
+  /**
+   * Return all registered entity type definitions.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAllTypeDefs(...args: unknown[]): unknown;
+  /**
+   * Return the sprite for an entity.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getSprite(...args: unknown[]): unknown;
+  /**
+   * Return one entity type definition by id.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getTypeDef(...args: unknown[]): unknown;
+  /**
+   * Launch an entity with velocity or trajectory.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function launch(...args: unknown[]): unknown;
+  /**
+   * Register an entity spawner behavior.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function registerSpawner(...args: unknown[]): unknown;
+  /**
+   * Register a custom entity type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function registerType(...args: unknown[]): unknown;
+  /**
+   * Spawn an entity instance.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function spawn(...args: unknown[]): unknown;
+  /**
+   * Start capturing entities for a tool or effect.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function startCapture(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/extensions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.extensions` — structure extension definitions.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace extensions {
+  /**
+   * Define a structure extension type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function define(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/factory.d.ts

@@ -0,0 +1,56 @@
+/**
+ * `sandkit.engine.api.factory` — factory tier progression and process tracking.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace factory {
+  /**
+   * Add viability gold toward the next factory tier.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function addViabilityGold(...args: unknown[]): unknown;
+  /**
+   * Return whether the next factory tier can be unlocked.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function canUnlockNextTier(...args: unknown[]): unknown;
+  /**
+   * Ensure at least the given process count has been recorded.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function ensureProcessAtLeast(...args: unknown[]): unknown;
+  /**
+   * Apply deferred factory level-ups.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function flushDeferredLevelUps(...args: unknown[]): unknown;
+  /**
+   * Return the current factory level.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getLevel(...args: unknown[]): unknown;
+  /**
+   * Return total recorded process count.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getProcessCount(...args: unknown[]): unknown;
+  /**
+   * Return the current process rate.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getProcessRate(...args: unknown[]): unknown;
+  /**
+   * Record one factory process event.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function recordProcess(...args: unknown[]): unknown;
+  /**
+   * Unlock the next factory tier.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function unlockNextTier(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/foliage.d.ts

@@ -0,0 +1,31 @@
+/**
+ * `sandkit.engine.api.foliage` — procedural foliage generation and clusters.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace foliage {
+  /**
+   * Generate foliage for a region or world chunk.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function generate(...args: unknown[]): unknown;
+  /**
+   * Return foliage cluster data.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getClusters(...args: unknown[]): unknown;
+  /**
+   * Return the foliage render container.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getContainer(...args: unknown[]): unknown;
+  /**
+   * Return whether procgen foliage data exists for a location.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function hasProcgenData(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/foundationColorPicker.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.foundationColorPicker` — foundation tile color lookup.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace foundationColorPicker {
+  /**
+   * Return the color on a foundation tile.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getColor(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/game.d.ts

@@ -0,0 +1,26 @@
+/**
+ * `sandkit.engine.api.game` — game session start, save, and load.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace game {
+  /**
+   * Load a saved game into the session.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function load(...args: unknown[]): unknown;
+  /**
+   * Save the current session.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function save(...args: unknown[]): unknown;
+  /**
+   * Start a new game session.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function start(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/heatTransfer.d.ts

@@ -0,0 +1,46 @@
+/**
+ * `sandkit.engine.api.heatTransfer` — temperature diffusion and absorption.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace heatTransfer {
+  /**
+   * Absorb heat from adjacent elements into a cell.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function absorbAdjacentElements(...args: unknown[]): unknown;
+  /**
+   * Add temperature to a cell or region.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function addTemperature(...args: unknown[]): unknown;
+  /**
+   * Compute diffused temperatures for connected cells.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function computeDiffusedTemperatures(...args: unknown[]): unknown;
+  /**
+   * Compute one equalized temperature across connected cells.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function computeEqualizedTemperature(...args: unknown[]): unknown;
+  /**
+   * Consume temperature near a point or cell.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function consumeTemperatureNear(...args: unknown[]): unknown;
+  /**
+   * Ensure a cell has at least the given temperature.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function ensureTemperature(...args: unknown[]): unknown;
+  /**
+   * Equalize temperature across a connected component.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function equalizeConnected(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * `sandkit.engine.api` — composed engine API namespaces.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Engine methods usually take **game state as the first argument** (`args[0]`);
+ * remaining `args` entries are method-specific. Names are shorter than the
+ * public `sandkit.api` surface. Engine-only members below are stubs until confirmed.
+ *
+ * @internal
+ */
+
+export * from "./augments";
+export * from "./auralite";
+export * from "./blueprints";
+export * from "./clipboard";
+export * from "./colorPicker";
+export * from "./coloringTool";
+export * from "./conveyors";
+export * from "./debug";
+export * from "./drones";
+export * from "./entities";
+export * from "./extensions";
+export * from "./factory";
+export * from "./foliage";
+export * from "./foundationColorPicker";
+export * from "./game";
+export * from "./heatTransfer";
+export * from "./launchers";
+export * from "./lightColorPicker";
+export * from "./matters";
+export * from "./misc";
+export * from "./portals";
+export * from "./prefabData";
+export * from "./prefabDecor";
+export * from "./prefabulator";
+export * from "./prismaline";
+export * from "./prismite";
+export * from "./queue";
+export * from "./shadows";
+export * from "./strataform";
+export * from "./swarmConsole";
+export * from "./sweeperDrone";
+export * from "./teleportZones";
+export * from "./tutorialBuild";
+export * from "./usageTracker";
+export * from "./wall";
+export * from "./workerLocal";

package/sandkit/engine/api/launchers.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.launchers` — launcher type registration.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace launchers {
+  /**
+   * Register a custom launcher type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function registerType(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/lightColorPicker.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.lightColorPicker` — light color lookup.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace lightColorPicker {
+  /**
+   * Return the color on a light structure.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getColor(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/matters.d.ts

@@ -0,0 +1,26 @@
+/**
+ * `sandkit.engine.api.matters` — matter type registration and solid updates.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace matters {
+  /**
+   * Resolve a matter type from an id string.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getMatterTypeFromId(...args: unknown[]): unknown;
+  /**
+   * Register a custom matter type.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function register(...args: unknown[]): unknown;
+  /**
+   * Run one solid-matter update step.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function runSolidUpdate(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/misc.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.misc` — miscellaneous structure behavior registration.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace misc {
+  /**
+   * Register a miscellaneous structure behavior.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function register(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/portals.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `sandkit.engine.api.portals` — portal marker queries.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace portals {
+  /**
+   * Return portal markers in the world.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getMarkers(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/prefabData.d.ts

@@ -0,0 +1,36 @@
+/**
+ * `sandkit.engine.api.prefabData` — prefab artifact and metadata lookup.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace prefabData {
+  /**
+   * Return all prefab data entries.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAll(...args: unknown[]): unknown;
+  /**
+   * Return metadata for all prefabs.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAllMetadata(...args: unknown[]): unknown;
+  /**
+   * Return artifact locations for prefabs.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getArtifactLocations(...args: unknown[]): unknown;
+  /**
+   * Return prefab data at one grid cell.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAtCell(...args: unknown[]): unknown;
+  /**
+   * Return metadata for one prefab.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getMetadata(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/prefabDecor.d.ts

@@ -0,0 +1,21 @@
+/**
+ * `sandkit.engine.api.prefabDecor` — prefab decorative placement.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace prefabDecor {
+  /**
+   * Return a decor placement definition by name.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getPlacementByName(...args: unknown[]): unknown;
+  /**
+   * Replace decor instances in a region or prefab.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function replaceDecor(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/prefabulator.d.ts

@@ -0,0 +1,21 @@
+/**
+ * `sandkit.engine.api.prefabulator` — blueprint structure serialization for prefabs.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace prefabulator {
+  /**
+   * Convert serialized blueprint structures to world-local coordinates.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function localizeBlueprintStructures(...args: unknown[]): unknown;
+  /**
+   * Serialize blueprint structures for prefab storage.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function serializeBlueprintStructures(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/prismaline.d.ts

@@ -0,0 +1,26 @@
+/**
+ * `sandkit.engine.api.prismaline` — prismaline resource consume and availability.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace prismaline {
+  /**
+   * Consume prismaline from the player or world.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function consume(...args: unknown[]): unknown;
+  /**
+   * Return available prismaline amount.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAvailable(...args: unknown[]): unknown;
+  /**
+   * Return total prismaline consumed so far.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getConsumed(...args: unknown[]): unknown;
+}

package/sandkit/engine/api/prismite.d.ts

@@ -0,0 +1,26 @@
+/**
+ * `sandkit.engine.api.prismite` — prismite resource consume and availability.
+ *
+ * **Internal API.** Prefer {@link sandkit.api} when a public method exists.
+ * Methods use loose stubs; signatures may take game state as the first argument.
+ * Engine methods pass game state as the first argument (args[0]); remaining entries are method-specific.
+ *
+ * @internal
+ */
+export namespace prismite {
+  /**
+   * Consume prismite from the player or world.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function consume(...args: unknown[]): unknown;
+  /**
+   * Return available prismite amount.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getAvailable(...args: unknown[]): unknown;
+  /**
+   * Return total prismite consumed so far.
+   * @param args - Game state first, then method-specific arguments.
+   */
+  export function getConsumed(...args: unknown[]): unknown;
+}