@v12-engine/engine 0.1.0 → 0.4.0

package/dist/save.js

@@ -0,0 +1,532 @@
+import { footprintOf } from "./defs.js";
+import { Entity, moving } from "./entity.js";
+import { plain as plain$1 } from "./plain.js";
+import { effectRef, resolveEffect } from "./effectRefs.js";
+import { waitingTimers } from "./timers.js";
+import { coreTimers, runningSequences } from "./sequences.js";
+import { redefinitions, restoreRedefinitions } from "./gameData.js";
+import { savedGround } from "./ground.js";
+import { sideKnowledge } from "./navigation/sidePaths.js";
+//#region src/save.ts
+/**
+* The format saves are written in now: a save of another is refused. The engine keeps no steps up from an older one
+* while it and its games are made (a game's own versions have `SaveRules.migrate`)
+*
+* @beta
+*/
+var SAVE_FORMAT = 5;
+/**
+* What a save keeps of an entity besides its id, type and owner, field by field: nothing else is written, and a save
+* that has anything else is refused. A field the engine adds is either here or among those it works out again
+* (`ENTITY_DERIVED`): a test holds every field of an entity to one of the two
+*
+* @internal
+*/
+var ENTITY_SAVE = [
+	"alive",
+	"hidden",
+	"scenery",
+	"pos",
+	"prevPos",
+	"facing",
+	"prevFacing",
+	"scale",
+	"look",
+	"likeness",
+	"velocity",
+	"health",
+	"seenBy",
+	"hurtAt",
+	"expires",
+	"lifetime",
+	"unseenIn",
+	"orders",
+	"maxHealth",
+	"mana",
+	"maxMana",
+	"asleep",
+	"reviving",
+	"abilities",
+	"buffs",
+	"on",
+	"cell",
+	"components"
+];
+/**
+* An entity's fields that are worked out again from the rest, or the engine's bookkeeping: never saved as they are.
+* Its components' values and their order (`slots`, `held`) are saved by id, as `components`, and filed again as it is
+* loaded
+*
+* @internal
+*/
+var ENTITY_DERIVED = [
+	"id",
+	"def",
+	"owner",
+	"statsCache",
+	"told",
+	"buffFlags",
+	"buffFlagsOf",
+	"spatialStamp",
+	"index",
+	"slots",
+	"held"
+];
+var SAVED_FIELDS = new Set(ENTITY_SAVE);
+/**
+* Saves a world, between two ticks. Throws, saying where, when something in it is not plain data
+*
+* @public
+*/
+function saveWorld(world, options = {}) {
+	const detached = /* @__PURE__ */ new Map();
+	const ref = (entity) => {
+		if (world.entities.get(entity.id) !== entity) detached.set(entity.id, entity);
+		return entity.id;
+	};
+	const hitGroups = /* @__PURE__ */ new Map();
+	const missileHits = [];
+	const { terrain } = world;
+	const save = {
+		format: 5,
+		game: world.registry.game,
+		version: world.registry.saveVersion,
+		hash: world.registry.hash,
+		tickRate: world.tickRate,
+		tick: world.tick,
+		winner: world.winner,
+		...world.disabled.size > 0 && { disabled: [...world.disabled.values()] },
+		...world.failure && { failure: structuredClone(world.failure) },
+		rng: world.rng.save(),
+		internals: plain(world.internals(), "commands"),
+		cheats: { ...world.cheats },
+		...world.fromMap.size > 0 && { fromMap: [...world.fromMap] },
+		terrain: savedGround(terrain, world.ground, world.registry.module?.maps, world.registry.module ?? {}),
+		players: [...world.players.values()].map((player) => ({
+			init: {
+				id: player.id,
+				name: player.name,
+				team: player.team,
+				color: [...player.color],
+				neutral: player.neutral,
+				creeps: player.creeps,
+				...player.race !== void 0 && { race: player.race }
+			},
+			resources: { ...player.resources },
+			supplyUsed: player.supplyUsed,
+			supplyCap: player.supplyCap,
+			...Object.keys(player.supplies).length > 0 && { supplies: structuredClone(player.supplies) },
+			established: player.established,
+			defeated: player.defeated,
+			upgrades: [...player.upgrades],
+			upgradesVersion: player.upgradesVersion,
+			researching: [...player.researching],
+			state: savedStates(world, player.states.values, `state of player ${player.id}`)
+		})),
+		fog: world.fog.save(),
+		navVersion: world.nav.version,
+		entities: [...world.entities.values()].map((entity) => saveEntity(world, entity)),
+		detached: [],
+		units: [...world.units.keys()],
+		sceneryInSight: Object.fromEntries([...world.sceneryInSight].map(([team, inSight]) => [team, [...inSight].map((entity) => entity.id)])),
+		projectiles: plain(world.projectiles, "projectiles"),
+		missiles: world.missiles.map((missile) => {
+			let group = hitGroups.get(missile.hit);
+			if (group === void 0) {
+				hitGroups.set(missile.hit, group = missileHits.length);
+				missileHits.push([...missile.hit]);
+			}
+			const { hit: _, effect, ...rest } = missile;
+			return {
+				...plain(rest, `missile ${missile.id}`),
+				hit: group,
+				effect: effectRef(world.registry, missile.ability, effect)
+			};
+		}),
+		missileHits,
+		delayed: world.delayed.map((delayed) => {
+			const { caster, ability, effects, ...rest } = delayed;
+			return {
+				...plain(rest, "delayed"),
+				caster: ref(caster),
+				ability: ability.id,
+				effects: effectRef(world.registry, ability.id, effects)
+			};
+		}),
+		zones: world.zones.map((zone) => {
+			const { caster, ability, effect, ...rest } = zone;
+			return {
+				...plain(rest, `zone ${zone.id}`),
+				caster: ref(caster),
+				ability: ability.id,
+				effect: effectRef(world.registry, ability.id, effect)
+			};
+		}),
+		reveals: plain(world.reveals, "reveals"),
+		items: plain(world.items, "items"),
+		state: savedStates(world, world.states.values, "state")
+	};
+	const systems = {};
+	for (const system of world.systems) if (system.save) systems[system.name] = plain(system.save(world), `system ${system.name}`);
+	if (Object.keys(systems).length) save.systems = systems;
+	save.detached = [...detached.values()].map((entity) => saveEntity(world, entity));
+	if (options.reseat !== false) {
+		world.nav.settle(save.navVersion);
+		world.nav.reseat(save.entities.flatMap((saved) => saved.agent ? [[saved.id, saved.agent]] : []));
+		world.nav.settle(save.navVersion);
+		world.saved();
+	}
+	return save;
+}
+function saveEntity(world, entity) {
+	const where = `${entity.def.id}#${entity.id}`;
+	const save = {
+		id: entity.id,
+		type: entity.def.id,
+		owner: entity.owner
+	};
+	for (const key of ENTITY_SAVE) {
+		const value = entity[key];
+		if (value === void 0) continue;
+		if (key === "components") save.components = savedComponents(world, entity, where);
+		else save[key] = plain(value, `${where}.${key}`);
+	}
+	const agent = entity.alive && !entity.hidden && entity.get(moving) ? world.nav.saveAgent(entity.id) : void 0;
+	if (agent) save.agent = agent;
+	return save;
+}
+/** An entity's components as a save keeps them: each as its component says (`Component.save`), or as it is */
+function savedComponents(world, entity, where) {
+	const saved = {};
+	for (const held of entity.heldComponents()) {
+		const { id } = held;
+		const value = entity.get(held);
+		const component = world.registry.component(id);
+		saved[id] = component?.save ? plain(component.save(value, world), `${where}.components.${id}`) : plain(value, `${where}.components.${id}`);
+	}
+	return saved;
+}
+/**
+* A world's or a player's state as a save keeps it: each component as it says (`Component.save`), or as it is. The
+* same hook as an entity's components, so that state kept in a form for the game as it runs (bytes, a `Map`) is
+* written as plain data here and made again by `load` (`loadedStates`)
+*/
+function savedStates(world, values, where) {
+	const saved = {};
+	for (const id in values) {
+		const component = world.registry.component(id);
+		saved[id] = component?.save ? component.save(values[id], world) : values[id];
+	}
+	return plain(saved, where);
+}
+/** A world's or a player's state from a save's copy of it: each component as its `load` makes it again (`savedStates`), in place */
+function loadedStates(registry, saved) {
+	for (const id in saved) {
+		const component = registry.component(id);
+		if (component?.load) saved[id] = component.load(saved[id], registry);
+	}
+	return saved;
+}
+/**
+* A copy of plain data: numbers, text, true and false, lists, and objects of those. Throws for anything else, saying
+* where, since it would not come back the same from a save: a `Map`, a `Set`, an entity, a function
+*/
+var plain = (value, where) => plain$1(value, where, "Save", "keep ids and plain objects in game state");
+/** The players of a save, as a world is made with them */
+var savedPlayers = (save) => save.players.map((player) => ({
+	...player.init,
+	resources: { ...player.resources }
+}));
+/**
+* Fills a world just made from the game module and the terrain and players of the save with the rest of it. The save
+* is one of the format and the version read now: an older one goes through `updateSave` first, as `loadWorld` does
+*/
+function restoreWorld(world, save) {
+	if (save.format !== 5) throw new SaveError(`Save: format ${save.format} is not one this game reads`, "notASave");
+	if (save.tickRate !== world.tickRate) throw new Error(`Save: made at ${save.tickRate} ticks a second, the world runs at ${world.tickRate}`);
+	const { registry } = world;
+	world.tick = save.tick;
+	world.winner = save.winner;
+	world.rng.restore(save.rng);
+	world.restoreInternals(save.internals);
+	restoreRedefinitions(registry, save.state[redefinitions.id]);
+	Object.assign(world.cheats, save.cheats);
+	for (const [object, entity] of save.fromMap ?? []) world.fromMap.set(object, entity);
+	for (const saved of save.players) {
+		const player = world.player(saved.init.id);
+		Object.assign(player.resources, saved.resources);
+		player.supplyUsed = saved.supplyUsed;
+		player.supplyCap = saved.supplyCap;
+		if (saved.supplies) player.supplies = structuredClone(saved.supplies);
+		player.established = saved.established;
+		player.defeated = saved.defeated;
+		for (const [upgrade, level] of saved.upgrades) player.setUpgrade(upgrade, level);
+		player.upgradesVersion = saved.upgradesVersion;
+		for (const upgrade of saved.researching) player.researching.add(upgrade);
+		Object.assign(player.states.values, loadedStates(registry, structuredClone(saved.state)));
+	}
+	world.fog.restore(save.fog);
+	const detached = new Map(save.detached.map((saved) => [saved.id, loadEntity(registry, saved)]));
+	world.nav.holdObstacles?.(true);
+	for (const saved of save.entities) {
+		const entity = loadEntity(registry, saved);
+		world.entities.set(entity.id, entity);
+		world.index.add(entity);
+		if (entity.isStructure && entity.alive) {
+			world.spatial.insertStatic(entity);
+			if (entity.cell) {
+				const fp = footprintOf(entity.def);
+				world.grid.occupy(entity.cell.x, entity.cell.z, fp.w, fp.d, entity.id);
+				if (!registry.standsOpen(entity) && !world.nav.addObstacle(entity.id, entity.rect)) world.log.warn("navigation", `There is no room for another obstacle: ${entity.def.id} does not block the way`, { entity: entity.id });
+			}
+		}
+	}
+	world.nav.holdObstacles?.(false);
+	world.restoreDead(save.internals.dead ?? []);
+	world.nav.settle(save.navVersion);
+	for (const saved of save.entities) if (saved.agent) world.nav.restoreAgent(saved.id, saved.agent);
+	world.nav.settle(save.navVersion);
+	for (const id of save.units) world.units.set(id, world.entities.get(id) ?? fail(`unit ${id} is not in the save`));
+	for (const [team, ids] of Object.entries(save.sceneryInSight)) world.sceneryInSight.set(Number(team), new Set(ids.map((id) => world.entities.get(id) ?? fail(`scenery ${id} is not in the save`))));
+	const entity = (id) => world.entities.get(id) ?? detached.get(id) ?? fail(`entity ${id} is not in the save`);
+	const ability = (id) => registry.ability(id);
+	world.projectiles.push(...structuredClone(save.projectiles));
+	const hits = save.missileHits.map((ids) => new Set(ids));
+	for (const missile of save.missiles) world.missiles.push({
+		...structuredClone(missile),
+		hit: hits[missile.hit],
+		effect: resolveEffect(registry, missile.ability, missile.effect)
+	});
+	for (const delayed of save.delayed) {
+		const { caster, ability: id, effects, ...rest } = structuredClone(delayed);
+		world.delayed.push({
+			...rest,
+			caster: entity(caster),
+			ability: ability(id),
+			effects: resolveEffect(registry, id, effects)
+		});
+	}
+	for (const zone of save.zones) {
+		const { caster, ability: id, effect, ...rest } = structuredClone(zone);
+		world.zones.push({
+			...rest,
+			caster: entity(caster),
+			ability: ability(id),
+			effect: resolveEffect(registry, id, effect)
+		});
+	}
+	world.reveals.push(...structuredClone(save.reveals));
+	Object.assign(world.states.values, loadedStates(registry, structuredClone(save.state)));
+	world.sidePaths?.restore(world, world.states.has(sideKnowledge) ? world.state(sideKnowledge) : {});
+	world.items.push(...structuredClone(save.items));
+	world.restoreSystems(save.systems ?? {});
+	if (save.disabled) world.disable(save.disabled);
+	if (save.failure) world.failure = structuredClone(save.failure);
+}
+function loadEntity(registry, saved) {
+	const { id, type, owner, agent: _, pos, ...fields } = structuredClone(saved);
+	const entity = new Entity(id, registry.unit(type), owner, pos);
+	for (const key of Object.keys(fields)) if (!SAVED_FIELDS.has(key)) fail(`${type}#${id} has "${key}", which is not a field of an entity a save keeps`);
+	for (const [key, value] of Object.entries(fields)) if (key === "components") for (const [componentId, value] of Object.entries(fields.components)) {
+		const component = registry.component(componentId);
+		entity.set(component, component.load ? component.load(value, registry) : value);
+	}
+	else entity.restore(key, value);
+	return entity;
+}
+function fail(what) {
+	throw new Error(`Save: ${what}`);
+}
+/**
+* A save that is not loaded, and why: for a list of saves to say, in words of its own
+*
+* @beta
+*/
+var SaveError = class extends Error {
+	reason;
+	missing;
+	constructor(message, reason, missing) {
+		super(message);
+		this.reason = reason;
+		this.missing = missing;
+		this.name = "SaveError";
+	}
+};
+/**
+* The header of a save
+*
+* @beta
+*/
+var saveHeader = (save) => ({
+	format: save.format,
+	game: save.game,
+	version: save.version ?? 1,
+	hash: save.hash
+});
+var isCount = (value) => typeof value === "number" && Number.isInteger(value) && value >= 1;
+/** What a game does about a save of its version made with other rules: what it says, else it loads when it declares `saves` at all */
+var mismatchPolicy = (registry) => registry.module?.saves?.onMismatch ?? (registry.module?.saves ? "load" : "refuse");
+function otherRules(header, registry) {
+	return new SaveError(`Save: made with another version of "${registry.game}" (${header.hash}, this is ${registry.hash}). Its rules or its mods changed since` + (registry.module?.saves ? "" : ": a game that declares Rules.saves loads it all the same"), "rules");
+}
+/** Why a save is refused that its header alone says: another game's, newer than this reads, or with no way up from its version */
+function headerProblem(header, registry) {
+	const { format } = header;
+	const version = header.version ?? 1;
+	if (!isCount(format)) return new SaveError(`Save: format ${String(format)} is not one this game reads`, "notASave");
+	if (!isCount(version)) return new SaveError(`Save: version ${String(version)} is not one this game reads`, "notASave");
+	if (header.game !== registry.game) return new SaveError(`Save: made with the game "${header.game}", not "${registry.game}"`, "game");
+	if (format > 5) return new SaveError(`Save: format ${format} is newer than this game reads (5): it was saved by a newer version of the game`, "newer");
+	if (format < 5) return new SaveError(`Save: format ${format} is older than this game reads (5)`, "noWay");
+	const to = registry.saveVersion;
+	if (version > to) return new SaveError(`Save: version ${version} of the saves of "${registry.game}" is newer than this game reads (${to}): it was saved by a newer version of the game`, "newer");
+	const migrate = registry.module?.saves?.migrate;
+	if (typeof migrate === "function") return void 0;
+	for (let from = version; from < to; from++) if (!migrate?.[from]) return new SaveError(`Save: version ${version} of the saves of "${registry.game}", and the game has no way from ${from} to ${from + 1} (Rules.saves.migrate)`, "noWay");
+}
+/**
+* Whether a game loads a save, as far as the save's header says (`saveHeader`): nothing, or why not. For a list of
+* saves, which has no need to read each of them whole. What only the whole save says (something in it the game no
+* longer has, a game that decides save by save) is found as it is loaded (`updateSave`, `loadWorld`)
+*
+* @beta
+*/
+function saveProblem(header, registry) {
+	const refused = headerProblem(header, registry);
+	if (refused) return refused;
+	if ((header.version ?? 1) === registry.saveVersion && header.hash !== registry.hash && mismatchPolicy(registry) === "refuse") return otherRules(header, registry);
+}
+/**
+* A save as the game reads it now, whatever it was saved by: brought up from an older version by the game's (`Rules.saves.migrate`), each one version at a time. `loadWorld` runs
+* it; a tool that keeps saves up to date runs it by itself. The save handed in is not changed. Throws a `SaveError`,
+* which says why, for one that cannot be read: another game's, newer than this game, of a version the game has no
+* step from, made with other rules by a game that refuses those (`anyVersion` loads it all the same), or with
+* something in it the game no longer has, all of which the error names
+*
+* @beta
+*/
+function updateSave(data, registry, options = {}) {
+	if (typeof data !== "object" || data === null) throw new SaveError("Save: not a save", "notASave");
+	const header = data;
+	const refused = headerProblem(header, registry);
+	if (refused) throw refused;
+	const from = header.version ?? 1;
+	const to = registry.saveVersion;
+	let save = data;
+	if (from < to) {
+		save = structuredClone(data);
+		const migrate = registry.module?.saves?.migrate;
+		if (typeof migrate === "function") {
+			if (from < to) save = migrate(save, from, to) ?? save;
+		} else for (let version = from; version < to; version++) save = migrate[version](save) ?? save;
+	}
+	if (from === to && header.hash !== registry.hash && !options.anyVersion) {
+		const policy = mismatchPolicy(registry);
+		if ((typeof policy === "function" ? policy(save, registry.hash) : policy) === "refuse") throw otherRules(header, registry);
+	}
+	const missing = missingIn(save, registry);
+	if (missing) {
+		const said = Object.entries(missing).map(([kind, ids]) => `the ${KINDS[kind]} ${ids.map((id) => `"${id}"`).join(", ")}`);
+		throw new SaveError(`Save: it has what "${registry.game}" does not have: ${said.join("; ")}. A step of the game's (Rules.saves.migrate) says what becomes of them`, "missing", missing);
+	}
+	return {
+		...save,
+		format: 5,
+		version: to,
+		hash: registry.hash
+	};
+}
+var KINDS = {
+	unit: "unit types",
+	ability: "abilities",
+	buff: "buffs",
+	item: "items",
+	upgrade: "upgrades",
+	order: "orders",
+	component: "components",
+	timer: "timers",
+	sequence: "sequences"
+};
+/**
+* What a save names that the game does not have: found before a world is made of it, and said all at once, where
+* each would otherwise throw by itself at the moment the game came to it, some of them minutes into the game loaded
+*/
+function missingIn(save, registry) {
+	const missing = {};
+	const check = (kind, has) => (id) => {
+		if (typeof id === "string" && !has(id) && !missing[kind]?.includes(id)) (missing[kind] ??= []).push(id);
+	};
+	const kept = save.state[redefinitions.id] ?? {};
+	const defined = (kind) => (id) => registry.kinds[kind].has(id) || typeof kept[kind]?.[id]?.["copyOf"] === "string";
+	const unit = check("unit", defined("units"));
+	const ability = check("ability", defined("abilities"));
+	const buff = check("buff", defined("buffs"));
+	const item = check("item", defined("items"));
+	const upgrade = check("upgrade", defined("upgrades"));
+	const order = check("order", (id) => registry.orders.has(id));
+	const component = check("component", (id) => registry.component(id) !== void 0);
+	const named = {
+		units: unit,
+		abilities: ability,
+		buffs: buff,
+		items: item,
+		upgrades: upgrade
+	};
+	const components = (values) => {
+		for (const [id, value] of Object.entries(values ?? {})) {
+			component(id);
+			const refs = registry.component(id)?.refs?.(value);
+			if (refs) for (const kind of Object.keys(refs)) refs[kind]?.forEach(named[kind]);
+		}
+	};
+	const placed = (effect) => !!effect && "path" in effect;
+	components(save.state);
+	for (const player of save.players) {
+		components(player.state);
+		for (const [id] of player.upgrades) upgrade(id);
+		for (const id of player.researching) upgrade(id);
+	}
+	for (const entity of [...save.entities, ...save.detached]) {
+		unit(entity.type);
+		components(entity.components);
+		for (const state of entity.abilities ?? []) ability(state.id);
+		for (const instance of entity.buffs ?? []) buff(instance.id);
+		for (const given of entity.orders ?? []) {
+			order(given.type);
+			unit(given.init?.unitType);
+		}
+	}
+	for (const missile of save.missiles) if (placed(missile.effect)) ability(missile.ability);
+	for (const delayed of save.delayed) ability(delayed.ability);
+	for (const zone of save.zones) ability(zone.ability);
+	for (const dropped of save.items) item(dropped.item);
+	const game = registry.module;
+	if (game) {
+		const timers = new Set([...coreTimers, ...registry.assembly?.timers ?? game.timers ?? []].map((def) => def.id));
+		const sequences = new Set((game.sequences ?? []).map((def) => def.id));
+		waitingTimers(save.state).forEach(check("timer", (id) => timers.has(id)));
+		runningSequences(save.state).forEach(check("sequence", (id) => sequences.has(id)));
+	}
+	return Object.keys(missing).length > 0 ? missing : void 0;
+}
+/**
+* A save as text. JSON, but for numbers JSON has no words for, which game state has: buffs that last forever
+* (`Infinity`), something never hurt (`-Infinity`)
+*
+* @beta
+*/
+function encodeSave(save) {
+	return JSON.stringify(save, (_key, value) => typeof value === "number" && !Number.isFinite(value) ? { $number: String(value) } : value);
+}
+/**
+* Reads a save back from text written by `encodeSave`, turning the stored non-finite numbers into numbers again
+*
+* @beta
+*/
+function decodeSave(text) {
+	return JSON.parse(text, (_key, value) => value && typeof value === "object" && Object.keys(value).length === 1 && typeof value.$number === "string" ? Number(value.$number) : value);
+}
+//#endregion
+export { ENTITY_DERIVED, ENTITY_SAVE, SAVE_FORMAT, SaveError, decodeSave, encodeSave, restoreWorld, saveHeader, saveProblem, saveWorld, savedPlayers, updateSave };
+
+//# sourceMappingURL=save.js.map

package/dist/save.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"save.js","names":["plainData"],"sources":["../src/save.ts"],"sourcesContent":["import type { ErrorSite, WorldFailure } from './errors'\nimport { sideKnowledge } from './navigation/sidePaths'\nimport { COPY_OF, type DataKind, redefinitions, restoreRedefinitions } from './gameData'\nimport type { AbilityDef } from './defs'\nimport { footprintOf } from './defs'\nimport type { SavedRefs } from './components'\nimport { type AbilityState, type BuffInstance, Entity, type EntityId, moving, type Order } from './entity'\nimport type { FogSave } from './fog'\nimport type { GroundItem } from './items'\nimport type { AgentSave } from './navigation/navigation'\nimport { effectRef, type EffectRef, resolveEffect } from './effectRefs'\nimport { plain as plainData } from './plain'\nimport type { PlayerInit, Purse } from './player'\nimport type { Registry } from './registry'\nimport { coreTimers, runningSequences } from './sequences'\nimport { savedGround, type SavedGround } from './ground'\nimport { waitingTimers } from './timers'\nimport type { Delayed, Missile, Projectile, Reveal, World, WorldInternals, Zone } from './world'\n\n/**\n * A world saved: everything it takes to carry on with a game later, somewhere else, or from the same moment more\n * than once. Plain data, and with `encodeSave` text: what is in the world points to definitions by id, and to\n * other entities by id.\n *\n * What is not in it:\n * - the game module (`WorldSave.game` names it), which `loadWorld` is given again;\n * - navigation, which is built again from the terrain and the structures, with the agents put back where they were;\n * - systems added while the game ran (`World.addSystem`), like a computer player: whoever loads adds them again,\n *   and what they keep in themselves (`System.save`) goes back into them as they are added;\n * - state a game module keeps outside the world, like in a `WeakMap` keyed by it. Keep it in components instead\n *   (`World.state`, `Player.state`, `Entity.get`), which are in here.\n *\n * Two numbers say how old a save is, and they are not the same thing. `format` is the engine's: the shape of the save\n * itself, which the engine brings up to date by itself. `version` is the game's: what the game keeps in a save (its\n * unit types, its components), which the game brings up to date (`Rules.saves`). A save is read through both\n * (`updateSave`), the engine's first\n *\n * @beta\n */\nexport interface WorldSave {\n\t/** The shape of the save itself (`SAVE_FORMAT`): the engine's to change, and to bring an older one up to */\n\tformat: typeof SAVE_FORMAT\n\t/** Id of the game module the world was made with */\n\tgame: string\n\t/** The version of what the game keeps in a save (`Rules.saves.version`): 1 for a game that says none */\n\tversion: number\n\t/**\n\t * Which rules it was made with exactly, mods and code included (see `gameHash`): whether it can be loaded as it is.\n\t * What a game does about a save of other rules is its own to say (`Rules.saves.onMismatch`)\n\t */\n\thash: string\n\t/** Ticks per second the world was running at */\n\ttickRate: number\n\t/** The tick number the world was at when saved */\n\ttick: number\n\t/** The winning team, or null while the game has none */\n\twinner: number | null\n\t/** The parts of the game switched off for having thrown (`world.disabled`): off again in the world loaded. None when left out */\n\tdisabled?: ErrorSite[]\n\t/** Why the game ended on an error (`world.failure`), for a save taken of one that did */\n\tfailure?: WorldFailure\n\t/** The state of the world's random generator (`Rng.save`), so the loaded game draws the same numbers */\n\trng: number\n\t/** The world's own counters and bookkeeping that are not entities (`WorldInternals`) */\n\tinternals: WorldInternals\n\t/** The cheats switched on in the world (`World.cheats`) */\n\tcheats: World['cheats']\n\t/** The entity each object of the map became, by the object's id (`World.fromMap`): as `[object, entity]`. None when left out */\n\tfromMap?: [number, EntityId][]\n\t/** The ground: all of it, or the map the world was made from and what changed of it since (S36, format 3) */\n\tterrain: SavedGround\n\t/** Each player's state: resources, supply, upgrades and the state of modules */\n\tplayers: PlayerSave[]\n\t/** What the fog of war keeps of what was seen */\n\tfog: FogSave\n\t/** Where walkable space was at: movement looks for a new path when it changes */\n\tnavVersion: number\n\t/** Everything in the world, in the order it was put there */\n\tentities: EntitySave[]\n\t/** Entities that left the world but are still pointed at, like the caster of something that has yet to land */\n\tdetached: EntitySave[]\n\t/** Ids of the entities that act, in the order they are gone through: who goes first can decide what happens */\n\t/** The entities that act (`World.units`), by id */\n\tunits: EntityId[]\n\t/** Scenery each team sees, by team */\n\tsceneryInSight: Record<number, EntityId[]>\n\t/** Projectiles in flight */\n\tprojectiles: Projectile[]\n\t/** Missiles in flight */\n\tmissiles: MissileSave[]\n\t/** What missiles sent together have passed through, which they share */\n\tmissileHits: EntityId[][]\n\t/** Things scheduled to happen later (`World.after`), with the time left to each */\n\tdelayed: DelayedSave[]\n\t/** Zones that act on what stands in them for a time */\n\tzones: ZoneSave[]\n\t/** Patches of ground revealed to a team for a time */\n\treveals: Reveal[]\n\t/** Items lying on the ground */\n\titems: GroundItem[]\n\t/** State of game modules and mods for the whole game, by component id (see `World.state`) */\n\tstate: Record<string, unknown>\n\t/** What systems keep in themselves (`System.save`), by their name */\n\tsystems?: Record<string, unknown>\n}\n\n/**\n * The format saves are written in now: a save of another is refused. The engine keeps no steps up from an older one\n * while it and its games are made (a game's own versions have `SaveRules.migrate`)\n *\n * @beta\n */\nexport const SAVE_FORMAT = 5\n\ninterface PlayerSave {\n\tinit: PlayerInit\n\tresources: Purse\n\tsupplyUsed: number\n\tsupplyCap: number\n\t/** The game's other pools (`RuleSettings.supply.pools`): left out of a save made before there were any */\n\tsupplies?: Record<string, { used: number; cap: number }>\n\testablished: boolean\n\tdefeated: boolean\n\tupgrades: [string, number][]\n\tupgradesVersion: number\n\tresearching: string[]\n\t/** State of game modules and mods for the player, by component id */\n\tstate: Record<string, unknown>\n}\n\n/**\n * An entity: its type, and every field it has, as plain data. `agent` is how it moves, when it does\n *\n * @beta\n */\nexport type EntitySave = { id: EntityId; type: string; owner: number; agent?: AgentSave } & Record<string, unknown>\n\ntype MissileSave = Omit<Missile, 'hit' | 'effect'> & { hit: number; effect: EffectRef }\ntype DelayedSave = Omit<Delayed, 'caster' | 'ability' | 'effects'> & { caster: EntityId; ability: string; effects: EffectRef }\ntype ZoneSave = Omit<Zone, 'caster' | 'ability' | 'effect'> & { caster: EntityId; ability: string; effect: EffectRef }\n\n/**\n * What a save keeps of an entity besides its id, type and owner, field by field: nothing else is written, and a save\n * that has anything else is refused. A field the engine adds is either here or among those it works out again\n * (`ENTITY_DERIVED`): a test holds every field of an entity to one of the two\n *\n * @internal\n */\nexport const ENTITY_SAVE = [\n\t'alive',\n\t'hidden',\n\t'scenery',\n\t'pos',\n\t'prevPos',\n\t'facing',\n\t'prevFacing',\n\t'scale',\n\t'look',\n\t'likeness',\n\t'velocity',\n\t'health',\n\t'seenBy',\n\t'hurtAt',\n\t'expires',\n\t'lifetime',\n\t'unseenIn',\n\t'orders',\n\t'maxHealth',\n\t'mana',\n\t'maxMana',\n\t'asleep',\n\t'reviving',\n\t'abilities',\n\t'buffs',\n\t'on',\n\t'cell',\n\t'components'\n] as const satisfies readonly (keyof Entity)[]\n\n/**\n * An entity's fields that are worked out again from the rest, or the engine's bookkeeping: never saved as they are.\n * Its components' values and their order (`slots`, `held`) are saved by id, as `components`, and filed again as it is\n * loaded\n *\n * @internal\n */\nexport const ENTITY_DERIVED = [\n\t'id',\n\t'def',\n\t'owner',\n\t'statsCache',\n\t'told',\n\t'buffFlags',\n\t'buffFlagsOf',\n\t'spatialStamp',\n\t'index',\n\t'slots',\n\t'held'\n] as const satisfies readonly (keyof Entity)[]\n\nconst SAVED_FIELDS = new Set<string>(ENTITY_SAVE)\n\n// ---- Saving\n\n/**\n * How a world is saved (`saveWorld`)\n *\n * @beta\n */\nexport interface SaveWorldOptions {\n\t/**\n\t * Whether the world's crowd is put back from what the save keeps of it, as loading the save puts it (determinism\n\t * D2): the game saved and a game loaded from the save then go on exactly the same. A save keeps where each agent is\n\t * and where it goes, not the crowd's own working (the order it moves its agents in, the paths it is part way\n\t * along), which cannot be put back as it was. Yes when left out; `false` for a look at the state that leaves the\n\t * world as it was (`worldState`, `worldHash`)\n\t *\n\t * @beta\n\t */\n\treseat?: boolean\n}\n\n/**\n * Saves a world, between two ticks. Throws, saying where, when something in it is not plain data\n *\n * @public\n */\nexport function saveWorld(world: World, options: SaveWorldOptions = {}): WorldSave {\n\tconst detached = new Map<EntityId, Entity>()\n\tconst ref = (entity: Entity) => {\n\t\tif (world.entities.get(entity.id) !== entity) detached.set(entity.id, entity)\n\t\treturn entity.id\n\t}\n\tconst hitGroups = new Map<Set<EntityId>, number>()\n\tconst missileHits: EntityId[][] = []\n\tconst { terrain } = world\n\n\tconst save: WorldSave = {\n\t\tformat: SAVE_FORMAT,\n\t\tgame: world.registry.game,\n\t\tversion: world.registry.saveVersion,\n\t\thash: world.registry.hash,\n\t\ttickRate: world.tickRate,\n\t\ttick: world.tick,\n\t\twinner: world.winner,\n\t\t...(world.disabled.size > 0 && { disabled: [...world.disabled.values()] }),\n\t\t...(world.failure && { failure: structuredClone(world.failure) }),\n\t\trng: world.rng.save(),\n\t\tinternals: plain(world.internals(), 'commands') as WorldInternals,\n\t\tcheats: { ...world.cheats },\n\t\t...(world.fromMap.size > 0 && { fromMap: [...world.fromMap] }),\n\t\tterrain: savedGround(terrain, world.ground, world.registry.module?.maps, world.registry.module ?? {}),\n\t\tplayers: [...world.players.values()].map((player) => ({\n\t\t\tinit: {\n\t\t\t\tid: player.id,\n\t\t\t\tname: player.name,\n\t\t\t\tteam: player.team,\n\t\t\t\tcolor: [...player.color],\n\t\t\t\tneutral: player.neutral,\n\t\t\t\tcreeps: player.creeps,\n\t\t\t\t...(player.race !== undefined && { race: player.race })\n\t\t\t},\n\t\t\tresources: { ...player.resources },\n\t\t\tsupplyUsed: player.supplyUsed,\n\t\t\tsupplyCap: player.supplyCap,\n\t\t\t...(Object.keys(player.supplies).length > 0 && { supplies: structuredClone(player.supplies) }),\n\t\t\testablished: player.established,\n\t\t\tdefeated: player.defeated,\n\t\t\tupgrades: [...player.upgrades],\n\t\t\tupgradesVersion: player.upgradesVersion,\n\t\t\tresearching: [...player.researching],\n\t\t\tstate: savedStates(world, player.states.values, `state of player ${player.id}`)\n\t\t})),\n\t\tfog: world.fog.save(),\n\t\tnavVersion: world.nav.version,\n\t\tentities: [...world.entities.values()].map((entity) => saveEntity(world, entity)),\n\t\tdetached: [],\n\t\tunits: [...world.units.keys()],\n\t\tsceneryInSight: Object.fromEntries([...world.sceneryInSight].map(([team, inSight]) => [team, [...inSight].map((entity) => entity.id)])),\n\t\tprojectiles: plain(world.projectiles, 'projectiles') as Projectile[],\n\t\tmissiles: world.missiles.map((missile) => {\n\t\t\tlet group = hitGroups.get(missile.hit)\n\t\t\tif (group === undefined) {\n\t\t\t\thitGroups.set(missile.hit, (group = missileHits.length))\n\t\t\t\tmissileHits.push([...missile.hit])\n\t\t\t}\n\t\t\tconst { hit: _, effect, ...rest } = missile\n\t\t\treturn {\n\t\t\t\t...(plain(rest, `missile ${missile.id}`) as Omit<Missile, 'hit' | 'effect'>),\n\t\t\t\thit: group,\n\t\t\t\teffect: effectRef(world.registry, missile.ability, effect)\n\t\t\t}\n\t\t}),\n\t\tmissileHits,\n\t\tdelayed: world.delayed.map((delayed) => {\n\t\t\tconst { caster, ability, effects, ...rest } = delayed\n\t\t\treturn {\n\t\t\t\t...(plain(rest, 'delayed') as Omit<Delayed, 'caster' | 'ability' | 'effects'>),\n\t\t\t\tcaster: ref(caster),\n\t\t\t\tability: ability.id,\n\t\t\t\teffects: effectRef(world.registry, ability.id, effects)\n\t\t\t}\n\t\t}),\n\t\tzones: world.zones.map((zone) => {\n\t\t\tconst { caster, ability, effect, ...rest } = zone\n\t\t\treturn {\n\t\t\t\t...(plain(rest, `zone ${zone.id}`) as Omit<Zone, 'caster' | 'ability' | 'effect'>),\n\t\t\t\tcaster: ref(caster),\n\t\t\t\tability: ability.id,\n\t\t\t\teffect: effectRef(world.registry, ability.id, effect)\n\t\t\t}\n\t\t}),\n\t\treveals: plain(world.reveals, 'reveals') as Reveal[],\n\t\titems: plain(world.items, 'items') as GroundItem[],\n\t\tstate: savedStates(world, world.states.values, 'state')\n\t}\n\tconst systems: Record<string, unknown> = {}\n\tfor (const system of world.systems) if (system.save) systems[system.name] = plain(system.save(world), `system ${system.name}`)\n\tif (Object.keys(systems).length) save.systems = systems\n\tsave.detached = [...detached.values()].map((entity) => saveEntity(world, entity))\n\tif (options.reseat !== false) {\n\t\t// the crowd as a world loaded from this save will have it: these agents and no others, in this order, put back on\n\t\t// the ground with every structure in it (as a load puts them: an obstacle still waiting to be cut out would have\n\t\t// a target on a tile's edge snap to the other tile), settled\n\t\tworld.nav.settle(save.navVersion)\n\t\tworld.nav.reseat(save.entities.flatMap((saved) => (saved.agent ? [[saved.id, saved.agent] as const] : [])))\n\t\tworld.nav.settle(save.navVersion)\n\t\tworld.saved()\n\t}\n\treturn save\n}\n\nfunction saveEntity(world: World, entity: Entity): EntitySave {\n\tconst where = `${entity.def.id}#${entity.id}`\n\tconst save: EntitySave = { id: entity.id, type: entity.def.id, owner: entity.owner }\n\tfor (const key of ENTITY_SAVE) {\n\t\tconst value = entity[key]\n\t\tif (value === undefined) continue\n\t\tif (key === 'components') save.components = savedComponents(world, entity, where)\n\t\telse save[key] = plain(value, `${where}.${key}`)\n\t}\n\tconst agent = entity.alive && !entity.hidden && entity.get(moving) ? world.nav.saveAgent(entity.id) : undefined\n\tif (agent) save.agent = agent\n\treturn save\n}\n\n/** An entity's components as a save keeps them: each as its component says (`Component.save`), or as it is */\nfunction savedComponents(world: World, entity: Entity, where: string): Record<string, unknown> {\n\tconst saved: Record<string, unknown> = {}\n\tfor (const held of entity.heldComponents()) {\n\t\tconst { id } = held\n\t\tconst value = entity.get(held)\n\t\tconst component = world.registry.component(id)\n\t\tsaved[id] = component?.save\n\t\t\t? plain(component.save(value as never, world), `${where}.components.${id}`)\n\t\t\t: plain(value, `${where}.components.${id}`)\n\t}\n\treturn saved\n}\n\n/**\n * A world's or a player's state as a save keeps it: each component as it says (`Component.save`), or as it is. The\n * same hook as an entity's components, so that state kept in a form for the game as it runs (bytes, a `Map`) is\n * written as plain data here and made again by `load` (`loadedStates`)\n */\nfunction savedStates(world: World, values: Record<string, unknown>, where: string): Record<string, unknown> {\n\tconst saved: Record<string, unknown> = {}\n\tfor (const id in values) {\n\t\tconst component = world.registry.component(id)\n\t\tsaved[id] = component?.save ? component.save(values[id] as never, world) : values[id]\n\t}\n\treturn plain(saved, where) as Record<string, unknown>\n}\n\n/** A world's or a player's state from a save's copy of it: each component as its `load` makes it again (`savedStates`), in place */\nfunction loadedStates(registry: Registry, saved: Record<string, unknown>): Record<string, unknown> {\n\tfor (const id in saved) {\n\t\tconst component = registry.component(id)\n\t\tif (component?.load) saved[id] = component.load(saved[id], registry)\n\t}\n\treturn saved\n}\n\n/**\n * A copy of plain data: numbers, text, true and false, lists, and objects of those. Throws for anything else, saying\n * where, since it would not come back the same from a save: a `Map`, a `Set`, an entity, a function\n */\nconst plain = (value: unknown, where: string): unknown => plainData(value, where, 'Save', 'keep ids and plain objects in game state')\n\n// ---- Loading\n\n/** The players of a save, as a world is made with them */\nexport const savedPlayers = (save: WorldSave): PlayerInit[] => save.players.map((player) => ({ ...player.init, resources: { ...player.resources } }))\n\n/**\n * Fills a world just made from the game module and the terrain and players of the save with the rest of it. The save\n * is one of the format and the version read now: an older one goes through `updateSave` first, as `loadWorld` does\n */\nexport function restoreWorld(world: World, save: WorldSave): void {\n\tif (save.format !== SAVE_FORMAT) throw new SaveError(`Save: format ${save.format} is not one this game reads`, 'notASave')\n\tif (save.tickRate !== world.tickRate) throw new Error(`Save: made at ${save.tickRate} ticks a second, the world runs at ${world.tickRate}`)\n\tconst { registry } = world\n\tworld.tick = save.tick\n\tworld.winner = save.winner\n\tworld.rng.restore(save.rng)\n\tworld.restoreInternals(save.internals)\n\t// what the definitions were changed to while it ran, before anything is made of them\n\trestoreRedefinitions(registry, save.state[redefinitions.id])\n\tObject.assign(world.cheats, save.cheats)\n\tfor (const [object, entity] of save.fromMap ?? []) world.fromMap.set(object, entity)\n\n\tfor (const saved of save.players) {\n\t\tconst player = world.player(saved.init.id)\n\t\tObject.assign(player.resources, saved.resources)\n\t\tplayer.supplyUsed = saved.supplyUsed\n\t\tplayer.supplyCap = saved.supplyCap\n\t\tif (saved.supplies) player.supplies = structuredClone(saved.supplies)\n\t\tplayer.established = saved.established\n\t\tplayer.defeated = saved.defeated\n\t\tfor (const [upgrade, level] of saved.upgrades) player.setUpgrade(upgrade, level)\n\t\tplayer.upgradesVersion = saved.upgradesVersion\n\t\tfor (const upgrade of saved.researching) player.researching.add(upgrade)\n\t\tObject.assign(player.states.values, loadedStates(registry, structuredClone(saved.state)))\n\t}\n\tworld.fog.restore(save.fog)\n\n\tconst detached = new Map(save.detached.map((saved) => [saved.id, loadEntity(registry, saved)]))\n\t// every structure's obstacle made into the ground's tiles together: a wooded tile once, not once a tree (RV42)\n\tworld.nav.holdObstacles?.(true)\n\tfor (const saved of save.entities) {\n\t\tconst entity = loadEntity(registry, saved)\n\t\tworld.entities.set(entity.id, entity)\n\t\tworld.index.add(entity)\n\t\t// what is on the ground takes up its cells, and is in the way of who walks\n\t\tif (entity.isStructure && entity.alive) {\n\t\t\tworld.spatial.insertStatic(entity)\n\t\t\tif (entity.cell) {\n\t\t\t\t// (a gate standing open is in nobody's way: left out of the ways, as it was when the save was taken)\n\t\t\t\tconst fp = footprintOf(entity.def)\n\t\t\t\tworld.grid.occupy(entity.cell.x, entity.cell.z, fp.w, fp.d, entity.id)\n\t\t\t\tif (!registry.standsOpen(entity) && !world.nav.addObstacle(entity.id, entity.rect))\n\t\t\t\t\tworld.log.warn('navigation', `There is no room for another obstacle: ${entity.def.id} does not block the way`, { entity: entity.id })\n\t\t\t}\n\t\t}\n\t}\n\tworld.nav.holdObstacles?.(false)\n\tworld.restoreDead(save.internals.dead ?? [])\n\t// agents last, on walkable space with every structure in it, cut out first: where an agent and its target are\n\t// snapped to is the same as for the game the save was taken of\n\tworld.nav.settle(save.navVersion)\n\tfor (const saved of save.entities) if (saved.agent) world.nav.restoreAgent(saved.id, saved.agent)\n\tworld.nav.settle(save.navVersion)\n\tfor (const id of save.units) world.units.set(id, world.entities.get(id) ?? fail(`unit ${id} is not in the save`))\n\tfor (const [team, ids] of Object.entries(save.sceneryInSight)) {\n\t\tworld.sceneryInSight.set(Number(team), new Set(ids.map((id) => world.entities.get(id) ?? fail(`scenery ${id} is not in the save`))))\n\t}\n\n\tconst entity = (id: EntityId) => world.entities.get(id) ?? detached.get(id) ?? fail(`entity ${id} is not in the save`)\n\tconst ability = (id: string): AbilityDef => registry.ability(id)\n\tworld.projectiles.push(...(structuredClone(save.projectiles) as Projectile[]))\n\tconst hits = save.missileHits.map((ids) => new Set(ids))\n\tfor (const missile of save.missiles) {\n\t\tworld.missiles.push({ ...structuredClone(missile), hit: hits[missile.hit], effect: resolveEffect(registry, missile.ability, missile.effect) })\n\t}\n\tfor (const delayed of save.delayed) {\n\t\tconst { caster, ability: id, effects, ...rest } = structuredClone(delayed)\n\t\tworld.delayed.push({ ...rest, caster: entity(caster), ability: ability(id), effects: resolveEffect(registry, id, effects) })\n\t}\n\tfor (const zone of save.zones) {\n\t\tconst { caster, ability: id, effect, ...rest } = structuredClone(zone)\n\t\tworld.zones.push({ ...rest, caster: entity(caster), ability: ability(id), effect: resolveEffect(registry, id, effect) })\n\t}\n\tworld.reveals.push(...(structuredClone(save.reveals) as Reveal[]))\n\tObject.assign(world.states.values, loadedStates(registry, structuredClone(save.state)))\n\t// what each side knows of the buildings in its way, into the navigations it plans on (`Rules.paths: 'seen'`):\n\t// the world's as it is now, and what each had learned by sight\n\tworld.sidePaths?.restore(world, world.states.has(sideKnowledge) ? world.state(sideKnowledge) : {})\n\tworld.items.push(...(structuredClone(save.items) as GroundItem[]))\n\t// what systems kept, last: what they look up (an entity by its id, the world's state) is back by now. Into those\n\t// there are, and those still to be added\n\tworld.restoreSystems(save.systems ?? {})\n\tif (save.disabled) world.disable(save.disabled)\n\tif (save.failure) world.failure = structuredClone(save.failure)\n}\n\nfunction loadEntity(registry: Registry, saved: EntitySave): Entity {\n\tconst { id, type, owner, agent: _, pos, ...fields } = structuredClone(saved)\n\tconst entity = new Entity(id, registry.unit(type), owner, pos as Entity['pos'])\n\tfor (const key of Object.keys(fields))\n\t\tif (!SAVED_FIELDS.has(key)) fail(`${type}#${id} has \"${key}\", which is not a field of an entity a save keeps`)\n\tfor (const [key, value] of Object.entries(fields)) {\n\t\tif (key === 'components') {\n\t\t\tfor (const [componentId, value] of Object.entries(fields.components as Record<string, unknown>)) {\n\t\t\t\t// one the game has, by `missingIn`'s check before any entity is made\n\t\t\t\tconst component = registry.component(componentId)!\n\t\t\t\tentity.set(component, component.load ? component.load(value, registry) : value)\n\t\t\t}\n\t\t} else entity.restore(key, value)\n\t}\n\treturn entity\n}\n\nfunction fail(what: string): never {\n\tthrow new Error(`Save: ${what}`)\n}\n\n// ---- A save made before: by an older engine, by the game before a patch\n\n/**\n * How a game's saves outlive its patches (`Rules.saves`). Any change to a game's rules changes which rules they\n * are exactly (`registry.hash`), and most changes are nothing to a save: a number tuned, a bug fixed. A game that\n * declares this loads such a save as it is. A change a save cannot be read through (a unit type renamed, a component\n * of another shape) takes a new `version`, and a step that brings the saves made before up to it\n *\n * @beta\n */\nexport interface SaveRules {\n\t/**\n\t * The version of what the game keeps in a save: a whole number from 1, and 1 when left out. One more with every\n\t * patch that saves made before have to be changed for, together with the step that changes them (`migrate`). A save\n\t * says which it is of (`WorldSave.version`); one of a version newer than the game's is refused\n\t */\n\tversion?: number\n\t/**\n\t * What brings an older save up to date. A step for each version, by the version it starts from (`{ 3: … }` makes a\n\t * save of version 3 one of version 4), run one after the other; or one function for all of it, told the version the\n\t * save is of and the one it is to be of. A save of a version with no step after it is refused, saying so: a version\n\t * with nothing to change has the step `(save) => save`\n\t */\n\tmigrate?: Record<number, SaveMigration> | ((save: WorldSave, from: number, to: number) => WorldSave | void)\n\t/**\n\t * What becomes of a save of the game's version made with other rules, its code, its numbers or its mods having\n\t * changed since: `load` it as it is, `refuse` it, or a function that says which, given the save and the hash of the\n\t * rules now. `load` when left out\n\t */\n\tonMismatch?: 'load' | 'refuse' | ((save: WorldSave, hash: string) => 'load' | 'refuse')\n}\n\n/**\n * A step of a game's own, from one version of its saves to the next. The save is plain data in the engine's format\n * of now (the engine's own steps run first), and a copy: the step changes it in place, or gives another\n *\n * @beta\n */\nexport type SaveMigration = (save: WorldSave) => WorldSave | void\n\n/**\n * Why a save is not loaded:\n * - `notASave`: it is not a save, or says nothing readable of its format or its version\n * - `game`: it is another game's\n * - `newer`: it was made by a newer version of the game, or of the engine, than this one\n * - `noWay`: it is of an older version of the game's saves, and the game has no step from there (`SaveRules.migrate`)\n * - `rules`: it was made with other rules, and the game does not load those (`SaveRules.onMismatch`)\n * - `missing`: it has in it what the game no longer has (`SaveError.missing`)\n * - `ground`: its ground is a map of the game as it was, which the game no longer has as it was (S36)\n *\n * @beta\n */\nexport type SaveRefusal = 'notASave' | 'game' | 'newer' | 'noWay' | 'rules' | 'missing' | 'ground'\n\n/**\n * What a save has in it that the game does not have, by kind: their ids\n *\n * @beta\n */\nexport type SaveMissing = Partial<Record<'unit' | 'ability' | 'buff' | 'item' | 'upgrade' | 'order' | 'component' | 'timer' | 'sequence', string[]>>\n\n/**\n * A save that is not loaded, and why: for a list of saves to say, in words of its own\n *\n * @beta\n */\nexport class SaveError extends Error {\n\tconstructor(\n\t\tmessage: string,\n\t\t/** Why the save was refused, as a `SaveRefusal` */\n\t\treadonly reason: SaveRefusal,\n\t\t/** For `missing`: what the save has that the game does not */\n\t\treadonly missing?: SaveMissing\n\t) {\n\t\tsuper(message)\n\t\tthis.name = 'SaveError'\n\t}\n}\n\n/**\n * What of a save says whether a game reads it, the rest of it apart: kept beside a save, for a list of them to ask with\n *\n * @beta\n */\nexport interface SaveHeader {\n\t/** The save's format (`SAVE_FORMAT`) when it was written */\n\tformat: number\n\t/** The id of the game module the save was made with */\n\tgame: string\n\t/** 1 when left out, as in a save from before games had versions of their saves */\n\tversion?: number\n\t/** The hash of the rules the save was made with, as `WorldSave.hash` */\n\thash: string\n}\n\n/**\n * The header of a save\n *\n * @beta\n */\nexport const saveHeader = (save: SaveHeader): SaveHeader => ({ format: save.format, game: save.game, version: save.version ?? 1, hash: save.hash })\n\nconst isCount = (value: unknown): value is number => typeof value === 'number' && Number.isInteger(value) && value >= 1\n\n/** What a game does about a save of its version made with other rules: what it says, else it loads when it declares `saves` at all */\nconst mismatchPolicy = (registry: Registry) => registry.module?.saves?.onMismatch ?? (registry.module?.saves ? 'load' : 'refuse')\n\nfunction otherRules(header: SaveHeader, registry: Registry): SaveError {\n\treturn new SaveError(\n\t\t`Save: made with another version of \"${registry.game}\" (${header.hash}, this is ${registry.hash}). Its rules or its mods changed since` +\n\t\t\t(registry.module?.saves ? '' : ': a game that declares Rules.saves loads it all the same'),\n\t\t'rules'\n\t)\n}\n\n/** Why a save is refused that its header alone says: another game's, newer than this reads, or with no way up from its version */\nfunction headerProblem(header: SaveHeader, registry: Registry): SaveError | undefined {\n\tconst { format } = header\n\tconst version = header.version ?? 1\n\tif (!isCount(format)) return new SaveError(`Save: format ${String(format)} is not one this game reads`, 'notASave')\n\tif (!isCount(version)) return new SaveError(`Save: version ${String(version)} is not one this game reads`, 'notASave')\n\tif (header.game !== registry.game) return new SaveError(`Save: made with the game \"${header.game}\", not \"${registry.game}\"`, 'game')\n\tif (format > SAVE_FORMAT) {\n\t\treturn new SaveError(\n\t\t\t`Save: format ${format} is newer than this game reads (${SAVE_FORMAT}): it was saved by a newer version of the game`,\n\t\t\t'newer'\n\t\t)\n\t}\n\t// the engine keeps no way up from a format of its own before this one: the engine and its games change shape freely\n\tif (format < SAVE_FORMAT) return new SaveError(`Save: format ${format} is older than this game reads (${SAVE_FORMAT})`, 'noWay')\n\tconst to = registry.saveVersion\n\tif (version > to) {\n\t\treturn new SaveError(\n\t\t\t`Save: version ${version} of the saves of \"${registry.game}\" is newer than this game reads (${to}): it was saved by a newer version of the game`,\n\t\t\t'newer'\n\t\t)\n\t}\n\tconst migrate = registry.module?.saves?.migrate\n\tif (typeof migrate === 'function') return undefined\n\tfor (let from = version; from < to; from++) {\n\t\tif (!migrate?.[from]) {\n\t\t\treturn new SaveError(\n\t\t\t\t`Save: version ${version} of the saves of \"${registry.game}\", and the game has no way from ${from} to ${from + 1} (Rules.saves.migrate)`,\n\t\t\t\t'noWay'\n\t\t\t)\n\t\t}\n\t}\n\treturn undefined\n}\n\n/**\n * Whether a game loads a save, as far as the save's header says (`saveHeader`): nothing, or why not. For a list of\n * saves, which has no need to read each of them whole. What only the whole save says (something in it the game no\n * longer has, a game that decides save by save) is found as it is loaded (`updateSave`, `loadWorld`)\n *\n * @beta\n */\nexport function saveProblem(header: SaveHeader, registry: Registry): SaveError | undefined {\n\tconst refused = headerProblem(header, registry)\n\tif (refused) return refused\n\tconst sameVersion = (header.version ?? 1) === registry.saveVersion\n\tif (sameVersion && header.hash !== registry.hash && mismatchPolicy(registry) === 'refuse') return otherRules(header, registry)\n\treturn undefined\n}\n\n/**\n * A save as the game reads it now, whatever it was saved by: brought up from an older version by the game's (`Rules.saves.migrate`), each one version at a time. `loadWorld` runs\n * it; a tool that keeps saves up to date runs it by itself. The save handed in is not changed. Throws a `SaveError`,\n * which says why, for one that cannot be read: another game's, newer than this game, of a version the game has no\n * step from, made with other rules by a game that refuses those (`anyVersion` loads it all the same), or with\n * something in it the game no longer has, all of which the error names\n *\n * @beta\n */\nexport function updateSave(data: unknown, registry: Registry, options: { anyVersion?: boolean } = {}): WorldSave {\n\tif (typeof data !== 'object' || data === null) throw new SaveError('Save: not a save', 'notASave')\n\tconst header = data as SaveHeader\n\tconst refused = headerProblem(header, registry)\n\tif (refused) throw refused\n\tconst from = header.version ?? 1\n\tconst to = registry.saveVersion\n\tlet save = data as WorldSave\n\tif (from < to) {\n\t\t// a copy: the steps change what they are given, and the save handed in is its owner's\n\t\tsave = structuredClone(data) as WorldSave\n\t\tconst migrate = registry.module?.saves?.migrate\n\t\tif (typeof migrate === 'function') {\n\t\t\tif (from < to) save = migrate(save, from, to) ?? save\n\t\t} else {\n\t\t\tfor (let version = from; version < to; version++) save = migrate![version](save) ?? save\n\t\t}\n\t}\n\t// the same version, other rules: whether that is a save to load is the game's to say\n\tif (from === to && header.hash !== registry.hash && !options.anyVersion) {\n\t\tconst policy = mismatchPolicy(registry)\n\t\tif ((typeof policy === 'function' ? policy(save, registry.hash) : policy) === 'refuse') throw otherRules(header, registry)\n\t}\n\tconst missing = missingIn(save, registry)\n\tif (missing) {\n\t\tconst said = Object.entries(missing).map(([kind, ids]) => `the ${KINDS[kind as keyof SaveMissing]} ${ids.map((id) => `\"${id}\"`).join(', ')}`)\n\t\tthrow new SaveError(\n\t\t\t`Save: it has what \"${registry.game}\" does not have: ${said.join('; ')}. A step of the game's (Rules.saves.migrate) says what becomes of them`,\n\t\t\t'missing',\n\t\t\tmissing\n\t\t)\n\t}\n\t// the game's own now: its format, its version, its rules\n\treturn { ...save, format: SAVE_FORMAT, version: to, hash: registry.hash }\n}\n\nconst KINDS: Record<keyof SaveMissing, string> = {\n\tunit: 'unit types',\n\tability: 'abilities',\n\tbuff: 'buffs',\n\titem: 'items',\n\tupgrade: 'upgrades',\n\torder: 'orders',\n\tcomponent: 'components',\n\ttimer: 'timers',\n\tsequence: 'sequences'\n}\n\n/**\n * What a save names that the game does not have: found before a world is made of it, and said all at once, where\n * each would otherwise throw by itself at the moment the game came to it, some of them minutes into the game loaded\n */\nfunction missingIn(save: WorldSave, registry: Registry): SaveMissing | undefined {\n\tconst missing: SaveMissing = {}\n\tconst check = (kind: keyof SaveMissing, has: (id: string) => boolean) => (id: unknown) => {\n\t\tif (typeof id === 'string' && !has(id) && !missing[kind]?.includes(id)) (missing[kind] ??= []).push(id)\n\t}\n\t// copies made while it ran (`copyOf`, see `world.redefine`) are made again as it is loaded: the game has those then\n\tconst kept = (save.state[redefinitions.id] ?? {}) as Record<string, Record<string, Record<string, unknown>> | undefined>\n\tconst defined = (kind: DataKind) => (id: string) => registry.kinds[kind].has(id) || typeof kept[kind]?.[id]?.[COPY_OF] === 'string'\n\tconst unit = check('unit', defined('units'))\n\tconst ability = check('ability', defined('abilities'))\n\tconst buff = check('buff', defined('buffs'))\n\tconst item = check('item', defined('items'))\n\tconst upgrade = check('upgrade', defined('upgrades'))\n\tconst order = check('order', (id) => registry.orders.has(id))\n\t// one the game lists, or the engine's own\n\tconst component = check('component', (id) => registry.component(id) !== undefined)\n\t// each component's own say of what it names (`Component.refs`)\n\tconst named: Record<keyof SavedRefs, (id: unknown) => void> = { units: unit, abilities: ability, buffs: buff, items: item, upgrades: upgrade }\n\tconst components = (values: unknown) => {\n\t\tfor (const [id, value] of Object.entries((values as Record<string, unknown> | undefined) ?? {})) {\n\t\t\tcomponent(id)\n\t\t\tconst refs = registry.component(id)?.refs?.(value)\n\t\t\tif (refs) for (const kind of Object.keys(refs) as (keyof SavedRefs)[]) refs[kind]?.forEach(named[kind])\n\t\t}\n\t}\n\t// an effect made up on the spot is kept whole; one of an ability is found in it again, so the ability has to be there\n\tconst placed = (effect: EffectRef | undefined) => !!effect && 'path' in effect\n\n\tcomponents(save.state)\n\tfor (const player of save.players) {\n\t\tcomponents(player.state)\n\t\tfor (const [id] of player.upgrades) upgrade(id)\n\t\tfor (const id of player.researching) upgrade(id)\n\t}\n\tfor (const entity of [...save.entities, ...save.detached]) {\n\t\tunit(entity.type)\n\t\tcomponents(entity.components)\n\t\tfor (const state of (entity.abilities as AbilityState[] | undefined) ?? []) ability(state.id)\n\t\tfor (const instance of (entity.buffs as BuffInstance[] | undefined) ?? []) buff(instance.id)\n\t\tfor (const given of (entity.orders as Order[] | undefined) ?? []) {\n\t\t\torder(given.type)\n\t\t\tunit(given.init?.unitType)\n\t\t}\n\t}\n\tfor (const missile of save.missiles) if (placed(missile.effect)) ability(missile.ability)\n\tfor (const delayed of save.delayed) ability(delayed.ability)\n\tfor (const zone of save.zones) ability(zone.ability)\n\tfor (const dropped of save.items) item(dropped.item)\n\tconst game = registry.module\n\tif (game) {\n\t\tconst timers = new Set([...coreTimers, ...(registry.assembly?.timers ?? game.timers ?? [])].map((def) => def.id))\n\t\tconst sequences = new Set((game.sequences ?? []).map((def) => def.id))\n\t\twaitingTimers(save.state).forEach(check('timer', (id) => timers.has(id)))\n\t\trunningSequences(save.state).forEach(check('sequence', (id) => sequences.has(id)))\n\t}\n\treturn Object.keys(missing).length > 0 ? missing : undefined\n}\n\n// ---- As text\n\n/**\n * A save as text. JSON, but for numbers JSON has no words for, which game state has: buffs that last forever\n * (`Infinity`), something never hurt (`-Infinity`)\n *\n * @beta\n */\nexport function encodeSave(save: WorldSave): string {\n\treturn JSON.stringify(save, (_key, value) => (typeof value === 'number' && !Number.isFinite(value) ? { $number: String(value) } : value))\n}\n\n/**\n * Reads a save back from text written by `encodeSave`, turning the stored non-finite numbers into numbers again\n *\n * @beta\n */\nexport function decodeSave(text: string): WorldSave {\n\treturn JSON.parse(text, (_key, value) =>\n\t\tvalue && typeof value === 'object' && Object.keys(value).length === 1 && typeof value.$number === 'string' ? Number(value.$number) : value\n\t) as WorldSave\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAgHA,IAAa,cAAc;;;;;;;;AAoC3B,IAAa,cAAc;CAC1B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;AASA,IAAa,iBAAiB;CAC7B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAEA,IAAM,eAAe,IAAI,IAAY,WAAW;;;;;;AA2BhD,SAAgB,UAAU,OAAc,UAA4B,CAAC,GAAc;CAClF,MAAM,2BAAW,IAAI,IAAsB;CAC3C,MAAM,OAAO,WAAmB;EAC/B,IAAI,MAAM,SAAS,IAAI,OAAO,EAAE,MAAM,QAAQ,SAAS,IAAI,OAAO,IAAI,MAAM;EAC5E,OAAO,OAAO;CACf;CACA,MAAM,4BAAY,IAAI,IAA2B;CACjD,MAAM,cAA4B,CAAC;CACnC,MAAM,EAAE,YAAY;CAEpB,MAAM,OAAkB;EACvB,QAAA;EACA,MAAM,MAAM,SAAS;EACrB,SAAS,MAAM,SAAS;EACxB,MAAM,MAAM,SAAS;EACrB,UAAU,MAAM;EAChB,MAAM,MAAM;EACZ,QAAQ,MAAM;EACd,GAAI,MAAM,SAAS,OAAO,KAAK,EAAE,UAAU,CAAC,GAAG,MAAM,SAAS,OAAO,CAAC,EAAE;EACxE,GAAI,MAAM,WAAW,EAAE,SAAS,gBAAgB,MAAM,OAAO,EAAE;EAC/D,KAAK,MAAM,IAAI,KAAK;EACpB,WAAW,MAAM,MAAM,UAAU,GAAG,UAAU;EAC9C,QAAQ,EAAE,GAAG,MAAM,OAAO;EAC1B,GAAI,MAAM,QAAQ,OAAO,KAAK,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,EAAE;EAC5D,SAAS,YAAY,SAAS,MAAM,QAAQ,MAAM,SAAS,QAAQ,MAAM,MAAM,SAAS,UAAU,CAAC,CAAC;EACpG,SAAS,CAAC,GAAG,MAAM,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY;GACrD,MAAM;IACL,IAAI,OAAO;IACX,MAAM,OAAO;IACb,MAAM,OAAO;IACb,OAAO,CAAC,GAAG,OAAO,KAAK;IACvB,SAAS,OAAO;IAChB,QAAQ,OAAO;IACf,GAAI,OAAO,SAAS,KAAA,KAAa,EAAE,MAAM,OAAO,KAAK;GACtD;GACA,WAAW,EAAE,GAAG,OAAO,UAAU;GACjC,YAAY,OAAO;GACnB,WAAW,OAAO;GAClB,GAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,CAAC,SAAS,KAAK,EAAE,UAAU,gBAAgB,OAAO,QAAQ,EAAE;GAC5F,aAAa,OAAO;GACpB,UAAU,OAAO;GACjB,UAAU,CAAC,GAAG,OAAO,QAAQ;GAC7B,iBAAiB,OAAO;GACxB,aAAa,CAAC,GAAG,OAAO,WAAW;GACnC,OAAO,YAAY,OAAO,OAAO,OAAO,QAAQ,mBAAmB,OAAO,IAAI;EAC/E,EAAE;EACF,KAAK,MAAM,IAAI,KAAK;EACpB,YAAY,MAAM,IAAI;EACtB,UAAU,CAAC,GAAG,MAAM,SAAS,OAAO,CAAC,CAAC,CAAC,KAAK,WAAW,WAAW,OAAO,MAAM,CAAC;EAChF,UAAU,CAAC;EACX,OAAO,CAAC,GAAG,MAAM,MAAM,KAAK,CAAC;EAC7B,gBAAgB,OAAO,YAAY,CAAC,GAAG,MAAM,cAAc,CAAC,CAAC,KAAK,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,WAAW,OAAO,EAAE,CAAC,CAAC,CAAC;EACtI,aAAa,MAAM,MAAM,aAAa,aAAa;EACnD,UAAU,MAAM,SAAS,KAAK,YAAY;GACzC,IAAI,QAAQ,UAAU,IAAI,QAAQ,GAAG;GACrC,IAAI,UAAU,KAAA,GAAW;IACxB,UAAU,IAAI,QAAQ,KAAM,QAAQ,YAAY,MAAO;IACvD,YAAY,KAAK,CAAC,GAAG,QAAQ,GAAG,CAAC;GAClC;GACA,MAAM,EAAE,KAAK,GAAG,QAAQ,GAAG,SAAS;GACpC,OAAO;IACN,GAAI,MAAM,MAAM,WAAW,QAAQ,IAAI;IACvC,KAAK;IACL,QAAQ,UAAU,MAAM,UAAU,QAAQ,SAAS,MAAM;GAC1D;EACD,CAAC;EACD;EACA,SAAS,MAAM,QAAQ,KAAK,YAAY;GACvC,MAAM,EAAE,QAAQ,SAAS,SAAS,GAAG,SAAS;GAC9C,OAAO;IACN,GAAI,MAAM,MAAM,SAAS;IACzB,QAAQ,IAAI,MAAM;IAClB,SAAS,QAAQ;IACjB,SAAS,UAAU,MAAM,UAAU,QAAQ,IAAI,OAAO;GACvD;EACD,CAAC;EACD,OAAO,MAAM,MAAM,KAAK,SAAS;GAChC,MAAM,EAAE,QAAQ,SAAS,QAAQ,GAAG,SAAS;GAC7C,OAAO;IACN,GAAI,MAAM,MAAM,QAAQ,KAAK,IAAI;IACjC,QAAQ,IAAI,MAAM;IAClB,SAAS,QAAQ;IACjB,QAAQ,UAAU,MAAM,UAAU,QAAQ,IAAI,MAAM;GACrD;EACD,CAAC;EACD,SAAS,MAAM,MAAM,SAAS,SAAS;EACvC,OAAO,MAAM,MAAM,OAAO,OAAO;EACjC,OAAO,YAAY,OAAO,MAAM,OAAO,QAAQ,OAAO;CACvD;CACA,MAAM,UAAmC,CAAC;CAC1C,KAAK,MAAM,UAAU,MAAM,SAAS,IAAI,OAAO,MAAM,QAAQ,OAAO,QAAQ,MAAM,OAAO,KAAK,KAAK,GAAG,UAAU,OAAO,MAAM;CAC7H,IAAI,OAAO,KAAK,OAAO,CAAC,CAAC,QAAQ,KAAK,UAAU;CAChD,KAAK,WAAW,CAAC,GAAG,SAAS,OAAO,CAAC,CAAC,CAAC,KAAK,WAAW,WAAW,OAAO,MAAM,CAAC;CAChF,IAAI,QAAQ,WAAW,OAAO;EAI7B,MAAM,IAAI,OAAO,KAAK,UAAU;EAChC,MAAM,IAAI,OAAO,KAAK,SAAS,SAAS,UAAW,MAAM,QAAQ,CAAC,CAAC,MAAM,IAAI,MAAM,KAAK,CAAU,IAAI,CAAC,CAAE,CAAC;EAC1G,MAAM,IAAI,OAAO,KAAK,UAAU;EAChC,MAAM,MAAM;CACb;CACA,OAAO;AACR;AAEA,SAAS,WAAW,OAAc,QAA4B;CAC7D,MAAM,QAAQ,GAAG,OAAO,IAAI,GAAG,GAAG,OAAO;CACzC,MAAM,OAAmB;EAAE,IAAI,OAAO;EAAI,MAAM,OAAO,IAAI;EAAI,OAAO,OAAO;CAAM;CACnF,KAAK,MAAM,OAAO,aAAa;EAC9B,MAAM,QAAQ,OAAO;EACrB,IAAI,UAAU,KAAA,GAAW;EACzB,IAAI,QAAQ,cAAc,KAAK,aAAa,gBAAgB,OAAO,QAAQ,KAAK;OAC3E,KAAK,OAAO,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK;CAChD;CACA,MAAM,QAAQ,OAAO,SAAS,CAAC,OAAO,UAAU,OAAO,IAAI,MAAM,IAAI,MAAM,IAAI,UAAU,OAAO,EAAE,IAAI,KAAA;CACtG,IAAI,OAAO,KAAK,QAAQ;CACxB,OAAO;AACR;;AAGA,SAAS,gBAAgB,OAAc,QAAgB,OAAwC;CAC9F,MAAM,QAAiC,CAAC;CACxC,KAAK,MAAM,QAAQ,OAAO,eAAe,GAAG;EAC3C,MAAM,EAAE,OAAO;EACf,MAAM,QAAQ,OAAO,IAAI,IAAI;EAC7B,MAAM,YAAY,MAAM,SAAS,UAAU,EAAE;EAC7C,MAAM,MAAM,WAAW,OACpB,MAAM,UAAU,KAAK,OAAgB,KAAK,GAAG,GAAG,MAAM,cAAc,IAAI,IACxE,MAAM,OAAO,GAAG,MAAM,cAAc,IAAI;CAC5C;CACA,OAAO;AACR;;;;;;AAOA,SAAS,YAAY,OAAc,QAAiC,OAAwC;CAC3G,MAAM,QAAiC,CAAC;CACxC,KAAK,MAAM,MAAM,QAAQ;EACxB,MAAM,YAAY,MAAM,SAAS,UAAU,EAAE;EAC7C,MAAM,MAAM,WAAW,OAAO,UAAU,KAAK,OAAO,KAAc,KAAK,IAAI,OAAO;CACnF;CACA,OAAO,MAAM,OAAO,KAAK;AAC1B;;AAGA,SAAS,aAAa,UAAoB,OAAyD;CAClG,KAAK,MAAM,MAAM,OAAO;EACvB,MAAM,YAAY,SAAS,UAAU,EAAE;EACvC,IAAI,WAAW,MAAM,MAAM,MAAM,UAAU,KAAK,MAAM,KAAK,QAAQ;CACpE;CACA,OAAO;AACR;;;;;AAMA,IAAM,SAAS,OAAgB,UAA2BA,QAAU,OAAO,OAAO,QAAQ,0CAA0C;;AAKpI,IAAa,gBAAgB,SAAkC,KAAK,QAAQ,KAAK,YAAY;CAAE,GAAG,OAAO;CAAM,WAAW,EAAE,GAAG,OAAO,UAAU;AAAE,EAAE;;;;;AAMpJ,SAAgB,aAAa,OAAc,MAAuB;CACjE,IAAI,KAAK,WAAA,GAAwB,MAAM,IAAI,UAAU,gBAAgB,KAAK,OAAO,8BAA8B,UAAU;CACzH,IAAI,KAAK,aAAa,MAAM,UAAU,MAAM,IAAI,MAAM,iBAAiB,KAAK,SAAS,qCAAqC,MAAM,UAAU;CAC1I,MAAM,EAAE,aAAa;CACrB,MAAM,OAAO,KAAK;CAClB,MAAM,SAAS,KAAK;CACpB,MAAM,IAAI,QAAQ,KAAK,GAAG;CAC1B,MAAM,iBAAiB,KAAK,SAAS;CAErC,qBAAqB,UAAU,KAAK,MAAM,cAAc,GAAG;CAC3D,OAAO,OAAO,MAAM,QAAQ,KAAK,MAAM;CACvC,KAAK,MAAM,CAAC,QAAQ,WAAW,KAAK,WAAW,CAAC,GAAG,MAAM,QAAQ,IAAI,QAAQ,MAAM;CAEnF,KAAK,MAAM,SAAS,KAAK,SAAS;EACjC,MAAM,SAAS,MAAM,OAAO,MAAM,KAAK,EAAE;EACzC,OAAO,OAAO,OAAO,WAAW,MAAM,SAAS;EAC/C,OAAO,aAAa,MAAM;EAC1B,OAAO,YAAY,MAAM;EACzB,IAAI,MAAM,UAAU,OAAO,WAAW,gBAAgB,MAAM,QAAQ;EACpE,OAAO,cAAc,MAAM;EAC3B,OAAO,WAAW,MAAM;EACxB,KAAK,MAAM,CAAC,SAAS,UAAU,MAAM,UAAU,OAAO,WAAW,SAAS,KAAK;EAC/E,OAAO,kBAAkB,MAAM;EAC/B,KAAK,MAAM,WAAW,MAAM,aAAa,OAAO,YAAY,IAAI,OAAO;EACvE,OAAO,OAAO,OAAO,OAAO,QAAQ,aAAa,UAAU,gBAAgB,MAAM,KAAK,CAAC,CAAC;CACzF;CACA,MAAM,IAAI,QAAQ,KAAK,GAAG;CAE1B,MAAM,WAAW,IAAI,IAAI,KAAK,SAAS,KAAK,UAAU,CAAC,MAAM,IAAI,WAAW,UAAU,KAAK,CAAC,CAAC,CAAC;CAE9F,MAAM,IAAI,gBAAgB,IAAI;CAC9B,KAAK,MAAM,SAAS,KAAK,UAAU;EAClC,MAAM,SAAS,WAAW,UAAU,KAAK;EACzC,MAAM,SAAS,IAAI,OAAO,IAAI,MAAM;EACpC,MAAM,MAAM,IAAI,MAAM;EAEtB,IAAI,OAAO,eAAe,OAAO,OAAO;GACvC,MAAM,QAAQ,aAAa,MAAM;GACjC,IAAI,OAAO,MAAM;IAEhB,MAAM,KAAK,YAAY,OAAO,GAAG;IACjC,MAAM,KAAK,OAAO,OAAO,KAAK,GAAG,OAAO,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,EAAE;IACrE,IAAI,CAAC,SAAS,WAAW,MAAM,KAAK,CAAC,MAAM,IAAI,YAAY,OAAO,IAAI,OAAO,IAAI,GAChF,MAAM,IAAI,KAAK,cAAc,0CAA0C,OAAO,IAAI,GAAG,0BAA0B,EAAE,QAAQ,OAAO,GAAG,CAAC;GACtI;EACD;CACD;CACA,MAAM,IAAI,gBAAgB,KAAK;CAC/B,MAAM,YAAY,KAAK,UAAU,QAAQ,CAAC,CAAC;CAG3C,MAAM,IAAI,OAAO,KAAK,UAAU;CAChC,KAAK,MAAM,SAAS,KAAK,UAAU,IAAI,MAAM,OAAO,MAAM,IAAI,aAAa,MAAM,IAAI,MAAM,KAAK;CAChG,MAAM,IAAI,OAAO,KAAK,UAAU;CAChC,KAAK,MAAM,MAAM,KAAK,OAAO,MAAM,MAAM,IAAI,IAAI,MAAM,SAAS,IAAI,EAAE,KAAK,KAAK,QAAQ,GAAG,oBAAoB,CAAC;CAChH,KAAK,MAAM,CAAC,MAAM,QAAQ,OAAO,QAAQ,KAAK,cAAc,GAC3D,MAAM,eAAe,IAAI,OAAO,IAAI,GAAG,IAAI,IAAI,IAAI,KAAK,OAAO,MAAM,SAAS,IAAI,EAAE,KAAK,KAAK,WAAW,GAAG,oBAAoB,CAAC,CAAC,CAAC;CAGpI,MAAM,UAAU,OAAiB,MAAM,SAAS,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,KAAK,UAAU,GAAG,oBAAoB;CACrH,MAAM,WAAW,OAA2B,SAAS,QAAQ,EAAE;CAC/D,MAAM,YAAY,KAAK,GAAI,gBAAgB,KAAK,WAAW,CAAkB;CAC7E,MAAM,OAAO,KAAK,YAAY,KAAK,QAAQ,IAAI,IAAI,GAAG,CAAC;CACvD,KAAK,MAAM,WAAW,KAAK,UAC1B,MAAM,SAAS,KAAK;EAAE,GAAG,gBAAgB,OAAO;EAAG,KAAK,KAAK,QAAQ;EAAM,QAAQ,cAAc,UAAU,QAAQ,SAAS,QAAQ,MAAM;CAAE,CAAC;CAE9I,KAAK,MAAM,WAAW,KAAK,SAAS;EACnC,MAAM,EAAE,QAAQ,SAAS,IAAI,SAAS,GAAG,SAAS,gBAAgB,OAAO;EACzE,MAAM,QAAQ,KAAK;GAAE,GAAG;GAAM,QAAQ,OAAO,MAAM;GAAG,SAAS,QAAQ,EAAE;GAAG,SAAS,cAAc,UAAU,IAAI,OAAO;EAAE,CAAC;CAC5H;CACA,KAAK,MAAM,QAAQ,KAAK,OAAO;EAC9B,MAAM,EAAE,QAAQ,SAAS,IAAI,QAAQ,GAAG,SAAS,gBAAgB,IAAI;EACrE,MAAM,MAAM,KAAK;GAAE,GAAG;GAAM,QAAQ,OAAO,MAAM;GAAG,SAAS,QAAQ,EAAE;GAAG,QAAQ,cAAc,UAAU,IAAI,MAAM;EAAE,CAAC;CACxH;CACA,MAAM,QAAQ,KAAK,GAAI,gBAAgB,KAAK,OAAO,CAAc;CACjE,OAAO,OAAO,MAAM,OAAO,QAAQ,aAAa,UAAU,gBAAgB,KAAK,KAAK,CAAC,CAAC;CAGtF,MAAM,WAAW,QAAQ,OAAO,MAAM,OAAO,IAAI,aAAa,IAAI,MAAM,MAAM,aAAa,IAAI,CAAC,CAAC;CACjG,MAAM,MAAM,KAAK,GAAI,gBAAgB,KAAK,KAAK,CAAkB;CAGjE,MAAM,eAAe,KAAK,WAAW,CAAC,CAAC;CACvC,IAAI,KAAK,UAAU,MAAM,QAAQ,KAAK,QAAQ;CAC9C,IAAI,KAAK,SAAS,MAAM,UAAU,gBAAgB,KAAK,OAAO;AAC/D;AAEA,SAAS,WAAW,UAAoB,OAA2B;CAClE,MAAM,EAAE,IAAI,MAAM,OAAO,OAAO,GAAG,KAAK,GAAG,WAAW,gBAAgB,KAAK;CAC3E,MAAM,SAAS,IAAI,OAAO,IAAI,SAAS,KAAK,IAAI,GAAG,OAAO,GAAoB;CAC9E,KAAK,MAAM,OAAO,OAAO,KAAK,MAAM,GACnC,IAAI,CAAC,aAAa,IAAI,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,QAAQ,IAAI,kDAAkD;CAC9G,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,MAAM,GAC/C,IAAI,QAAQ,cACX,KAAK,MAAM,CAAC,aAAa,UAAU,OAAO,QAAQ,OAAO,UAAqC,GAAG;EAEhG,MAAM,YAAY,SAAS,UAAU,WAAW;EAChD,OAAO,IAAI,WAAW,UAAU,OAAO,UAAU,KAAK,OAAO,QAAQ,IAAI,KAAK;CAC/E;MACM,OAAO,QAAQ,KAAK,KAAK;CAEjC,OAAO;AACR;AAEA,SAAS,KAAK,MAAqB;CAClC,MAAM,IAAI,MAAM,SAAS,MAAM;AAChC;;;;;;AAoEA,IAAa,YAAb,cAA+B,MAAM;CAI1B;CAEA;CALV,YACC,SAEA,QAEA,SACC;EACD,MAAM,OAAO;EAJJ,KAAA,SAAA;EAEA,KAAA,UAAA;EAGT,KAAK,OAAO;CACb;AACD;;;;;;AAuBA,IAAa,cAAc,UAAkC;CAAE,QAAQ,KAAK;CAAQ,MAAM,KAAK;CAAM,SAAS,KAAK,WAAW;CAAG,MAAM,KAAK;AAAK;AAEjJ,IAAM,WAAW,UAAoC,OAAO,UAAU,YAAY,OAAO,UAAU,KAAK,KAAK,SAAS;;AAGtH,IAAM,kBAAkB,aAAuB,SAAS,QAAQ,OAAO,eAAe,SAAS,QAAQ,QAAQ,SAAS;AAExH,SAAS,WAAW,QAAoB,UAA+B;CACtE,OAAO,IAAI,UACV,uCAAuC,SAAS,KAAK,KAAK,OAAO,KAAK,YAAY,SAAS,KAAK,2CAC9F,SAAS,QAAQ,QAAQ,KAAK,6DAChC,OACD;AACD;;AAGA,SAAS,cAAc,QAAoB,UAA2C;CACrF,MAAM,EAAE,WAAW;CACnB,MAAM,UAAU,OAAO,WAAW;CAClC,IAAI,CAAC,QAAQ,MAAM,GAAG,OAAO,IAAI,UAAU,gBAAgB,OAAO,MAAM,EAAE,8BAA8B,UAAU;CAClH,IAAI,CAAC,QAAQ,OAAO,GAAG,OAAO,IAAI,UAAU,iBAAiB,OAAO,OAAO,EAAE,8BAA8B,UAAU;CACrH,IAAI,OAAO,SAAS,SAAS,MAAM,OAAO,IAAI,UAAU,6BAA6B,OAAO,KAAK,UAAU,SAAS,KAAK,IAAI,MAAM;CACnI,IAAI,SAAA,GACH,OAAO,IAAI,UACV,gBAAgB,OAAO,kFACvB,OACD;CAGD,IAAI,SAAA,GAAsB,OAAO,IAAI,UAAU,gBAAgB,OAAO,qCAAkD,OAAO;CAC/H,MAAM,KAAK,SAAS;CACpB,IAAI,UAAU,IACb,OAAO,IAAI,UACV,iBAAiB,QAAQ,oBAAoB,SAAS,KAAK,mCAAmC,GAAG,iDACjG,OACD;CAED,MAAM,UAAU,SAAS,QAAQ,OAAO;CACxC,IAAI,OAAO,YAAY,YAAY,OAAO,KAAA;CAC1C,KAAK,IAAI,OAAO,SAAS,OAAO,IAAI,QACnC,IAAI,CAAC,UAAU,OACd,OAAO,IAAI,UACV,iBAAiB,QAAQ,oBAAoB,SAAS,KAAK,kCAAkC,KAAK,MAAM,OAAO,EAAE,yBACjH,OACD;AAIH;;;;;;;;AASA,SAAgB,YAAY,QAAoB,UAA2C;CAC1F,MAAM,UAAU,cAAc,QAAQ,QAAQ;CAC9C,IAAI,SAAS,OAAO;CAEpB,KADqB,OAAO,WAAW,OAAO,SAAS,eACpC,OAAO,SAAS,SAAS,QAAQ,eAAe,QAAQ,MAAM,UAAU,OAAO,WAAW,QAAQ,QAAQ;AAE9H;;;;;;;;;;AAWA,SAAgB,WAAW,MAAe,UAAoB,UAAoC,CAAC,GAAc;CAChH,IAAI,OAAO,SAAS,YAAY,SAAS,MAAM,MAAM,IAAI,UAAU,oBAAoB,UAAU;CACjG,MAAM,SAAS;CACf,MAAM,UAAU,cAAc,QAAQ,QAAQ;CAC9C,IAAI,SAAS,MAAM;CACnB,MAAM,OAAO,OAAO,WAAW;CAC/B,MAAM,KAAK,SAAS;CACpB,IAAI,OAAO;CACX,IAAI,OAAO,IAAI;EAEd,OAAO,gBAAgB,IAAI;EAC3B,MAAM,UAAU,SAAS,QAAQ,OAAO;EACxC,IAAI,OAAO,YAAY,YAClB;OAAA,OAAO,IAAI,OAAO,QAAQ,MAAM,MAAM,EAAE,KAAK;EAAA,OAEjD,KAAK,IAAI,UAAU,MAAM,UAAU,IAAI,WAAW,OAAO,QAAS,QAAQ,CAAC,IAAI,KAAK;CAEtF;CAEA,IAAI,SAAS,MAAM,OAAO,SAAS,SAAS,QAAQ,CAAC,QAAQ,YAAY;EACxE,MAAM,SAAS,eAAe,QAAQ;EACtC,KAAK,OAAO,WAAW,aAAa,OAAO,MAAM,SAAS,IAAI,IAAI,YAAY,UAAU,MAAM,WAAW,QAAQ,QAAQ;CAC1H;CACA,MAAM,UAAU,UAAU,MAAM,QAAQ;CACxC,IAAI,SAAS;EACZ,MAAM,OAAO,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,SAAS,OAAO,MAAM,MAA2B,GAAG,IAAI,KAAK,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG;EAC5I,MAAM,IAAI,UACT,sBAAsB,SAAS,KAAK,mBAAmB,KAAK,KAAK,IAAI,EAAE,yEACvE,WACA,OACD;CACD;CAEA,OAAO;EAAE,GAAG;EAAM,QAAA;EAAqB,SAAS;EAAI,MAAM,SAAS;CAAK;AACzE;AAEA,IAAM,QAA2C;CAChD,MAAM;CACN,SAAS;CACT,MAAM;CACN,MAAM;CACN,SAAS;CACT,OAAO;CACP,WAAW;CACX,OAAO;CACP,UAAU;AACX;;;;;AAMA,SAAS,UAAU,MAAiB,UAA6C;CAChF,MAAM,UAAuB,CAAC;CAC9B,MAAM,SAAS,MAAyB,SAAkC,OAAgB;EACzF,IAAI,OAAO,OAAO,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,QAAQ,UAAU,CAAC,EAAA,CAAG,KAAK,EAAE;CACvG;CAEA,MAAM,OAAQ,KAAK,MAAM,cAAc,OAAO,CAAC;CAC/C,MAAM,WAAW,UAAoB,OAAe,SAAS,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,OAAO,KAAK,KAAK,GAAG,GAAG,GAAA,cAAgB;CAC3H,MAAM,OAAO,MAAM,QAAQ,QAAQ,OAAO,CAAC;CAC3C,MAAM,UAAU,MAAM,WAAW,QAAQ,WAAW,CAAC;CACrD,MAAM,OAAO,MAAM,QAAQ,QAAQ,OAAO,CAAC;CAC3C,MAAM,OAAO,MAAM,QAAQ,QAAQ,OAAO,CAAC;CAC3C,MAAM,UAAU,MAAM,WAAW,QAAQ,UAAU,CAAC;CACpD,MAAM,QAAQ,MAAM,UAAU,OAAO,SAAS,OAAO,IAAI,EAAE,CAAC;CAE5D,MAAM,YAAY,MAAM,cAAc,OAAO,SAAS,UAAU,EAAE,MAAM,KAAA,CAAS;CAEjF,MAAM,QAAwD;EAAE,OAAO;EAAM,WAAW;EAAS,OAAO;EAAM,OAAO;EAAM,UAAU;CAAQ;CAC7I,MAAM,cAAc,WAAoB;EACvC,KAAK,MAAM,CAAC,IAAI,UAAU,OAAO,QAAS,UAAkD,CAAC,CAAC,GAAG;GAChG,UAAU,EAAE;GACZ,MAAM,OAAO,SAAS,UAAU,EAAE,CAAC,EAAE,OAAO,KAAK;GACjD,IAAI,MAAM,KAAK,MAAM,QAAQ,OAAO,KAAK,IAAI,GAA0B,KAAK,KAAK,EAAE,QAAQ,MAAM,KAAK;EACvG;CACD;CAEA,MAAM,UAAU,WAAkC,CAAC,CAAC,UAAU,UAAU;CAExE,WAAW,KAAK,KAAK;CACrB,KAAK,MAAM,UAAU,KAAK,SAAS;EAClC,WAAW,OAAO,KAAK;EACvB,KAAK,MAAM,CAAC,OAAO,OAAO,UAAU,QAAQ,EAAE;EAC9C,KAAK,MAAM,MAAM,OAAO,aAAa,QAAQ,EAAE;CAChD;CACA,KAAK,MAAM,UAAU,CAAC,GAAG,KAAK,UAAU,GAAG,KAAK,QAAQ,GAAG;EAC1D,KAAK,OAAO,IAAI;EAChB,WAAW,OAAO,UAAU;EAC5B,KAAK,MAAM,SAAU,OAAO,aAA4C,CAAC,GAAG,QAAQ,MAAM,EAAE;EAC5F,KAAK,MAAM,YAAa,OAAO,SAAwC,CAAC,GAAG,KAAK,SAAS,EAAE;EAC3F,KAAK,MAAM,SAAU,OAAO,UAAkC,CAAC,GAAG;GACjE,MAAM,MAAM,IAAI;GAChB,KAAK,MAAM,MAAM,QAAQ;EAC1B;CACD;CACA,KAAK,MAAM,WAAW,KAAK,UAAU,IAAI,OAAO,QAAQ,MAAM,GAAG,QAAQ,QAAQ,OAAO;CACxF,KAAK,MAAM,WAAW,KAAK,SAAS,QAAQ,QAAQ,OAAO;CAC3D,KAAK,MAAM,QAAQ,KAAK,OAAO,QAAQ,KAAK,OAAO;CACnD,KAAK,MAAM,WAAW,KAAK,OAAO,KAAK,QAAQ,IAAI;CACnD,MAAM,OAAO,SAAS;CACtB,IAAI,MAAM;EACT,MAAM,SAAS,IAAI,IAAI,CAAC,GAAG,YAAY,GAAI,SAAS,UAAU,UAAU,KAAK,UAAU,CAAC,CAAE,CAAC,CAAC,KAAK,QAAQ,IAAI,EAAE,CAAC;EAChH,MAAM,YAAY,IAAI,KAAK,KAAK,aAAa,CAAC,EAAA,CAAG,KAAK,QAAQ,IAAI,EAAE,CAAC;EACrE,cAAc,KAAK,KAAK,CAAC,CAAC,QAAQ,MAAM,UAAU,OAAO,OAAO,IAAI,EAAE,CAAC,CAAC;EACxE,iBAAiB,KAAK,KAAK,CAAC,CAAC,QAAQ,MAAM,aAAa,OAAO,UAAU,IAAI,EAAE,CAAC,CAAC;CAClF;CACA,OAAO,OAAO,KAAK,OAAO,CAAC,CAAC,SAAS,IAAI,UAAU,KAAA;AACpD;;;;;;;AAUA,SAAgB,WAAW,MAAyB;CACnD,OAAO,KAAK,UAAU,OAAO,MAAM,UAAW,OAAO,UAAU,YAAY,CAAC,OAAO,SAAS,KAAK,IAAI,EAAE,SAAS,OAAO,KAAK,EAAE,IAAI,KAAM;AACzI;;;;;;AAOA,SAAgB,WAAW,MAAyB;CACnD,OAAO,KAAK,MAAM,OAAO,MAAM,UAC9B,SAAS,OAAO,UAAU,YAAY,OAAO,KAAK,KAAK,CAAC,CAAC,WAAW,KAAK,OAAO,MAAM,YAAY,WAAW,OAAO,MAAM,OAAO,IAAI,KACtI;AACD"}

package/dist/scenario.d.ts

@@ -1,4 +1,4 @@
-import { type GameModule } from './game';
+import { type Rules } from './game';
 import { type GameMap, type MapFile } from './map';
 import type { World } from './world';
 /**
@@ -53,4 +53,4 @@ export declare function scenarioOfWorld(world: World, name: string, description?
  *
  * @beta
  */
-export declare function scenarioWorld(scenario: ScenarioFile, game: GameModule): Promise<World>;
+export declare function scenarioWorld(scenario: ScenarioFile, game: Rules): Promise<World>;