@v12-engine/engine 0.1.0 → 0.4.0

package/dist/scenario.js

@@ -0,0 +1,99 @@
+import { parseMap, serializeMap } from "./map/file.js";
+import { decodeSave, encodeSave, saveWorld } from "./save.js";
+import { createWorldFromMap, loadWorld } from "./game.js";
+//#region src/scenario.ts
+/**
+* The format scenarios are written in now
+*
+* @beta
+*/
+var SCENARIO_FORMAT = 1;
+/**
+* A scenario file as it is now, checked. Throws on what is wrong with it
+*
+* @beta
+*/
+function readScenario(data) {
+	if (typeof data !== "object" || data === null || Array.isArray(data)) throw new Error("A scenario is an object");
+	const file = data;
+	if (typeof file.format !== "number" || file.format > 1) throw new Error(`A scenario of format ${file.format}, which this engine does not know`);
+	if (typeof file.name !== "string" || !file.name) throw new Error("A scenario has a name");
+	if (typeof file.game !== "string" || !file.game) throw new Error(`The scenario ${file.name} does not say which game it is of`);
+	if (file.kind === "map") parseMap(file.map);
+	else if (file.kind === "save") {
+		if (typeof file.save !== "string") throw new Error(`The scenario ${file.name} has no save in it`);
+	} else throw new Error(`The scenario ${file.name} is neither a map nor a save`);
+	return {
+		...file,
+		format: 1
+	};
+}
+/**
+* A map made for a test, as a scenario
+*
+* @beta
+*/
+function scenarioOfMap(map, name, game, description) {
+	return {
+		format: 1,
+		name,
+		game,
+		...description && { description },
+		kind: "map",
+		map: serializeMap(map)
+	};
+}
+/**
+* A world at the moment that matters, as a scenario
+*
+* @beta
+*/
+function scenarioOfWorld(world, name, description) {
+	return {
+		format: 1,
+		name,
+		game: world.registry.game,
+		...description && { description },
+		kind: "save",
+		save: encodeSave(portableSave(world.registry, saveWorld(world)))
+	};
+}
+/** Only what is the game's: what an app keeps of its own in the world (`Component.portable` false) left out */
+function portableSave(registry, save) {
+	const keep = (values) => values && Object.fromEntries(Object.entries(values).filter(([id]) => registry.component(id)?.portable !== false));
+	return {
+		...save,
+		state: keep(save.state),
+		players: save.players.map((player) => ({
+			...player,
+			state: keep(player.state)
+		})),
+		entities: save.entities.map((entity) => entity.components ? {
+			...entity,
+			components: keep(entity.components)
+		} : entity),
+		detached: save.detached.map((entity) => entity.components ? {
+			...entity,
+			components: keep(entity.components)
+		} : entity)
+	};
+}
+/**
+* The world of a scenario, with the game's module: a map made into a world as a game would make it (with the seed 1,
+* so that it is the same every time), or a saved world loaded as it was
+*
+* @beta
+*/
+async function scenarioWorld(scenario, game) {
+	if (scenario.game !== game.id) throw new Error(`The scenario ${scenario.name} is of the game "${scenario.game}", not "${game.id}"`);
+	if (scenario.kind === "map") return createWorldFromMap({
+		map: parseMap(scenario.map),
+		rules: game,
+		seed: 1
+	});
+	return loadWorld(decodeSave(scenario.save), { rules: game });
+}
+//#endregion
+export { SCENARIO_FORMAT, readScenario, scenarioOfMap, scenarioOfWorld, scenarioWorld };
+
+//# sourceMappingURL=scenario.js.map

package/dist/scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenario.js","names":[],"sources":["../src/scenario.ts"],"sourcesContent":["import { createWorldFromMap, type Rules, loadWorld } from './game'\nimport { type GameMap, type MapFile, parseMap, serializeMap } from './map'\nimport { decodeSave, encodeSave, saveWorld, type WorldSave } from './save'\nimport type { Registry } from './registry'\nimport type { World } from './world'\n\n/**\n * A situation for a test to start from, set up in the editor: a map made for it, or a world saved at the moment that\n * matters (in the editor's play mode). Kept in the tests' scenarios (`<scenarios>/<game>/<name>.scenario.json`: `tests/scenarios` unless the project says otherwise), or in a game's folder,\n * and loaded with what was named in the editor found by name. It says which format it was saved with, and is brought\n * up to date like a map (`readScenario`): one that no longer loads fails its test with what is wrong\n *\n * @beta\n */\nexport type ScenarioFile = {\n\tformat: number\n\tname: string\n\t/** The game it is of, by the id of its module */\n\tgame: string\n\t/** What it is for, to read in a list */\n\tdescription?: string\n} & ({ kind: 'map'; map: MapFile } | { kind: 'save'; save: string })\n\n/**\n * The format scenarios are written in now\n *\n * @beta\n */\nexport const SCENARIO_FORMAT = 1\n\n/**\n * A scenario file as it is now, checked. Throws on what is wrong with it\n *\n * @beta\n */\nexport function readScenario(data: unknown): ScenarioFile {\n\tif (typeof data !== 'object' || data === null || Array.isArray(data)) throw new Error('A scenario is an object')\n\tconst file = data as Partial<ScenarioFile> & Record<string, unknown>\n\tif (typeof file.format !== 'number' || file.format > SCENARIO_FORMAT)\n\t\tthrow new Error(`A scenario of format ${file.format}, which this engine does not know`)\n\tif (typeof file.name !== 'string' || !file.name) throw new Error('A scenario has a name')\n\tif (typeof file.game !== 'string' || !file.game) throw new Error(`The scenario ${file.name} does not say which game it is of`)\n\tif (file.kind === 'map') {\n\t\t// what a map file is is the map's to say: read now, so that a broken one says what is wrong at once\n\t\tparseMap(file.map)\n\t} else if (file.kind === 'save') {\n\t\tif (typeof file.save !== 'string') throw new Error(`The scenario ${file.name} has no save in it`)\n\t} else throw new Error(`The scenario ${file.name} is neither a map nor a save`)\n\treturn { ...(file as ScenarioFile), format: SCENARIO_FORMAT }\n}\n\n/**\n * A map made for a test, as a scenario\n *\n * @beta\n */\nexport function scenarioOfMap(map: GameMap, name: string, game: string, description?: string): ScenarioFile {\n\treturn { format: SCENARIO_FORMAT, name, game, ...(description && { description }), kind: 'map', map: serializeMap(map) }\n}\n\n/**\n * A world at the moment that matters, as a scenario\n *\n * @beta\n */\nexport function scenarioOfWorld(world: World, name: string, description?: string): ScenarioFile {\n\treturn {\n\t\tformat: SCENARIO_FORMAT,\n\t\tname,\n\t\tgame: world.registry.game,\n\t\t...(description && { description }),\n\t\tkind: 'save',\n\t\tsave: encodeSave(portableSave(world.registry, saveWorld(world)))\n\t}\n}\n\n/** Only what is the game's: what an app keeps of its own in the world (`Component.portable` false) left out */\nfunction portableSave(registry: Registry, save: WorldSave): WorldSave {\n\tconst keep = (values: Record<string, unknown> | undefined) =>\n\t\tvalues && Object.fromEntries(Object.entries(values).filter(([id]) => registry.component(id)?.portable !== false))\n\treturn {\n\t\t...save,\n\t\tstate: keep(save.state)!,\n\t\tplayers: save.players.map((player) => ({ ...player, state: keep(player.state)! })),\n\t\tentities: save.entities.map((entity) =>\n\t\t\tentity.components ? { ...entity, components: keep(entity.components as Record<string, unknown>) } : entity\n\t\t),\n\t\tdetached: save.detached.map((entity) =>\n\t\t\tentity.components ? { ...entity, components: keep(entity.components as Record<string, unknown>) } : entity\n\t\t)\n\t}\n}\n\n/**\n * The world of a scenario, with the game's module: a map made into a world as a game would make it (with the seed 1,\n * so that it is the same every time), or a saved world loaded as it was\n *\n * @beta\n */\nexport async function scenarioWorld(scenario: ScenarioFile, game: Rules): Promise<World> {\n\tif (scenario.game !== game.id) throw new Error(`The scenario ${scenario.name} is of the game \"${scenario.game}\", not \"${game.id}\"`)\n\tif (scenario.kind === 'map') return createWorldFromMap({ map: parseMap(scenario.map), rules: game, seed: 1 })\n\treturn loadWorld(decodeSave(scenario.save), { rules: game })\n}\n"],"mappings":";;;;;;;;;AA4BA,IAAa,kBAAkB;;;;;;AAO/B,SAAgB,aAAa,MAA6B;CACzD,IAAI,OAAO,SAAS,YAAY,SAAS,QAAQ,MAAM,QAAQ,IAAI,GAAG,MAAM,IAAI,MAAM,yBAAyB;CAC/G,MAAM,OAAO;CACb,IAAI,OAAO,KAAK,WAAW,YAAY,KAAK,SAAA,GAC3C,MAAM,IAAI,MAAM,wBAAwB,KAAK,OAAO,kCAAkC;CACvF,IAAI,OAAO,KAAK,SAAS,YAAY,CAAC,KAAK,MAAM,MAAM,IAAI,MAAM,uBAAuB;CACxF,IAAI,OAAO,KAAK,SAAS,YAAY,CAAC,KAAK,MAAM,MAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,kCAAkC;CAC7H,IAAI,KAAK,SAAS,OAEjB,SAAS,KAAK,GAAG;MACX,IAAI,KAAK,SAAS,QACpB;MAAA,OAAO,KAAK,SAAS,UAAU,MAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,mBAAmB;CAAA,OAC1F,MAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,6BAA6B;CAC9E,OAAO;EAAE,GAAI;EAAuB,QAAA;CAAwB;AAC7D;;;;;;AAOA,SAAgB,cAAc,KAAc,MAAc,MAAc,aAAoC;CAC3G,OAAO;EAAE,QAAA;EAAyB;EAAM;EAAM,GAAI,eAAe,EAAE,YAAY;EAAI,MAAM;EAAO,KAAK,aAAa,GAAG;CAAE;AACxH;;;;;;AAOA,SAAgB,gBAAgB,OAAc,MAAc,aAAoC;CAC/F,OAAO;EACN,QAAA;EACA;EACA,MAAM,MAAM,SAAS;EACrB,GAAI,eAAe,EAAE,YAAY;EACjC,MAAM;EACN,MAAM,WAAW,aAAa,MAAM,UAAU,UAAU,KAAK,CAAC,CAAC;CAChE;AACD;;AAGA,SAAS,aAAa,UAAoB,MAA4B;CACrE,MAAM,QAAQ,WACb,UAAU,OAAO,YAAY,OAAO,QAAQ,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,SAAS,UAAU,EAAE,CAAC,EAAE,aAAa,KAAK,CAAC;CACjH,OAAO;EACN,GAAG;EACH,OAAO,KAAK,KAAK,KAAK;EACtB,SAAS,KAAK,QAAQ,KAAK,YAAY;GAAE,GAAG;GAAQ,OAAO,KAAK,OAAO,KAAK;EAAG,EAAE;EACjF,UAAU,KAAK,SAAS,KAAK,WAC5B,OAAO,aAAa;GAAE,GAAG;GAAQ,YAAY,KAAK,OAAO,UAAqC;EAAE,IAAI,MACrG;EACA,UAAU,KAAK,SAAS,KAAK,WAC5B,OAAO,aAAa;GAAE,GAAG;GAAQ,YAAY,KAAK,OAAO,UAAqC;EAAE,IAAI,MACrG;CACD;AACD;;;;;;;AAQA,eAAsB,cAAc,UAAwB,MAA6B;CACxF,IAAI,SAAS,SAAS,KAAK,IAAI,MAAM,IAAI,MAAM,gBAAgB,SAAS,KAAK,mBAAmB,SAAS,KAAK,UAAU,KAAK,GAAG,EAAE;CAClI,IAAI,SAAS,SAAS,OAAO,OAAO,mBAAmB;EAAE,KAAK,SAAS,SAAS,GAAG;EAAG,OAAO;EAAM,MAAM;CAAE,CAAC;CAC5G,OAAO,UAAU,WAAW,SAAS,IAAI,GAAG,EAAE,OAAO,KAAK,CAAC;AAC5D"}

package/dist/scheduler.d.ts

@@ -17,8 +17,11 @@ export declare const PHASES: readonly SystemPhase[];
  * @beta
  */
 export interface SystemTiming {
+    /** The system's name */
     name: string;
+    /** The phase the system runs in */
     phase: SystemPhase;
+    /** Averaged milliseconds the system takes per tick */
     ms: number;
 }
 /**

package/dist/scheduler.js

@@ -0,0 +1,156 @@
+//#region src/scheduler.ts
+/**
+* The parts of a tick, in the order they run. The player commands of the tick have been applied before any of them.
+* - `commands`: first, for what reacts to the commands, or adds some of its own
+* - `decide`: units choose and carry out what they do: abilities, orders
+* - `move`: everything that moves, moves
+* - `resolve`: what follows from where things ended up: attacks land, buildings go up, units are trained
+* - `cleanup`: bookkeeping once everything happened: what runs out, what each team sees, who won
+*
+* @beta
+*/
+var PHASES = [
+	"commands",
+	"decide",
+	"move",
+	"resolve",
+	"cleanup"
+];
+/** Where a system without a phase runs: after everything, like the systems of game modules always did */
+var DEFAULT_PHASE = "cleanup";
+/** How much of each new tick goes into the averaged time of a system. Small: the panel shows a steady number */
+var SMOOTHING = .02;
+/**
+* Runs the systems of a world in their order, each as often as it asks. The order is worked out whenever a system
+* is added or taken out: by phase first, then by what each says it comes `before` or `after`, then in the order
+* they were added. Measures each one while `profiling` is on, for the stats panel.
+*
+* @beta
+*/
+var Scheduler = class {
+	added = [];
+	ordered = [];
+	timings = /* @__PURE__ */ new Map();
+	/** Whether to time each system. Costs two clock readings per system per tick, so it is off unless someone looks */
+	profiling = false;
+	constructor(systems) {
+		for (const system of systems) {
+			this.check(system);
+			this.added.push(system);
+		}
+		this.ordered = order(this.added).filter((system) => !this.off.has(system.name));
+	}
+	/** The systems, in the order they run */
+	get systems() {
+		return this.ordered;
+	}
+	/** Adds a system to a world that is already running, like a computer player */
+	add(system) {
+		this.check(system);
+		this.added.push(system);
+		this.ordered = order(this.added).filter((system) => !this.off.has(system.name));
+	}
+	/** Takes a system out by name. False when there is none of that name */
+	remove(name) {
+		const index = this.added.findIndex((system) => system.name === name);
+		if (index < 0) return false;
+		this.added.splice(index, 1);
+		this.ordered = order(this.added).filter((system) => !this.off.has(system.name));
+		this.timings.delete(name);
+		return true;
+	}
+	/** Runs one tick of every system that is due. Each is given the time since it last ran */
+	run(world) {
+		const { tick, dt } = world;
+		for (const system of this.ordered) {
+			const every = system.every ?? 1;
+			const due = every === 1 || tick % every === (system.offset ?? 0) % every;
+			if (!this.profiling) {
+				if (due) this.update(system, world, dt * every);
+				continue;
+			}
+			const start = performance.now();
+			if (due) this.update(system, world, dt * every);
+			const took = due ? performance.now() - start : 0;
+			const before = this.timings.get(system.name);
+			this.timings.set(system.name, before === void 0 ? took : before + (took - before) * SMOOTHING);
+		}
+	}
+	/** Runs a system. One that throws comes to what the world says of errors (`World.caught`): switched off, where it says so */
+	update(system, world, dt) {
+		try {
+			system.update?.(world, dt);
+			if (system.each) runEach(system, world, dt);
+		} catch (error) {
+			world.caught(error, {
+				kind: "system",
+				id: system.name
+			});
+			this.disable(system.name);
+		}
+	}
+	off = /* @__PURE__ */ new Set();
+	/** Switches a system off: it no longer runs, and stays off when others are added */
+	disable(name) {
+		this.off.add(name);
+		this.ordered = this.ordered.filter((system) => system.name !== name);
+	}
+	/** What each system takes, in the order they run. Empty until `profiling` has been on for a while */
+	timing() {
+		return this.ordered.flatMap((system) => {
+			const ms = this.timings.get(system.name);
+			return ms === void 0 ? [] : [{
+				name: system.name,
+				phase: system.phase ?? DEFAULT_PHASE,
+				ms
+			}];
+		});
+	}
+	check(system) {
+		if (this.added.some((other) => other.name === system.name)) throw new Error(`There is a system called "${system.name}" already`);
+		if (!system.update && !system.each) throw new Error(`System "${system.name}" has neither update nor each: nothing to run`);
+		if (system.every !== void 0 && (!Number.isInteger(system.every) || system.every < 1)) throw new Error(`System "${system.name}" runs every ${system.every} ticks: that has to be a whole number, 1 or more`);
+	}
+};
+/** Runs a system's `each` over what it says (`System.over`): the units, what has a component in the order of its id, or a test's */
+function runEach(system, world, dt) {
+	const each = system.each;
+	const { over } = system;
+	if (over === void 0 || over === "units") for (const entity of world.units.values()) each.call(system, world, entity, dt);
+	else if (typeof over === "function") {
+		for (const entity of world.units.values()) if (over(entity, world)) each.call(system, world, entity, dt);
+	} else for (const entity of world.index.ordered(over)) each.call(system, world, entity, dt);
+}
+/**
+* Sorts systems by phase, then by `before` and `after`, keeping the order they were given in where nothing says
+* otherwise. Names that are not among them are passed over: what they named may have been left out of the game.
+* The modules of a computer player's brain are put in their order by it too (`ai/brain.ts`)
+*/
+function order(systems) {
+	const phaseOf = (system) => PHASES.indexOf(system.phase ?? DEFAULT_PHASE);
+	const byName = new Map(systems.map((system) => [system.name, system]));
+	const needs = new Map(systems.map((system) => [system, /* @__PURE__ */ new Set()]));
+	const rule = (first, then) => {
+		if (phaseOf(first) > phaseOf(then)) throw new Error(`System "${first.name}" cannot run before "${then.name}": it is in a later phase (${first.phase ?? DEFAULT_PHASE})`);
+		needs.get(then).add(first);
+	};
+	for (const system of systems) {
+		for (const name of system.before ?? []) if (byName.has(name)) rule(system, byName.get(name));
+		for (const name of system.after ?? []) if (byName.has(name)) rule(byName.get(name), system);
+	}
+	const result = [];
+	const done = /* @__PURE__ */ new Set();
+	const waiting = [...systems].sort((a, b) => phaseOf(a) - phaseOf(b));
+	while (waiting.length) {
+		const index = waiting.findIndex((system) => [...needs.get(system)].every((first) => done.has(first)));
+		if (index < 0) throw new Error(`Systems wait for each other in a circle: ${waiting.map((system) => system.name).join(", ")}`);
+		const [next] = waiting.splice(index, 1);
+		done.add(next);
+		result.push(next);
+	}
+	return result;
+}
+//#endregion
+export { PHASES, Scheduler, order };
+
+//# sourceMappingURL=scheduler.js.map

package/dist/scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.js","names":[],"sources":["../src/scheduler.ts"],"sourcesContent":["import type { System, SystemPhase } from './registry'\nimport type { World } from './world'\n\n/**\n * The parts of a tick, in the order they run. The player commands of the tick have been applied before any of them.\n * - `commands`: first, for what reacts to the commands, or adds some of its own\n * - `decide`: units choose and carry out what they do: abilities, orders\n * - `move`: everything that moves, moves\n * - `resolve`: what follows from where things ended up: attacks land, buildings go up, units are trained\n * - `cleanup`: bookkeeping once everything happened: what runs out, what each team sees, who won\n *\n * @beta\n */\nexport const PHASES: readonly SystemPhase[] = ['commands', 'decide', 'move', 'resolve', 'cleanup']\n\n/** Where a system without a phase runs: after everything, like the systems of game modules always did */\nconst DEFAULT_PHASE: SystemPhase = 'cleanup'\n\n/** How much of each new tick goes into the averaged time of a system. Small: the panel shows a steady number */\nconst SMOOTHING = 0.02\n\n/**\n * What the scheduler measured of a system: milliseconds per tick, averaged, with the ticks it does not run counted as nothing\n *\n * @beta\n */\nexport interface SystemTiming {\n\t/** The system's name */\n\tname: string\n\t/** The phase the system runs in */\n\tphase: SystemPhase\n\t/** Averaged milliseconds the system takes per tick */\n\tms: number\n}\n\n/**\n * Runs the systems of a world in their order, each as often as it asks. The order is worked out whenever a system\n * is added or taken out: by phase first, then by what each says it comes `before` or `after`, then in the order\n * they were added. Measures each one while `profiling` is on, for the stats panel.\n *\n * @beta\n */\nexport class Scheduler {\n\tprivate readonly added: System[] = []\n\tprivate ordered: System[] = []\n\tprivate readonly timings = new Map<string, number>()\n\t/** Whether to time each system. Costs two clock readings per system per tick, so it is off unless someone looks */\n\tprofiling = false\n\n\tconstructor(systems: System[]) {\n\t\tfor (const system of systems) {\n\t\t\tthis.check(system)\n\t\t\tthis.added.push(system)\n\t\t}\n\t\tthis.ordered = order(this.added).filter((system) => !this.off.has(system.name))\n\t}\n\n\t/** The systems, in the order they run */\n\tget systems(): readonly System[] {\n\t\treturn this.ordered\n\t}\n\n\t/** Adds a system to a world that is already running, like a computer player */\n\tadd(system: System): void {\n\t\tthis.check(system)\n\t\tthis.added.push(system)\n\t\tthis.ordered = order(this.added).filter((system) => !this.off.has(system.name))\n\t}\n\n\t/** Takes a system out by name. False when there is none of that name */\n\tremove(name: string): boolean {\n\t\tconst index = this.added.findIndex((system) => system.name === name)\n\t\tif (index < 0) return false\n\t\tthis.added.splice(index, 1)\n\t\tthis.ordered = order(this.added).filter((system) => !this.off.has(system.name))\n\t\tthis.timings.delete(name)\n\t\treturn true\n\t}\n\n\t/** Runs one tick of every system that is due. Each is given the time since it last ran */\n\trun(world: World): void {\n\t\tconst { tick, dt } = world\n\t\tfor (const system of this.ordered) {\n\t\t\tconst every = system.every ?? 1\n\t\t\tconst due = every === 1 || tick % every === (system.offset ?? 0) % every\n\t\t\tif (!this.profiling) {\n\t\t\t\tif (due) this.update(system, world, dt * every)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tconst start = performance.now()\n\t\t\tif (due) this.update(system, world, dt * every)\n\t\t\tconst took = due ? performance.now() - start : 0\n\t\t\tconst before = this.timings.get(system.name)\n\t\t\tthis.timings.set(system.name, before === undefined ? took : before + (took - before) * SMOOTHING)\n\t\t}\n\t}\n\n\t/** Runs a system. One that throws comes to what the world says of errors (`World.caught`): switched off, where it says so */\n\tprivate update(system: System, world: World, dt: number): void {\n\t\ttry {\n\t\t\tsystem.update?.(world, dt)\n\t\t\tif (system.each) runEach(system, world, dt)\n\t\t} catch (error) {\n\t\t\tworld.caught(error, { kind: 'system', id: system.name })\n\t\t\tthis.disable(system.name)\n\t\t}\n\t}\n\n\tprivate readonly off = new Set<string>()\n\n\t/** Switches a system off: it no longer runs, and stays off when others are added */\n\tdisable(name: string): void {\n\t\tthis.off.add(name)\n\t\tthis.ordered = this.ordered.filter((system) => system.name !== name)\n\t}\n\n\t/** What each system takes, in the order they run. Empty until `profiling` has been on for a while */\n\ttiming(): SystemTiming[] {\n\t\treturn this.ordered.flatMap((system) => {\n\t\t\tconst ms = this.timings.get(system.name)\n\t\t\treturn ms === undefined ? [] : [{ name: system.name, phase: system.phase ?? DEFAULT_PHASE, ms }]\n\t\t})\n\t}\n\n\tprivate check(system: System): void {\n\t\tif (this.added.some((other) => other.name === system.name)) throw new Error(`There is a system called \"${system.name}\" already`)\n\t\tif (!system.update && !system.each) throw new Error(`System \"${system.name}\" has neither update nor each: nothing to run`)\n\t\tif (system.every !== undefined && (!Number.isInteger(system.every) || system.every < 1))\n\t\t\tthrow new Error(`System \"${system.name}\" runs every ${system.every} ticks: that has to be a whole number, 1 or more`)\n\t}\n}\n\n/** Runs a system's `each` over what it says (`System.over`): the units, what has a component in the order of its id, or a test's */\nfunction runEach(system: System, world: World, dt: number): void {\n\tconst each = system.each!\n\tconst { over } = system\n\tif (over === undefined || over === 'units') {\n\t\tfor (const entity of world.units.values()) each.call(system, world, entity, dt)\n\t} else if (typeof over === 'function') {\n\t\tfor (const entity of world.units.values()) if (over(entity, world)) each.call(system, world, entity, dt)\n\t} else {\n\t\tfor (const entity of world.index.ordered(over)) each.call(system, world, entity, dt)\n\t}\n}\n\n/** What `order` sorts: a system, or anything else that runs in turn and says what it comes before and after (a brain's modules) */\nexport interface Ordered {\n\tname: string\n\tphase?: SystemPhase\n\tbefore?: string[]\n\tafter?: string[]\n}\n\n/**\n * Sorts systems by phase, then by `before` and `after`, keeping the order they were given in where nothing says\n * otherwise. Names that are not among them are passed over: what they named may have been left out of the game.\n * The modules of a computer player's brain are put in their order by it too (`ai/brain.ts`)\n */\nexport function order<T extends Ordered>(systems: T[]): T[] {\n\tconst phaseOf = (system: T) => PHASES.indexOf(system.phase ?? DEFAULT_PHASE)\n\tconst byName = new Map(systems.map((system) => [system.name, system]))\n\t// for each system, the ones that have to run before it\n\tconst needs = new Map<T, Set<T>>(systems.map((system) => [system, new Set()]))\n\tconst rule = (first: T, then: T) => {\n\t\tif (phaseOf(first) > phaseOf(then))\n\t\t\tthrow new Error(`System \"${first.name}\" cannot run before \"${then.name}\": it is in a later phase (${first.phase ?? DEFAULT_PHASE})`)\n\t\tneeds.get(then)!.add(first)\n\t}\n\tfor (const system of systems) {\n\t\tfor (const name of system.before ?? []) if (byName.has(name)) rule(system, byName.get(name)!)\n\t\tfor (const name of system.after ?? []) if (byName.has(name)) rule(byName.get(name)!, system)\n\t}\n\n\tconst result: T[] = []\n\tconst done = new Set<T>()\n\t// phase by phase, the first system in the given order that has nothing left to wait for\n\tconst waiting = [...systems].sort((a, b) => phaseOf(a) - phaseOf(b))\n\twhile (waiting.length) {\n\t\tconst index = waiting.findIndex((system) => [...needs.get(system)!].every((first) => done.has(first)))\n\t\tif (index < 0) throw new Error(`Systems wait for each other in a circle: ${waiting.map((system) => system.name).join(', ')}`)\n\t\tconst [next] = waiting.splice(index, 1)\n\t\tdone.add(next)\n\t\tresult.push(next)\n\t}\n\treturn result\n}\n"],"mappings":";;;;;;;;;;;AAaA,IAAa,SAAiC;CAAC;CAAY;CAAU;CAAQ;CAAW;AAAS;;AAGjG,IAAM,gBAA6B;;AAGnC,IAAM,YAAY;;;;;;;;AAuBlB,IAAa,YAAb,MAAuB;CACtB,QAAmC,CAAC;CACpC,UAA4B,CAAC;CAC7B,0BAA2B,IAAI,IAAoB;;CAEnD,YAAY;CAEZ,YAAY,SAAmB;EAC9B,KAAK,MAAM,UAAU,SAAS;GAC7B,KAAK,MAAM,MAAM;GACjB,KAAK,MAAM,KAAK,MAAM;EACvB;EACA,KAAK,UAAU,MAAM,KAAK,KAAK,CAAC,CAAC,QAAQ,WAAW,CAAC,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC;CAC/E;;CAGA,IAAI,UAA6B;EAChC,OAAO,KAAK;CACb;;CAGA,IAAI,QAAsB;EACzB,KAAK,MAAM,MAAM;EACjB,KAAK,MAAM,KAAK,MAAM;EACtB,KAAK,UAAU,MAAM,KAAK,KAAK,CAAC,CAAC,QAAQ,WAAW,CAAC,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC;CAC/E;;CAGA,OAAO,MAAuB;EAC7B,MAAM,QAAQ,KAAK,MAAM,WAAW,WAAW,OAAO,SAAS,IAAI;EACnE,IAAI,QAAQ,GAAG,OAAO;EACtB,KAAK,MAAM,OAAO,OAAO,CAAC;EAC1B,KAAK,UAAU,MAAM,KAAK,KAAK,CAAC,CAAC,QAAQ,WAAW,CAAC,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC;EAC9E,KAAK,QAAQ,OAAO,IAAI;EACxB,OAAO;CACR;;CAGA,IAAI,OAAoB;EACvB,MAAM,EAAE,MAAM,OAAO;EACrB,KAAK,MAAM,UAAU,KAAK,SAAS;GAClC,MAAM,QAAQ,OAAO,SAAS;GAC9B,MAAM,MAAM,UAAU,KAAK,OAAO,WAAW,OAAO,UAAU,KAAK;GACnE,IAAI,CAAC,KAAK,WAAW;IACpB,IAAI,KAAK,KAAK,OAAO,QAAQ,OAAO,KAAK,KAAK;IAC9C;GACD;GACA,MAAM,QAAQ,YAAY,IAAI;GAC9B,IAAI,KAAK,KAAK,OAAO,QAAQ,OAAO,KAAK,KAAK;GAC9C,MAAM,OAAO,MAAM,YAAY,IAAI,IAAI,QAAQ;GAC/C,MAAM,SAAS,KAAK,QAAQ,IAAI,OAAO,IAAI;GAC3C,KAAK,QAAQ,IAAI,OAAO,MAAM,WAAW,KAAA,IAAY,OAAO,UAAU,OAAO,UAAU,SAAS;EACjG;CACD;;CAGA,OAAe,QAAgB,OAAc,IAAkB;EAC9D,IAAI;GACH,OAAO,SAAS,OAAO,EAAE;GACzB,IAAI,OAAO,MAAM,QAAQ,QAAQ,OAAO,EAAE;EAC3C,SAAS,OAAO;GACf,MAAM,OAAO,OAAO;IAAE,MAAM;IAAU,IAAI,OAAO;GAAK,CAAC;GACvD,KAAK,QAAQ,OAAO,IAAI;EACzB;CACD;CAEA,sBAAuB,IAAI,IAAY;;CAGvC,QAAQ,MAAoB;EAC3B,KAAK,IAAI,IAAI,IAAI;EACjB,KAAK,UAAU,KAAK,QAAQ,QAAQ,WAAW,OAAO,SAAS,IAAI;CACpE;;CAGA,SAAyB;EACxB,OAAO,KAAK,QAAQ,SAAS,WAAW;GACvC,MAAM,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI;GACvC,OAAO,OAAO,KAAA,IAAY,CAAC,IAAI,CAAC;IAAE,MAAM,OAAO;IAAM,OAAO,OAAO,SAAS;IAAe;GAAG,CAAC;EAChG,CAAC;CACF;CAEA,MAAc,QAAsB;EACnC,IAAI,KAAK,MAAM,MAAM,UAAU,MAAM,SAAS,OAAO,IAAI,GAAG,MAAM,IAAI,MAAM,6BAA6B,OAAO,KAAK,UAAU;EAC/H,IAAI,CAAC,OAAO,UAAU,CAAC,OAAO,MAAM,MAAM,IAAI,MAAM,WAAW,OAAO,KAAK,8CAA8C;EACzH,IAAI,OAAO,UAAU,KAAA,MAAc,CAAC,OAAO,UAAU,OAAO,KAAK,KAAK,OAAO,QAAQ,IACpF,MAAM,IAAI,MAAM,WAAW,OAAO,KAAK,eAAe,OAAO,MAAM,iDAAiD;CACtH;AACD;;AAGA,SAAS,QAAQ,QAAgB,OAAc,IAAkB;CAChE,MAAM,OAAO,OAAO;CACpB,MAAM,EAAE,SAAS;CACjB,IAAI,SAAS,KAAA,KAAa,SAAS,SAClC,KAAK,MAAM,UAAU,MAAM,MAAM,OAAO,GAAG,KAAK,KAAK,QAAQ,OAAO,QAAQ,EAAE;MACxE,IAAI,OAAO,SAAS,YACrB;OAAA,MAAM,UAAU,MAAM,MAAM,OAAO,GAAG,IAAI,KAAK,QAAQ,KAAK,GAAG,KAAK,KAAK,QAAQ,OAAO,QAAQ,EAAE;CAAA,OAEvG,KAAK,MAAM,UAAU,MAAM,MAAM,QAAQ,IAAI,GAAG,KAAK,KAAK,QAAQ,OAAO,QAAQ,EAAE;AAErF;;;;;;AAeA,SAAgB,MAAyB,SAAmB;CAC3D,MAAM,WAAW,WAAc,OAAO,QAAQ,OAAO,SAAS,aAAa;CAC3E,MAAM,SAAS,IAAI,IAAI,QAAQ,KAAK,WAAW,CAAC,OAAO,MAAM,MAAM,CAAC,CAAC;CAErE,MAAM,QAAQ,IAAI,IAAe,QAAQ,KAAK,WAAW,CAAC,wBAAQ,IAAI,IAAI,CAAC,CAAC,CAAC;CAC7E,MAAM,QAAQ,OAAU,SAAY;EACnC,IAAI,QAAQ,KAAK,IAAI,QAAQ,IAAI,GAChC,MAAM,IAAI,MAAM,WAAW,MAAM,KAAK,uBAAuB,KAAK,KAAK,6BAA6B,MAAM,SAAS,cAAc,EAAE;EACpI,MAAM,IAAI,IAAI,CAAC,CAAE,IAAI,KAAK;CAC3B;CACA,KAAK,MAAM,UAAU,SAAS;EAC7B,KAAK,MAAM,QAAQ,OAAO,UAAU,CAAC,GAAG,IAAI,OAAO,IAAI,IAAI,GAAG,KAAK,QAAQ,OAAO,IAAI,IAAI,CAAE;EAC5F,KAAK,MAAM,QAAQ,OAAO,SAAS,CAAC,GAAG,IAAI,OAAO,IAAI,IAAI,GAAG,KAAK,OAAO,IAAI,IAAI,GAAI,MAAM;CAC5F;CAEA,MAAM,SAAc,CAAC;CACrB,MAAM,uBAAO,IAAI,IAAO;CAExB,MAAM,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC;CACnE,OAAO,QAAQ,QAAQ;EACtB,MAAM,QAAQ,QAAQ,WAAW,WAAW,CAAC,GAAG,MAAM,IAAI,MAAM,CAAE,CAAC,CAAC,OAAO,UAAU,KAAK,IAAI,KAAK,CAAC,CAAC;EACrG,IAAI,QAAQ,GAAG,MAAM,IAAI,MAAM,4CAA4C,QAAQ,KAAK,WAAW,OAAO,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG;EAC5H,MAAM,CAAC,QAAQ,QAAQ,OAAO,OAAO,CAAC;EACtC,KAAK,IAAI,IAAI;EACb,OAAO,KAAK,IAAI;CACjB;CACA,OAAO;AACR"}

package/dist/score.d.ts

@@ -1,7 +1,7 @@
 import { type Component } from './components';
 import type { PlayerId } from './entity';
 import type { EventKey } from './events';
-import type { GameModule } from './game';
+import type { Rules } from './game';
 import type { System } from './registry';
 import type { World } from './world';
 /**
@@ -52,7 +52,7 @@ export interface ScoreSource {
     count(payload: any, world: World): ScoreCounted;
 }
 /**
- * A number the score keeps for each player (`GameRules.score`, `defineStat`): what it is called, how it adds up, where
+ * A number the score keeps for each player (`RuleSettings.score`, `defineStat`): what it is called, how it adds up, where
  * it comes from, and how it is shown. One with no source is counted by the game's code alone (`world.score.add`)
  *
  * @beta
@@ -77,7 +77,7 @@ export interface ScoreStatDef {
     sample?(world: World, player: PlayerId): number | undefined;
     /** Kept by what it was counted of too (`ScoreCount.type`): units killed by unit type, abilities cast by ability */
     byType?: boolean;
-    /** On the timeline: sampled every `ScoreRules.every` seconds, for a screen's graph */
+    /** On the timeline: sampled every `ScoreSettings.every` seconds, for a screen's graph */
     timeline?: boolean;
     /** How its number is written: `number` (when left out), `decimal`, `percent` (0 to 1), `time` (seconds) */
     format?: ScoreFormat;
@@ -92,14 +92,14 @@ export interface ScoreStatDef {
  */
 export type ScoreAudience = 'own' | 'allies' | 'everyone' | 'none' | ((world: World, viewer: PlayerId | undefined, player: PlayerId) => boolean);
 /**
- * What a game counts of its players (`GameRules.score`): the stats, how often the timeline is sampled, and who is told
+ * What a game counts of its players (`RuleSettings.score`): the stats, how often the timeline is sampled, and who is told
  * what while the game goes on and after it ended. `presetScore()` makes one of the engine's stats
  *
  * @beta
  */
-export interface ScoreRules {
+export interface ScoreSettings {
     /** The stats, or what makes them of the game (the engine's set makes one of each resource) */
-    stats: readonly ScoreStatDef[] | ((game: GameModule) => readonly ScoreStatDef[]);
+    stats: readonly ScoreStatDef[] | ((game: Rules) => readonly ScoreStatDef[]);
     /** Seconds between two points of the timeline: 10 when left out, 0 for no timeline */
     every?: number;
     /**
@@ -128,7 +128,7 @@ export interface ScoreRules {
  */
 export interface ResolvedScore {
     /** The rules as the game gave them */
-    readonly rules: ScoreRules;
+    readonly rules: ScoreSettings;
     /** Every stat, made */
     readonly stats: readonly ScoreStatDef[];
     /** Every stat by its id */
@@ -173,7 +173,7 @@ export declare const scoreData: Component<ScoreData>;
 export interface ScoreState {
     /** The tick the numbers stood at */
     tick: number;
-    /** The game is decided: these are the numbers it ended with, told as `ScoreRules.end` says */
+    /** The game is decided: these are the numbers it ended with, told as `ScoreSettings.end` says */
     final: boolean;
     /** Whose numbers are in it */
     players: PlayerId[];
@@ -204,15 +204,15 @@ export interface ScoreLineState {
  */
 export declare function scoreOn<T>(event: EventKey<T>, count: (payload: T, world: World) => ScoreCounted): ScoreSource;
 /**
- * A stat of the game's own, for `GameRules.score`: `defineStat('towersLost', { label: 'Towers lost', category: 'units',
+ * A stat of the game's own, for `RuleSettings.score`: `defineStat({ id: 'towersLost', label: 'Towers lost', category: 'units',
  * from: scoreOn(entityDied, ({ entity }) => entity.def.tags?.includes('tower') ? entity.owner : undefined) })`.
  * One with no source is counted in code (`world.score.add(player, 'towersLost')`)
  *
- * @beta
+ * @public
  */
-export declare function defineStat(id: string, def?: Omit<ScoreStatDef, 'id'>): ScoreStatDef;
+export declare function defineStat(def: ScoreStatDef): ScoreStatDef;
 /** The score's rules with their stats made of the game, checked: an id twice, or a timeline of no length, throws */
-export declare function resolveScore(rules: ScoreRules | undefined | null, game: GameModule): ResolvedScore | null;
+export declare function resolveScore(rules: ScoreSettings | undefined | null, game: Rules): ResolvedScore | null;
 /**
  * The score of a world (`world.score`): counts what its stats are told of the world's events, takes the gauges and
  * the timeline's points, and is what the game's code counts with, and reads, in the rules. What it keeps is the
@@ -276,14 +276,14 @@ export declare function scoreSystem(world: World): System;
  *
  * @beta
  */
-export declare function engineStats(game: GameModule): ScoreStatDef[];
+export declare function engineStats(game: Rules): ScoreStatDef[];
 /**
  * What `presetScore` is given: which of the engine's stats (`only`, or all but `without`), stats of the game's own
  * after them, and the score's other rules
  *
  * @beta
  */
-export interface PresetScoreOptions extends Omit<ScoreRules, 'stats'> {
+export interface PresetScoreOptions extends Omit<ScoreSettings, 'stats'> {
     /** Only these of the engine's stats, by id (`gathered` for every `gathered.<resource>`) */
     only?: readonly string[];
     /** The engine's stats but these, by id or as `only` */
@@ -292,15 +292,15 @@ export interface PresetScoreOptions extends Omit<ScoreRules, 'stats'> {
     stats?: readonly ScoreStatDef[];
 }
 /**
- * The engine's score, for `GameRules.score`: a classic RTS score screen. Units produced, killed and lost, buildings
+ * The engine's score, for `RuleSettings.score`: a classic RTS score screen. Units produced, killed and lost, buildings
  * built, razed and lost, the army and the largest, heroes killed and lost, the highest hero level, experience, creeps
  * killed, items obtained, abilities cast, damage dealt and taken, healing, and of each resource what was gathered,
  * spent and lost to upkeep, the bounty and what went between allies
  *
- * @beta
+ * @public
  */
-export declare function presetScore(options?: PresetScoreOptions): ScoreRules;
+export declare function presetScore(options?: PresetScoreOptions): ScoreSettings;
 /** The score the player is told (`Snapshot.score`) */
-export declare const scorePart: import("./replication").SnapshotPart<keyof import(".").Snapshot>;
+export declare const scorePart: import("./replication").SnapshotField<keyof import(".").Snapshot>;
 /** The score's line over time the player is told (`Snapshot.scoreLine`) */
-export declare const scoreLinePart: import("./replication").SnapshotPart<keyof import(".").Snapshot>;
+export declare const scoreLinePart: import("./replication").SnapshotField<keyof import(".").Snapshot>;