@onimaxxing/worldgen-node 0.15.0

package/oni_wasm.d.ts

@@ -0,0 +1,274 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Drop the cached cluster. Snapshot edits persist.
+ */
+export function clear_cluster_cache(): void;
+
+/**
+ * Evaluate a noise tree over a `width × height` 2D grid and return
+ * one `f32` per cell, row-major (`y * width + x`). Values are
+ * unnormalised; the consumer applies any colour ramp.
+ *
+ * `tree_kind`:
+ * - `"named"`: look up `tree_value` in the live `SettingsCache.noise`
+ *   map (the same map the editor mutates).
+ * - `"inline"`: parse `tree_value` as a YAML document in isolation.
+ *
+ * Output is bit-identical to the engine's own evaluation at the
+ * given seed. Sample coords map `width × height` linearly onto the
+ * tree's `settings.lowerBound..upperBound` rectangle (cell-centred),
+ * at `z = 0` (worldgen samples the XZ plane at y = 0).
+ */
+export function evaluate_noise(tree_kind: string, tree_value: string, width: number, height: number, seed: number): Float32Array;
+
+/**
+ * The ONI game build this WASM was parity-baselined against (e.g.
+ * `"737195"`).
+ */
+export function game_version(): string;
+
+/**
+ * Generate a cluster by cluster id + seed. Returns a `ClusterResult`
+ * JSON envelope. For the coordinate-string form (story traits +
+ * mixing) use `generate_from_coordinate`.
+ */
+export function generate_cluster(seed: number, cluster_id: string): string;
+
+/**
+ * Generate all worlds in a cluster and return per-cell polygon data for each.
+ *
+ * Returns JSON: `{ "cluster_id", "seed", "worlds": [{ "name", "width", "height", "is_starting", "cells": [...] }] }`
+ */
+export function generate_cluster_cells(seed: number, cluster_id: string): string;
+
+/**
+ * Generate a cluster with provided cluster YAML config override.
+ */
+export function generate_cluster_with_configs(seed: number, cluster_id: string, cluster_yaml: string, _world_yamls: string): string;
+
+/**
+ * Generate a cluster from a game coordinate string (e.g.
+ * `"SNDST-A-42-0-4A-MUWF1"`). Returns a `ClusterResult` JSON
+ * envelope; for the typed-array `MapData` shape use
+ * `generate_map_data`.
+ */
+export function generate_from_coordinate(coordinate: string): string;
+
+/**
+ * Generate the layout for a cluster's starting world and return
+ * per-cell data as JSON: `{ cells: [{ site_id, x, y, type }, ...] }`.
+ * Used for cell-level comparison against C# reference snapshots.
+ */
+export function generate_layout_cells(seed: number, cluster_id: string): string;
+
+/**
+ * Generate a cluster from a game coordinate and return a `MapData`
+ * value: per-world element grids, biome cell polygons, entity spawns,
+ * and starmap locations. Caches the cluster for the two-phase API
+ * (`settle_cluster_advance`, `get_entity_spawners`).
+ *
+ * Per-cell grids ship as typed arrays (`Uint16Array`, `Float32Array`,
+ * etc.) on `JsValue` so JS consumers don't pay a JSON parse.
+ */
+export function generate_map_data(coordinate: string): any;
+
+/**
+ * Re-run ambient mob spawning against the cached cluster's current
+ * cell state and return the refreshed entity lists. Call after
+ * `settle_cluster_advance` chunks when settled liquid/gas flow may
+ * have invalidated earlier mob placements. Requires a prior
+ * `generate_map_data`. Template-placed entities (geysers, oil wells,
+ * props) persist across calls.
+ */
+export function get_entity_spawners(): string;
+
+/**
+ * Returns a JSON-encoded `NoiseNodeKindSpec[]` enumerating every
+ * noise node variant the engine recognises (primitives, filters,
+ * modifiers, transformers, selectors, combiners) plus its param
+ * schema. Static across the lifetime of the build.
+ */
+export function noise_node_kinds(): string;
+
+/**
+ * Toggle template placement. WASM-side counterpart of the native
+ * `SKIP_TEMPLATES` env var.
+ */
+export function set_skip_templates(skip: boolean): void;
+
+/**
+ * Drop both the SettingsCache and the cluster cache. The next
+ * `generate_*` call reloads the embedded stock defaults.
+ */
+export function settings_reset(): void;
+
+/**
+ * Advance the cached cluster's settle sim to `target_tick` and
+ * return a binary snapshot at that tick covering every world. Call
+ * repeatedly with increasing ticks to paint intermediate frames;
+ * `target_tick = 499` finalises the cluster.
+ *
+ * `target_tick` must be in `1..=499`. A tick `<=` the current cached
+ * tick re-emits the current frame. Returns an empty buffer on
+ * out-of-range tick or empty/stale cache; call `generate_map_data`
+ * first to populate.
+ *
+ * Binary format (all little-endian, v5):
+ * - `u32` version tag (= 5)
+ * - `u32` tick
+ * - `u32` world count
+ * - per world: `u32` width, `u32` height, then `width * height`
+ *   cells of 25 bytes each: `u16 elem, f32 mass, f32 temp, u8 dis,
+ *   i32 dis_count, u16 bw_elem, f32 bw_mass, f32 bw_temp`. Worlds
+ *   without `backwallNoise` emit Vacuum + 0 mass + 0 temp.
+ */
+export function settle_cluster_advance(target_tick: number): Uint8Array;
+
+/**
+ * Drain the in-memory log buffer for `channel` (e.g. `"ppc_prng"`).
+ * WASM-side stand-in for native diag sites that would write to
+ * `std::fs::*`.
+ */
+export function sim_env_drain_log(channel: string): string;
+
+/**
+ * Set a `(key, value)` in the cross-target env overlay read by
+ * `oni_sim::sim_env::var`. WASM-side stand-in for the `SIM_*_PATH` /
+ * `SIM_*_TICK` env vars used by native diag sites.
+ */
+export function sim_env_set(key: string, value: string): void;
+
+/**
+ * Stable hex hash of a snapshot JSON. Alias of
+ * `snapshot_checksum_canonical`; same content always hashes to the
+ * same value regardless of HashMap/IndexMap iteration order.
+ */
+export function snapshot_checksum(snapshot_json: string): string;
+
+/**
+ * Byte-hash variant: FNV-1a-64 over the raw input bytes. Weak
+ * contract; same logical content with different HashMap/IndexMap
+ * iteration orders produces different hashes. Only safe when the
+ * consumer caches the exact bytes it hashed.
+ */
+export function snapshot_checksum_bytes(snapshot_json: string): string;
+
+/**
+ * Canonical-form variant: parses to a `serde_json::Value` (sorted
+ * keys at every level), then FNV-1a-64 with type tags + length
+ * prefixes. Same logical content always produces the same hash;
+ * what `snapshot_checksum` (the default) and `snapshot_state_checksum`
+ * route through.
+ */
+export function snapshot_checksum_canonical(snapshot_json: string): string;
+
+/**
+ * Build a `WorldgenSnapshot` from a `{path: JSON-string}` files map,
+ * apply it to SETTINGS, and return the resulting snapshot JSON.
+ * Strict mode.
+ */
+export function snapshot_from_files(files_json: string): string;
+
+/**
+ * Extensions-mode counterpart of `snapshot_from_files`.
+ */
+export function snapshot_from_files_extensions(files_json: string): string;
+
+/**
+ * Reset SETTINGS to the embedded U59 vanilla baseline and return the
+ * vanilla snapshot as a JSON string. Strict mode.
+ */
+export function snapshot_load_vanilla(): string;
+
+/**
+ * Extensions-mode counterpart of `snapshot_load_vanilla`. Subsequent
+ * `merge_files` calls accept mod-defined enum extensions.
+ */
+export function snapshot_load_vanilla_extensions(): string;
+
+/**
+ * Merge a `{path: JSON-string}` files map into an existing snapshot
+ * JSON. Last-wins on duplicate paths. Applies the merged snapshot to
+ * SETTINGS as a side effect.
+ */
+export function snapshot_merge_files(snapshot_json: string, files_json: string): string;
+
+/**
+ * Drop `paths_json` (a JSON array of path strings) from a snapshot
+ * JSON, apply the result to SETTINGS, and return the updated
+ * snapshot JSON. Paths not present are silently ignored; mode and
+ * element overrides are preserved.
+ */
+export function snapshot_remove_paths(snapshot_json: string, paths_json: string): string;
+
+/**
+ * Stable hex hash of the resident snapshot. Same content produces
+ * the same hash regardless of HashMap/IndexMap iteration order or
+ * load history. Auto-loads vanilla if empty.
+ */
+export function snapshot_state_checksum(): string;
+
+/**
+ * Drop the listed paths from the resident snapshot. `paths_json` is
+ * a JSON array of path strings; paths not present are silently
+ * ignored.
+ */
+export function snapshot_state_drop_paths(paths_json: string): number;
+
+/**
+ * Return the resident snapshot as a JSON-encoded
+ * `{path: JSON-string}` files map. Auto-loads vanilla if empty.
+ */
+export function snapshot_state_files(): string;
+
+/**
+ * Replace the resident snapshot from a `{path: JSON-string}` files
+ * map. Strict; atomic. Throws and leaves the snapshot untouched on
+ * invalid input.
+ */
+export function snapshot_state_load(files_json: string): number;
+
+/**
+ * Extensions-mode counterpart of `snapshot_state_load`. Subsequent
+ * merges inherit the Extensions mode from the loaded snapshot.
+ */
+export function snapshot_state_load_extensions(files_json: string): number;
+
+/**
+ * Merge a `{path: JSON-string}` files map into the resident snapshot.
+ * Last-wins on duplicate paths. Auto-loads vanilla if empty; atomic
+ * on parse failure. Mode is inherited from the resident snapshot.
+ */
+export function snapshot_state_merge(files_json: string): number;
+
+/**
+ * Clear the resident snapshot and bump the version. The next
+ * `snapshot_state_*` call auto-loads vanilla.
+ */
+export function snapshot_state_reset(): void;
+
+/**
+ * Reset the resident snapshot to the embedded vanilla baseline.
+ * Strict mode.
+ */
+export function snapshot_state_vanilla(): number;
+
+/**
+ * Same as `snapshot_state_vanilla`, Extensions mode. Subsequent
+ * merges accept mod-defined enum extensions.
+ */
+export function snapshot_state_vanilla_extensions(): number;
+
+/**
+ * Monotonic mutation counter. Bumps on every successful mutation;
+ * 0 if the slot has never been touched.
+ */
+export function snapshot_state_version(): number;
+
+/**
+ * Convert a snapshot JSON into a `{path: JSON-string}` files map.
+ * Round-trips back through `snapshot_from_files`.
+ */
+export function snapshot_to_files(snapshot_json: string): string;