@v12-engine/engine 0.1.1 → 0.4.0

package/dist/proxies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxies.js","names":[],"sources":["../src/proxies.ts"],"sourcesContent":["import type { EffectContext } from './abilities/effects'\nimport type { EffectDef, ProxyOrigin } from './defs'\nimport type { Entity } from './entity'\nimport { hypot } from './exactMath'\nimport type { World } from './world'\n\n/*\n * Proxies (E2E-PLAN AB17): units of a caster's its effects go off from, as from itself (`EffectCommon.origin`): Zed's\n * shadows, Orianna's ball, Syndra's spheres, Azir's soldiers. Each picked is the context's `origin` for the effect\n * (AB1), the caster staying who does it; `sendProxy` (`abilities/effects/proxy.ts`) moves one to\n * where it was aimed\n */\n\n/** Who put a unit down, where the ground objects pack says (`madeBy`): read by its id, so that this brings in none of the pack */\nconst MADE_BY = 'core.madeBy'\n\n/** Whether a unit is the caster's: put down by it, or, where nothing says who put it down, its owner's */\nfunction isOf(world: World, unit: Entity, caster: Entity): boolean {\n\tconst component = world.registry.component(MADE_BY)\n\tconst made = component && (unit.get(component) as { by: number } | undefined)\n\treturn made ? made.by === caster.id : unit.owner === caster.owner\n}\n\n/**\n * The units of the caster's an effect with a proxy origin goes off from (`ProxyOrigin`), in the order it goes off from\n * them: those of its type that are the caster's (put down by it: `madeBy`; or its owner's where nothing says who put one\n * down), within its `range` of the caster and `near` where it was aimed, and of those the ones it picks. The caster is\n * not among them (`ProxyOrigin.caster` says when it goes off from it too). For a game's own effect, and a screen\n *\n * @beta\n */\nexport function proxiesOf(context: Pick<EffectContext, 'world' | 'caster' | 'point'>, origin: ProxyOrigin): Entity[] {\n\tconst { world, caster, point } = context\n\tconst found: Entity[] = []\n\tconst candidates = origin.range === undefined ? world.units.values() : world.spatial.query(caster.pos.x, caster.pos.z, origin.range + 2)\n\tfor (const unit of candidates) {\n\t\tif (unit === caster || !unit.alive || unit.hidden || unit.def.id !== origin.proxy || !isOf(world, unit, caster)) continue\n\t\tif (origin.range !== undefined && hypot(unit.pos.x - caster.pos.x, unit.pos.z - caster.pos.z) > origin.range) continue\n\t\tif (origin.near !== undefined && hypot(unit.pos.x - point.x, unit.pos.z - point.z) > origin.near) continue\n\t\tfound.push(unit)\n\t}\n\t// in the order they came into the world, whatever order they were found in\n\tfound.sort((a, b) => a.id - b.id)\n\tswitch (origin.pick ?? 'nearest') {\n\t\tcase 'all':\n\t\t\treturn found\n\t\tcase 'newest':\n\t\t\treturn found.slice(-1)\n\t\tcase 'oldest':\n\t\t\treturn found.slice(0, 1)\n\t\tdefault: {\n\t\t\tlet best: Entity | undefined\n\t\t\tlet gap = Infinity\n\t\t\tfor (const unit of found) {\n\t\t\t\tconst d = hypot(unit.pos.x - point.x, unit.pos.z - point.z)\n\t\t\t\tif (d < gap) [best, gap] = [unit, d]\n\t\t\t}\n\t\t\treturn best ? [best] : []\n\t\t}\n\t}\n}\n\n/**\n * Runs an effect with a proxy origin (`EffectCommon.origin`): once from the caster where it says so, and once from each\n * proxy it picks, that one the `origin` (its place the `point` with `at: 'proxy'`, and the `target` with `target`)\n *\n * @internal\n */\nexport function fromProxies(context: EffectContext, effect: EffectDef, each: (context: EffectContext) => void): void {\n\tconst origin = effect.origin!\n\tconst picked = proxiesOf(context, origin)\n\tconst fromCaster = origin.caster === true || (origin.caster === 'otherwise' && !picked.length)\n\tconst atProxy = origin.at === 'proxy'\n\tif (fromCaster) each(atProxy ? { ...context, point: { x: context.caster.pos.x, z: context.caster.pos.z } } : context)\n\tfor (const proxy of picked) {\n\t\tif (!proxy.alive) continue\n\t\teach({\n\t\t\t...context,\n\t\t\torigin: proxy,\n\t\t\t...(atProxy && { point: { x: proxy.pos.x, z: proxy.pos.z } }),\n\t\t\t...(origin.target && { target: proxy })\n\t\t})\n\t}\n}\n"],"mappings":";;;AAcA,IAAM,UAAU;;AAGhB,SAAS,KAAK,OAAc,MAAc,QAAyB;CAClE,MAAM,YAAY,MAAM,SAAS,UAAU,OAAO;CAClD,MAAM,OAAO,aAAc,KAAK,IAAI,SAAS;CAC7C,OAAO,OAAO,KAAK,OAAO,OAAO,KAAK,KAAK,UAAU,OAAO;AAC7D;;;;;;;;;AAUA,SAAgB,UAAU,SAA4D,QAA+B;CACpH,MAAM,EAAE,OAAO,QAAQ,UAAU;CACjC,MAAM,QAAkB,CAAC;CACzB,MAAM,aAAa,OAAO,UAAU,KAAA,IAAY,MAAM,MAAM,OAAO,IAAI,MAAM,QAAQ,MAAM,OAAO,IAAI,GAAG,OAAO,IAAI,GAAG,OAAO,QAAQ,CAAC;CACvI,KAAK,MAAM,QAAQ,YAAY;EAC9B,IAAI,SAAS,UAAU,CAAC,KAAK,SAAS,KAAK,UAAU,KAAK,IAAI,OAAO,OAAO,SAAS,CAAC,KAAK,OAAO,MAAM,MAAM,GAAG;EACjH,IAAI,OAAO,UAAU,KAAA,KAAa,MAAM,KAAK,IAAI,IAAI,OAAO,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,OAAO,OAAO;EAC9G,IAAI,OAAO,SAAS,KAAA,KAAa,MAAM,KAAK,IAAI,IAAI,MAAM,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,OAAO,MAAM;EAClG,MAAM,KAAK,IAAI;CAChB;CAEA,MAAM,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE;CAChC,QAAQ,OAAO,QAAQ,WAAvB;EACC,KAAK,OACJ,OAAO;EACR,KAAK,UACJ,OAAO,MAAM,MAAM,EAAE;EACtB,KAAK,UACJ,OAAO,MAAM,MAAM,GAAG,CAAC;EACxB,SAAS;GACR,IAAI;GACJ,IAAI,MAAM;GACV,KAAK,MAAM,QAAQ,OAAO;IACzB,MAAM,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC;IAC1D,IAAI,IAAI,KAAK,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC;GACpC;GACA,OAAO,OAAO,CAAC,IAAI,IAAI,CAAC;EACzB;CACD;AACD;;;;;;;AAQA,SAAgB,YAAY,SAAwB,QAAmB,MAA8C;CACpH,MAAM,SAAS,OAAO;CACtB,MAAM,SAAS,UAAU,SAAS,MAAM;CACxC,MAAM,aAAa,OAAO,WAAW,QAAS,OAAO,WAAW,eAAe,CAAC,OAAO;CACvF,MAAM,UAAU,OAAO,OAAO;CAC9B,IAAI,YAAY,KAAK,UAAU;EAAE,GAAG;EAAS,OAAO;GAAE,GAAG,QAAQ,OAAO,IAAI;GAAG,GAAG,QAAQ,OAAO,IAAI;EAAE;CAAE,IAAI,OAAO;CACpH,KAAK,MAAM,SAAS,QAAQ;EAC3B,IAAI,CAAC,MAAM,OAAO;EAClB,KAAK;GACJ,GAAG;GACH,QAAQ;GACR,GAAI,WAAW,EAAE,OAAO;IAAE,GAAG,MAAM,IAAI;IAAG,GAAG,MAAM,IAAI;GAAE,EAAE;GAC3D,GAAI,OAAO,UAAU,EAAE,QAAQ,MAAM;EACtC,CAAC;CACF;AACD"}

package/dist/query.d.ts

@@ -0,0 +1,56 @@
+import type { EntityKind, Layer, TargetOrder, UnitCondition } from './defs';
+import { type Entity, type PlayerId } from './entity';
+import type { Vec2 } from './math';
+import type { World } from './world';
+/**
+ * What a query of the world asks (`world.query`): each part it says must hold. What a `UnitCondition` says too (a buff,
+ * health under a share, a hero, tags, enemy or ally of `of`)
+ *
+ * @beta
+ */
+export interface WorldQuery extends UnitCondition {
+    /** Around this point or unit: within `radius` of it, and what `nearest` and `farthest` sort by */
+    near?: Vec2 | Entity;
+    /** How far from `near` (to the edge of each, as an effect's radius reaches). Anywhere when left out */
+    radius?: number;
+    /** Only what is inside this area (`defineArea`, a region of the map) */
+    area?: string;
+    /** Whose eyes `is` (enemy or ally) looks with: the owner of `near`, where that is a unit, when left out */
+    of?: PlayerId;
+    /** Only what these players own */
+    owner?: PlayerId | readonly PlayerId[];
+    /** Only these unit types, by id */
+    type?: string | readonly string[];
+    /** Only these kinds of things (unit, building, resource…). Everything when left out */
+    kinds?: readonly EntityKind[];
+    /** Only what is there: on the ground or in the air. Both when left out */
+    layers?: readonly Layer[];
+    /** Only what this player's team sees now (fog, invisibility) */
+    visibleTo?: PlayerId;
+    /** Not these: the caster, the one already hit */
+    except?: Entity | readonly Entity[];
+    /** The dead as well (`true`), or the dead alone (`'only'`). The living alone when left out */
+    dead?: boolean | 'only';
+    /** What is out of the world for now as well (a worker in a mine, a unit in a transport). Left out when left out */
+    hidden?: boolean;
+    /** Code that says yes or no of each, after the rest: anything the parts above do not say */
+    where?: (entity: Entity, world: World) => boolean;
+    /** The order to give them in (`TargetOrder`), or a comparison. In the order they came into the world when left out */
+    sort?: TargetOrder | ((a: Entity, b: Entity) => number);
+    /** At most this many, the first of the order */
+    limit?: number;
+}
+/**
+ * Sorts what was found in an order (`TargetOrder`), in place, and gives it: ties by who came into the world first, so
+ * the same on every machine. `nearest` and `farthest` need the point they measure from
+ *
+ * @beta
+ */
+export declare function sortTargets(world: World, found: Entity[], order: TargetOrder | ((a: Entity, b: Entity) => number), from?: Vec2): Entity[];
+/**
+ * What in the world is all a query asks (`WorldQuery`), in its order, as many as it says: a new list. Throws for a
+ * query that asks `is` with no player to ask it of, or sorts by distance with no `near`
+ *
+ * @beta
+ */
+export declare function queryWorld(world: World, query?: WorldQuery): Entity[];

package/dist/query.js

@@ -0,0 +1,88 @@
+import { distanceToEdge } from "./entity.js";
+import { unitMatches } from "./abilities/chance.js";
+import { layerOf } from "./abilities/buffs.js";
+//#region src/query.ts
+/**
+* Asking the world for what is in it by what it is (`world.query`): around a point or a unit, in an area, of whom, of
+* which type, kind and layer, what it carries and how hurt it is, what a player sees, or code; sorted and cut to a few.
+* What a game's code, an ability of its own and a trigger ask; an effect's `where` and `pick` ask the same of what it reaches
+*/
+/** Where a query or a pick measures from */
+var pointOf = (near) => "pos" in near ? near.pos : near;
+var isEntity = (near) => !!near && "pos" in near;
+var share = (entity) => entity.maxHealth > 0 ? entity.health / entity.maxHealth : 0;
+/**
+* Sorts what was found in an order (`TargetOrder`), in place, and gives it: ties by who came into the world first, so
+* the same on every machine. `nearest` and `farthest` need the point they measure from
+*
+* @beta
+*/
+function sortTargets(world, found, order, from) {
+	if (typeof order === "function") return found.sort((a, b) => order(a, b) || a.id - b.id);
+	if (order === "random") {
+		found.sort((a, b) => a.id - b.id);
+		for (let i = found.length - 1; i > 0; i--) {
+			const j = world.rng.int(0, i);
+			const swap = found[i];
+			found[i] = found[j];
+			found[j] = swap;
+		}
+		return found;
+	}
+	if (order === "nearest" || order === "farthest") {
+		if (!from) throw new Error(`Sorting by "${order}" needs a point to measure from (near)`);
+		const distance = new Map(found.map((entity) => [entity, distanceToEdge(from, entity)]));
+		const sign = order === "nearest" ? 1 : -1;
+		return found.sort((a, b) => sign * (distance.get(a) - distance.get(b)) || a.id - b.id);
+	}
+	const by = order === "lowestHealth" || order === "highestHealth" ? (entity) => entity.health : share;
+	const sign = order === "lowestHealth" || order === "lowestHealthShare" ? 1 : -1;
+	return found.sort((a, b) => sign * (by(a) - by(b)) || a.id - b.id);
+}
+/** What a query starts from: the fewest it can, the rest asked of each */
+function source(world, query, from) {
+	if (from && query.radius !== void 0) return [...world.spatial.query(from.x, from.z, query.radius)];
+	if (query.area !== void 0) return world.areas.inside(query.area);
+	if (typeof query.owner === "number") return world.index.ownedBy(query.owner);
+	return world.entities.values();
+}
+/**
+* What in the world is all a query asks (`WorldQuery`), in its order, as many as it says: a new list. Throws for a
+* query that asks `is` with no player to ask it of, or sorts by distance with no `near`
+*
+* @beta
+*/
+function queryWorld(world, query = {}) {
+	const from = query.near ? pointOf(query.near) : void 0;
+	const of = query.of ?? (isEntity(query.near) ? query.near.owner : void 0);
+	if (query.is !== void 0 && of === void 0) throw new Error(`A query that asks is: "${query.is}" needs a player to ask it of (of, or a unit as near)`);
+	const owners = query.owner === void 0 ? void 0 : typeof query.owner === "number" ? [query.owner] : query.owner;
+	const types = query.type === void 0 ? void 0 : typeof query.type === "string" ? [query.type] : query.type;
+	const except = query.except === void 0 ? void 0 : "pos" in query.except ? [query.except] : query.except;
+	const team = query.visibleTo !== void 0 ? world.player(query.visibleTo).team : void 0;
+	const radius = query.radius;
+	const found = [];
+	for (const entity of source(world, query, from)) {
+		if (query.dead === "only" ? entity.alive : !query.dead && !entity.alive) continue;
+		if (entity.hidden && !query.hidden) continue;
+		if (from && radius !== void 0 && distanceToEdge(from, entity) > radius) continue;
+		if (owners && !owners.includes(entity.owner)) continue;
+		if (types && !types.includes(entity.def.id)) continue;
+		if (query.kinds && !query.kinds.includes(entity.def.kind)) continue;
+		if (query.layers && !query.layers.includes(layerOf(world, entity))) continue;
+		if (query.area !== void 0 && from && radius !== void 0 && !world.areas.contains(query.area, entity)) continue;
+		if (except && except.includes(entity)) continue;
+		if (team !== void 0 && !world.isVisibleTo(entity, team)) continue;
+		if (!unitMatches(world, query, entity, of)) continue;
+		if (query.where && !query.where(entity, world)) continue;
+		found.push(entity);
+	}
+	if (query.sort !== void 0) sortTargets(world, found, query.sort, from);
+	else found.sort((a, b) => a.id - b.id);
+	if (query.limit !== void 0) found.length = Math.min(found.length, Math.max(0, Math.floor(query.limit)));
+	return found;
+}
+//#endregion
+export { queryWorld, sortTargets };
+
+//# sourceMappingURL=query.js.map

package/dist/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","names":[],"sources":["../src/query.ts"],"sourcesContent":["/**\n * Asking the world for what is in it by what it is (`world.query`): around a point or a unit, in an area, of whom, of\n * which type, kind and layer, what it carries and how hurt it is, what a player sees, or code; sorted and cut to a few.\n * What a game's code, an ability of its own and a trigger ask; an effect's `where` and `pick` ask the same of what it reaches\n */\nimport { unitMatches } from './abilities/chance'\nimport { layerOf } from './abilities/buffs'\nimport type { EntityKind, Layer, TargetOrder, UnitCondition } from './defs'\nimport { distanceToEdge, type Entity, type PlayerId } from './entity'\nimport type { Vec2 } from './math'\nimport type { World } from './world'\n\n/**\n * What a query of the world asks (`world.query`): each part it says must hold. What a `UnitCondition` says too (a buff,\n * health under a share, a hero, tags, enemy or ally of `of`)\n *\n * @beta\n */\nexport interface WorldQuery extends UnitCondition {\n\t/** Around this point or unit: within `radius` of it, and what `nearest` and `farthest` sort by */\n\tnear?: Vec2 | Entity\n\t/** How far from `near` (to the edge of each, as an effect's radius reaches). Anywhere when left out */\n\tradius?: number\n\t/** Only what is inside this area (`defineArea`, a region of the map) */\n\tarea?: string\n\t/** Whose eyes `is` (enemy or ally) looks with: the owner of `near`, where that is a unit, when left out */\n\tof?: PlayerId\n\t/** Only what these players own */\n\towner?: PlayerId | readonly PlayerId[]\n\t/** Only these unit types, by id */\n\ttype?: string | readonly string[]\n\t/** Only these kinds of things (unit, building, resource…). Everything when left out */\n\tkinds?: readonly EntityKind[]\n\t/** Only what is there: on the ground or in the air. Both when left out */\n\tlayers?: readonly Layer[]\n\t/** Only what this player's team sees now (fog, invisibility) */\n\tvisibleTo?: PlayerId\n\t/** Not these: the caster, the one already hit */\n\texcept?: Entity | readonly Entity[]\n\t/** The dead as well (`true`), or the dead alone (`'only'`). The living alone when left out */\n\tdead?: boolean | 'only'\n\t/** What is out of the world for now as well (a worker in a mine, a unit in a transport). Left out when left out */\n\thidden?: boolean\n\t/** Code that says yes or no of each, after the rest: anything the parts above do not say */\n\twhere?: (entity: Entity, world: World) => boolean\n\t/** The order to give them in (`TargetOrder`), or a comparison. In the order they came into the world when left out */\n\tsort?: TargetOrder | ((a: Entity, b: Entity) => number)\n\t/** At most this many, the first of the order */\n\tlimit?: number\n}\n\n/** Where a query or a pick measures from */\nconst pointOf = (near: Vec2 | Entity): Vec2 => ('pos' in near ? near.pos : near)\n\nconst isEntity = (near: Vec2 | Entity | undefined): near is Entity => !!near && 'pos' in near\n\nconst share = (entity: Entity): number => (entity.maxHealth > 0 ? entity.health / entity.maxHealth : 0)\n\n/**\n * Sorts what was found in an order (`TargetOrder`), in place, and gives it: ties by who came into the world first, so\n * the same on every machine. `nearest` and `farthest` need the point they measure from\n *\n * @beta\n */\nexport function sortTargets(world: World, found: Entity[], order: TargetOrder | ((a: Entity, b: Entity) => number), from?: Vec2): Entity[] {\n\tif (typeof order === 'function') return found.sort((a, b) => order(a, b) || a.id - b.id)\n\tif (order === 'random') {\n\t\tfound.sort((a, b) => a.id - b.id)\n\t\tfor (let i = found.length - 1; i > 0; i--) {\n\t\t\tconst j = world.rng.int(0, i)\n\t\t\tconst swap = found[i]\n\t\t\tfound[i] = found[j]\n\t\t\tfound[j] = swap\n\t\t}\n\t\treturn found\n\t}\n\tif (order === 'nearest' || order === 'farthest') {\n\t\tif (!from) throw new Error(`Sorting by \"${order}\" needs a point to measure from (near)`)\n\t\tconst distance = new Map(found.map((entity) => [entity, distanceToEdge(from, entity)]))\n\t\tconst sign = order === 'nearest' ? 1 : -1\n\t\treturn found.sort((a, b) => sign * (distance.get(a)! - distance.get(b)!) || a.id - b.id)\n\t}\n\tconst by: (entity: Entity) => number = order === 'lowestHealth' || order === 'highestHealth' ? (entity) => entity.health : share\n\tconst sign = order === 'lowestHealth' || order === 'lowestHealthShare' ? 1 : -1\n\treturn found.sort((a, b) => sign * (by(a) - by(b)) || a.id - b.id)\n}\n\n/** What a query starts from: the fewest it can, the rest asked of each */\nfunction source(world: World, query: WorldQuery, from: Vec2 | undefined): Iterable<Entity> {\n\t// a copy: code a query asks may itself ask what is near, which writes into the same list\n\tif (from && query.radius !== undefined) return [...world.spatial.query(from.x, from.z, query.radius)]\n\tif (query.area !== undefined) return world.areas.inside(query.area)\n\tif (typeof query.owner === 'number') return world.index.ownedBy(query.owner)\n\treturn world.entities.values()\n}\n\n/**\n * What in the world is all a query asks (`WorldQuery`), in its order, as many as it says: a new list. Throws for a\n * query that asks `is` with no player to ask it of, or sorts by distance with no `near`\n *\n * @beta\n */\nexport function queryWorld(world: World, query: WorldQuery = {}): Entity[] {\n\tconst from = query.near ? pointOf(query.near) : undefined\n\tconst of = query.of ?? (isEntity(query.near) ? query.near.owner : undefined)\n\tif (query.is !== undefined && of === undefined) throw new Error(`A query that asks is: \"${query.is}\" needs a player to ask it of (of, or a unit as near)`)\n\tconst owners = query.owner === undefined ? undefined : typeof query.owner === 'number' ? [query.owner] : query.owner\n\tconst types = query.type === undefined ? undefined : typeof query.type === 'string' ? [query.type] : query.type\n\tconst except = query.except === undefined ? undefined : 'pos' in query.except ? [query.except] : query.except\n\tconst team = query.visibleTo !== undefined ? world.player(query.visibleTo).team : undefined\n\tconst radius = query.radius\n\tconst found: Entity[] = []\n\tfor (const entity of source(world, query, from)) {\n\t\tif (query.dead === 'only' ? entity.alive : !query.dead && !entity.alive) continue\n\t\tif (entity.hidden && !query.hidden) continue\n\t\tif (from && radius !== undefined && distanceToEdge(from, entity) > radius) continue\n\t\tif (owners && !owners.includes(entity.owner)) continue\n\t\tif (types && !types.includes(entity.def.id)) continue\n\t\tif (query.kinds && !query.kinds.includes(entity.def.kind)) continue\n\t\tif (query.layers && !query.layers.includes(layerOf(world, entity))) continue\n\t\tif (query.area !== undefined && from && radius !== undefined && !world.areas.contains(query.area, entity)) continue\n\t\tif (except && except.includes(entity)) continue\n\t\tif (team !== undefined && !world.isVisibleTo(entity, team)) continue\n\t\tif (!unitMatches(world, query, entity, of)) continue\n\t\tif (query.where && !query.where(entity, world)) continue\n\t\tfound.push(entity)\n\t}\n\tif (query.sort !== undefined) sortTargets(world, found, query.sort, from)\n\telse found.sort((a, b) => a.id - b.id)\n\tif (query.limit !== undefined) found.length = Math.min(found.length, Math.max(0, Math.floor(query.limit)))\n\treturn found\n}\n"],"mappings":";;;;;;;;;;AAoDA,IAAM,WAAW,SAA+B,SAAS,OAAO,KAAK,MAAM;AAE3E,IAAM,YAAY,SAAoD,CAAC,CAAC,QAAQ,SAAS;AAEzF,IAAM,SAAS,WAA4B,OAAO,YAAY,IAAI,OAAO,SAAS,OAAO,YAAY;;;;;;;AAQrG,SAAgB,YAAY,OAAc,OAAiB,OAAyD,MAAuB;CAC1I,IAAI,OAAO,UAAU,YAAY,OAAO,MAAM,MAAM,GAAG,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;CACvF,IAAI,UAAU,UAAU;EACvB,MAAM,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE;EAChC,KAAK,IAAI,IAAI,MAAM,SAAS,GAAG,IAAI,GAAG,KAAK;GAC1C,MAAM,IAAI,MAAM,IAAI,IAAI,GAAG,CAAC;GAC5B,MAAM,OAAO,MAAM;GACnB,MAAM,KAAK,MAAM;GACjB,MAAM,KAAK;EACZ;EACA,OAAO;CACR;CACA,IAAI,UAAU,aAAa,UAAU,YAAY;EAChD,IAAI,CAAC,MAAM,MAAM,IAAI,MAAM,eAAe,MAAM,uCAAuC;EACvF,MAAM,WAAW,IAAI,IAAI,MAAM,KAAK,WAAW,CAAC,QAAQ,eAAe,MAAM,MAAM,CAAC,CAAC,CAAC;EACtF,MAAM,OAAO,UAAU,YAAY,IAAI;EACvC,OAAO,MAAM,MAAM,GAAG,MAAM,QAAQ,SAAS,IAAI,CAAC,IAAK,SAAS,IAAI,CAAC,MAAO,EAAE,KAAK,EAAE,EAAE;CACxF;CACA,MAAM,KAAiC,UAAU,kBAAkB,UAAU,mBAAmB,WAAW,OAAO,SAAS;CAC3H,MAAM,OAAO,UAAU,kBAAkB,UAAU,sBAAsB,IAAI;CAC7E,OAAO,MAAM,MAAM,GAAG,MAAM,QAAQ,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;AAClE;;AAGA,SAAS,OAAO,OAAc,OAAmB,MAA0C;CAE1F,IAAI,QAAQ,MAAM,WAAW,KAAA,GAAW,OAAO,CAAC,GAAG,MAAM,QAAQ,MAAM,KAAK,GAAG,KAAK,GAAG,MAAM,MAAM,CAAC;CACpG,IAAI,MAAM,SAAS,KAAA,GAAW,OAAO,MAAM,MAAM,OAAO,MAAM,IAAI;CAClE,IAAI,OAAO,MAAM,UAAU,UAAU,OAAO,MAAM,MAAM,QAAQ,MAAM,KAAK;CAC3E,OAAO,MAAM,SAAS,OAAO;AAC9B;;;;;;;AAQA,SAAgB,WAAW,OAAc,QAAoB,CAAC,GAAa;CAC1E,MAAM,OAAO,MAAM,OAAO,QAAQ,MAAM,IAAI,IAAI,KAAA;CAChD,MAAM,KAAK,MAAM,OAAO,SAAS,MAAM,IAAI,IAAI,MAAM,KAAK,QAAQ,KAAA;CAClE,IAAI,MAAM,OAAO,KAAA,KAAa,OAAO,KAAA,GAAW,MAAM,IAAI,MAAM,0BAA0B,MAAM,GAAG,sDAAsD;CACzJ,MAAM,SAAS,MAAM,UAAU,KAAA,IAAY,KAAA,IAAY,OAAO,MAAM,UAAU,WAAW,CAAC,MAAM,KAAK,IAAI,MAAM;CAC/G,MAAM,QAAQ,MAAM,SAAS,KAAA,IAAY,KAAA,IAAY,OAAO,MAAM,SAAS,WAAW,CAAC,MAAM,IAAI,IAAI,MAAM;CAC3G,MAAM,SAAS,MAAM,WAAW,KAAA,IAAY,KAAA,IAAY,SAAS,MAAM,SAAS,CAAC,MAAM,MAAM,IAAI,MAAM;CACvG,MAAM,OAAO,MAAM,cAAc,KAAA,IAAY,MAAM,OAAO,MAAM,SAAS,CAAC,CAAC,OAAO,KAAA;CAClF,MAAM,SAAS,MAAM;CACrB,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,UAAU,OAAO,OAAO,OAAO,IAAI,GAAG;EAChD,IAAI,MAAM,SAAS,SAAS,OAAO,QAAQ,CAAC,MAAM,QAAQ,CAAC,OAAO,OAAO;EACzE,IAAI,OAAO,UAAU,CAAC,MAAM,QAAQ;EACpC,IAAI,QAAQ,WAAW,KAAA,KAAa,eAAe,MAAM,MAAM,IAAI,QAAQ;EAC3E,IAAI,UAAU,CAAC,OAAO,SAAS,OAAO,KAAK,GAAG;EAC9C,IAAI,SAAS,CAAC,MAAM,SAAS,OAAO,IAAI,EAAE,GAAG;EAC7C,IAAI,MAAM,SAAS,CAAC,MAAM,MAAM,SAAS,OAAO,IAAI,IAAI,GAAG;EAC3D,IAAI,MAAM,UAAU,CAAC,MAAM,OAAO,SAAS,QAAQ,OAAO,MAAM,CAAC,GAAG;EACpE,IAAI,MAAM,SAAS,KAAA,KAAa,QAAQ,WAAW,KAAA,KAAa,CAAC,MAAM,MAAM,SAAS,MAAM,MAAM,MAAM,GAAG;EAC3G,IAAI,UAAU,OAAO,SAAS,MAAM,GAAG;EACvC,IAAI,SAAS,KAAA,KAAa,CAAC,MAAM,YAAY,QAAQ,IAAI,GAAG;EAC5D,IAAI,CAAC,YAAY,OAAO,OAAO,QAAQ,EAAE,GAAG;EAC5C,IAAI,MAAM,SAAS,CAAC,MAAM,MAAM,QAAQ,KAAK,GAAG;EAChD,MAAM,KAAK,MAAM;CAClB;CACA,IAAI,MAAM,SAAS,KAAA,GAAW,YAAY,OAAO,OAAO,MAAM,MAAM,IAAI;MACnE,MAAM,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE;CACrC,IAAI,MAAM,UAAU,KAAA,GAAW,MAAM,SAAS,KAAK,IAAI,MAAM,QAAQ,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,KAAK,CAAC,CAAC;CACzG,OAAO;AACR"}

package/dist/races.d.ts

@@ -1,21 +1,22 @@
-import type { ResourceKind } from './defs';
+import type { ResourceId } from './defs';
 import { type PlayerId } from './entity';
-import type { GameModule } from './game';
+import type { Rules } from './game';
 import type { HookDef } from './hooks';
 import type { Player } from './player';
 import type { Registry } from './registry';
-import { type StartDef } from './start';
+import { type StartingBase } from './start';
 import type { World } from './world';
 /**
  * A side a player can play, with a roster of its own: melee's humans and undead. Optional: a game that lists none
- * (`GameModule.races`) has no race anywhere, no choice of one in the lobby and nothing kept from anyone. A unit type or
+ * (`Rules.races`) has no race anywhere, no choice of one in the lobby and nothing kept from anyone. A unit type or
  * an upgrade of a race (`UnitTypeDef.race`, `UpgradeDef.race`) is only its players' to make; one of none, everyone's.
  * Each player has one (`raceOf`): chosen in the lobby (a seat setting the server offers by itself, `seatSettingsOf`),
  * given to the world as it is made (`PlayerInit.race`, `MapWorldOptions.races`), or changed by the rules (`setRace`)
  *
- * @beta
+ * @public
  */
 export interface RaceDef {
+    /** The race's id, shared by every game: referenced by `PlayerInit.race`, `UnitTypeDef.race` and `UpgradeDef.race` */
     id: string;
     /** What players are shown: in the lobby, on the scores */
     name: string;
@@ -32,13 +33,13 @@ export interface RaceDef {
      * What its players start with of each resource, by resource id, over what the game starts everyone with
      * (`ResourceDef.start`). Not for a player given resources of their own (`PlayerInit.resources`, a map's)
      */
-    resources?: Partial<Record<ResourceKind, number>>;
+    resources?: Partial<Record<ResourceId, number>>;
     /**
-     * What its players get at the start of a game on a map, in place of the game's (`GameModule.start`): its own hall and
-     * workers, as data (`StartData`: what a race made in the Data panel has, `start.hall` and the rest editable there)
-     * or as code (`StartCode`)
+     * What its players get at the start of a game on a map, in place of the game's (`Rules.startingBase`): its own hall and
+     * workers, as data (`StartingBaseData`: what a race made in the Data panel has, `start.hall` and the rest editable there)
+     * or as code (`StartingBaseCode`)
      */
-    start?: StartDef;
+    startingBase?: StartingBase;
     /**
      * Run for each of its players once a world is made from a map, after everything the map puts down and the starts:
      * what its players begin with that is not a unit (a ground of its own around its halls, a state)
@@ -76,11 +77,11 @@ export type RaceHookDef = HookDef & {
 /** The player a hook's event is of (see `RaceHookDef`): undefined for one of nobody's */
 export declare function playerOfEvent(event: unknown): PlayerId | undefined;
 /** Each race's hook handlers, each to run only for what is of the race's players */
-export declare function raceHooks(game: GameModule): HookDef[];
+export declare function raceHooks(game: Rules): HookDef[];
 /**
- * A race, as the game lists it (`GameModule.races`)
+ * A race, as the game lists it (`Rules.races`)
  *
- * @beta
+ * @public
  */
 export declare const defineRace: (def: RaceDef) => RaceDef;
 /**
@@ -125,7 +126,7 @@ export declare function settleRaces(players: Iterable<Player>, registry: Registr
  *
  * @beta
  */
-export declare function checkRaces(game: GameModule): void;
+export declare function checkRaces(game: Rules): void;
 /**
  * Gives each player of a world just made what their race starts them with (`RaceDef.resources`), but those given
  * resources of their own

package/dist/races.js

@@ -0,0 +1,172 @@
+import { startIds } from "./start.js";
+import { Entity } from "./entity.js";
+import { availableTo } from "./shared.js";
+import { nearestId } from "./nearest.js";
+//#region src/races.ts
+/** Fields of a hook's event that are an entity, in the order whose an event is looked for */
+var ACTORS = [
+	"entity",
+	"caster",
+	"attacker",
+	"worker",
+	"buyer",
+	"hero",
+	"producer",
+	"source",
+	"target"
+];
+/** The player a hook's event is of (see `RaceHookDef`): undefined for one of nobody's */
+function playerOfEvent(event) {
+	if (typeof event !== "object" || event === null) return void 0;
+	const fields = event;
+	if (typeof fields.player === "number") return fields.player;
+	for (const key of ACTORS) {
+		const actor = fields[key];
+		if (actor instanceof Entity) return actor.owner;
+	}
+}
+/** Each race's hook handlers, each to run only for what is of the race's players */
+function raceHooks(game) {
+	const hooks = [];
+	for (const race of game.races ?? []) {
+		if (race.inherits?.hooks === false) continue;
+		for (const { of, ...hook } of race.hooks ?? []) {
+			const whose = of ?? playerOfEvent;
+			hooks.push({
+				...hook,
+				run(world, event) {
+					const player = whose(event);
+					if (player !== void 0 && world.players.get(player)?.race === race.id) hook.run(world, event);
+				}
+			});
+		}
+	}
+	return hooks;
+}
+/**
+* A race, as the game lists it (`Rules.races`)
+*
+* @public
+*/
+var defineRace = (def) => def;
+/**
+* What is chosen for a seat or a player to have a race drawn for them as the game starts, from the world's own
+* numbers: the same on every machine
+*
+* @beta
+*/
+var RANDOM_RACE = "random";
+/**
+* The race a player plays: none in a game without races, and none for the neutral players and the creeps
+*
+* @beta
+*/
+var raceOf = (world, player) => world.players.get(player)?.race;
+/**
+* Makes a player play another race from now on: a campaign's mission, a game's own way of choosing. What they have
+* stays theirs; what they may make is the new race's. Throws for a race the game does not have, or for the neutral
+* players and the creeps
+*
+* @beta
+*/
+function setRace(world, player, race) {
+	const who = world.player(player);
+	if (who.neutral || who.creeps) throw new Error(`Player ${player} plays no race: the neutral players and the creeps have none`);
+	if (!world.registry.races.has(race)) throw new Error(`"${race}" is not a race of the game (${raceList(world.registry)})`);
+	who.race = race;
+}
+/**
+* Whether a player may make a unit type or research an upgrade at all, as their race goes (`UnitTypeDef.race`), and
+* then as the game's `available` hook says: what they may not is not on their buttons, and an order for it is
+* refused. What it requires is another question (`unlocked`), asked only of what is available
+*
+* @beta
+*/
+function isAvailable(world, player, kind, id) {
+	const { registry } = world;
+	if (kind === "unit" ? !registry.units.has(id) : !registry.upgrades.has(id)) return false;
+	const def = kind === "unit" ? registry.unit(id) : registry.upgrade(id);
+	const race = raceOf(world, player);
+	const available = availableTo(def, race);
+	if (!world.hooks.has("available")) return available;
+	return world.hooks.run("available", {
+		player,
+		kind,
+		id,
+		race,
+		available
+	}).available;
+}
+/**
+* The races players get as a world is made: what each was given, one drawn for those given `random`, and the game's
+* first for a player given none. Nobody's in a game without races. Throws for a race the game does not have
+*/
+function settleRaces(players, registry, draw, among) {
+	const races = registry.races.all();
+	const drawn = races.filter((race) => among?.includes(race.id));
+	const pool = drawn.length ? drawn : races;
+	for (const player of players) {
+		const given = player.race;
+		if (player.neutral || player.creeps || !races.length) {
+			if (given !== void 0 && given !== "random" && !registry.races.has(given)) throw new Error(`Player ${player.id} is given the race "${given}", and ${races.length ? "plays none" : "the game has no races"}`);
+			player.race = void 0;
+			continue;
+		}
+		if (given === "random") player.race = pool[draw(pool.length)].id;
+		else if (given === void 0) player.race = races[0].id;
+		else if (!registry.races.has(given)) throw new Error(`Player ${player.id} is given the race "${given}", which is not a race of the game (${raceList(registry)})`);
+	}
+}
+/**
+* Throws for races that cannot be: one there twice, one called `random`, a unit type or upgrade of a race the game does
+* not have, a resource a race starts with that the game has not, or a start as data (a race's, or the game's) that names
+* a unit type the game has not, saying which was meant where one is close. Run as a registry is made (`createRegistry`,
+* every world's); for a game's own tests
+*
+* @beta
+*/
+function checkRaces(game) {
+	const known = /* @__PURE__ */ new Set();
+	for (const race of game.races ?? []) {
+		if (race.id === "random") throw new Error(`A race cannot be called "${RANDOM_RACE}": it is what is chosen for one drawn as the game starts`);
+		if (known.has(race.id)) throw new Error(`The race "${race.id}" is there twice`);
+		known.add(race.id);
+	}
+	const check = (what, race) => {
+		if (race !== void 0 && !known.has(race)) throw new Error(`${what} is of the race "${race}", which ${known.size ? `is not a race of the game (${[...known].join(", ")})` : "the game does not have: it has no races"}`);
+	};
+	for (const unit of game.units) check(`Unit type "${unit.id}"`, unit.race);
+	for (const upgrade of game.upgrades ?? []) check(`Upgrade "${upgrade.id}"`, upgrade.race);
+	const resources = new Set((game.resources ?? []).map((resource) => resource.id));
+	for (const race of game.races ?? []) for (const kind in race.resources) if (!resources.has(kind)) throw new Error(`The race "${race.id}" starts with "${kind}", which is not a resource of the game`);
+	const units = new Set(game.units.map((unit) => unit.id));
+	const starts = [{
+		whose: "The game",
+		start: game.startingBase
+	}, ...(game.races ?? []).map((race) => ({
+		whose: `The race "${race.id}"`,
+		start: race.startingBase
+	}))];
+	for (const { whose, start } of starts) for (const { where, id } of startIds(start)) {
+		if (units.has(id)) continue;
+		const meant = nearestId(id, units);
+		throw new Error(`${whose} starts with "${id}" (${where}), which is no unit type of the game${meant ? `. Did you mean "${meant}"?` : ""}`);
+	}
+}
+/**
+* Gives each player of a world just made what their race starts them with (`RaceDef.resources`), but those given
+* resources of their own
+*/
+function raceResources(world, players) {
+	for (const init of players) {
+		const player = world.players.get(init.id);
+		if (!player?.race || init.resources) continue;
+		const own = world.registry.race(player.race).resources;
+		for (const kind in own) player.resources[kind] = own[kind];
+	}
+}
+var raceList = (registry) => registry.races.size ? registry.races.keys().join(", ") : "it has none";
+//#endregion
+export { RANDOM_RACE, checkRaces, defineRace, isAvailable, playerOfEvent, raceHooks, raceOf, raceResources, setRace, settleRaces };
+
+//# sourceMappingURL=races.js.map

package/dist/races.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"races.js","names":[],"sources":["../src/races.ts"],"sourcesContent":["import type { ResourceId, UnitTypeDef, UpgradeDef } from './defs'\nimport { Entity, type PlayerId } from './entity'\nimport type { Rules } from './game'\nimport type { HookDef } from './hooks'\nimport type { Player } from './player'\nimport type { Registry } from './registry'\nimport { nearestId } from './nearest'\nimport { availableTo } from './shared'\nimport { type StartingBase, startIds } from './start'\nimport type { World } from './world'\n\n/**\n * A side a player can play, with a roster of its own: melee's humans and undead. Optional: a game that lists none\n * (`Rules.races`) has no race anywhere, no choice of one in the lobby and nothing kept from anyone. A unit type or\n * an upgrade of a race (`UnitTypeDef.race`, `UpgradeDef.race`) is only its players' to make; one of none, everyone's.\n * Each player has one (`raceOf`): chosen in the lobby (a seat setting the server offers by itself, `seatSettingsOf`),\n * given to the world as it is made (`PlayerInit.race`, `MapWorldOptions.races`), or changed by the rules (`setRace`)\n *\n * @public\n */\nexport interface RaceDef {\n\t/** The race's id, shared by every game: referenced by `PlayerInit.race`, `UnitTypeDef.race` and `UpgradeDef.race` */\n\tid: string\n\t/** What players are shown: in the lobby, on the scores */\n\tname: string\n\t/**\n\t * The definition this one is a copy of, made from the data (`copyOf` in a `data.json`, the editor's Copy as new):\n\t * what it is drawn, heard and pictured as where the game gives it no look of its own\n\t */\n\tbasedOn?: string\n\t/** What it is like, for a tooltip */\n\tdescription?: string\n\t/** Its picture, by the id the game's view knows icons by */\n\ticon?: string\n\t/**\n\t * What its players start with of each resource, by resource id, over what the game starts everyone with\n\t * (`ResourceDef.start`). Not for a player given resources of their own (`PlayerInit.resources`, a map's)\n\t */\n\tresources?: Partial<Record<ResourceId, number>>\n\t/**\n\t * What its players get at the start of a game on a map, in place of the game's (`Rules.startingBase`): its own hall and\n\t * workers, as data (`StartingBaseData`: what a race made in the Data panel has, `start.hall` and the rest editable there)\n\t * or as code (`StartingBaseCode`)\n\t */\n\tstartingBase?: StartingBase\n\t/**\n\t * Run for each of its players once a world is made from a map, after everything the map puts down and the starts:\n\t * what its players begin with that is not a unit (a ground of its own around its halls, a state)\n\t */\n\tonStart?(world: World, player: PlayerId): void\n\t/**\n\t * Hook handlers of its own, run only for what is of its players (`RaceHookDef`): how it gathers, where it may build.\n\t * With these a race plays differently with no test of the race in the game's code\n\t */\n\thooks?: RaceHookDef[]\n\t/**\n\t * What a race made as a copy of another (`basedOn`: `copyOf` in a `data.json`, the editor's Copy as new) keeps of the\n\t * original's code: its `hooks` and its `onStart`, each kept unless said `false` here. A copy keeps both when this is\n\t * left out, so a race copied from the undead gathers at a cursed mine and builds on blight as they do; one that\n\t * says `hooks: false` plays by the game's rules alone. Its `start` is data, the copy's own to change; a `start` in\n\t * code is kept whole. Two toggles in the Data panel, on a copy\n\t */\n\tinherits?: { hooks?: boolean; onStart?: boolean }\n}\n\n/**\n * A hook handler of a race (`RaceDef.hooks`): run only where the event is of one of the race's players. Whose an event\n * is, is `of(event)` where it is given, or else its `player`, or else the owner of the first there is of its `entity`,\n * `caster`, `attacker`, `worker`, `buyer`, `hero`, `producer`, `source`, `target`: the one doing it before the one it\n * is done to (a damage is its source's)\n *\n * @beta\n */\nexport type RaceHookDef = HookDef & {\n\t/** The player an event is of, where it is not the one found by default */\n\tof?: (event: any) => PlayerId | undefined\n}\n\n/** Fields of a hook's event that are an entity, in the order whose an event is looked for */\nconst ACTORS = ['entity', 'caster', 'attacker', 'worker', 'buyer', 'hero', 'producer', 'source', 'target'] as const\n\n/** The player a hook's event is of (see `RaceHookDef`): undefined for one of nobody's */\nexport function playerOfEvent(event: unknown): PlayerId | undefined {\n\tif (typeof event !== 'object' || event === null) return undefined\n\tconst fields = event as Record<string, unknown>\n\tif (typeof fields.player === 'number') return fields.player\n\tfor (const key of ACTORS) {\n\t\tconst actor = fields[key]\n\t\tif (actor instanceof Entity) return actor.owner\n\t}\n\treturn undefined\n}\n\n/** Each race's hook handlers, each to run only for what is of the race's players */\nexport function raceHooks(game: Rules): HookDef[] {\n\tconst hooks: HookDef[] = []\n\tfor (const race of game.races ?? []) {\n\t\t// a copy that says it keeps none of the original's hooks\n\t\tif (race.inherits?.hooks === false) continue\n\t\tfor (const { of, ...hook } of race.hooks ?? []) {\n\t\t\tconst whose = of ?? playerOfEvent\n\t\t\thooks.push({\n\t\t\t\t...hook,\n\t\t\t\trun(world, event) {\n\t\t\t\t\tconst player = whose(event)\n\t\t\t\t\tif (player !== undefined && world.players.get(player)?.race === race.id) hook.run(world, event)\n\t\t\t\t}\n\t\t\t})\n\t\t}\n\t}\n\treturn hooks\n}\n\n/**\n * A race, as the game lists it (`Rules.races`)\n *\n * @public\n */\nexport const defineRace = (def: RaceDef): RaceDef => def\n\n/**\n * What is chosen for a seat or a player to have a race drawn for them as the game starts, from the world's own\n * numbers: the same on every machine\n *\n * @beta\n */\nexport const RANDOM_RACE = 'random'\n\n/**\n * The race a player plays: none in a game without races, and none for the neutral players and the creeps\n *\n * @beta\n */\nexport const raceOf = (world: World, player: PlayerId): string | undefined => world.players.get(player)?.race\n\n/**\n * Makes a player play another race from now on: a campaign's mission, a game's own way of choosing. What they have\n * stays theirs; what they may make is the new race's. Throws for a race the game does not have, or for the neutral\n * players and the creeps\n *\n * @beta\n */\nexport function setRace(world: World, player: PlayerId, race: string): void {\n\tconst who = world.player(player)\n\tif (who.neutral || who.creeps) throw new Error(`Player ${player} plays no race: the neutral players and the creeps have none`)\n\tif (!world.registry.races.has(race)) throw new Error(`\"${race}\" is not a race of the game (${raceList(world.registry)})`)\n\twho.race = race\n}\n\n/**\n * Whether a player may make a unit type or research an upgrade at all, as their race goes (`UnitTypeDef.race`), and\n * then as the game's `available` hook says: what they may not is not on their buttons, and an order for it is\n * refused. What it requires is another question (`unlocked`), asked only of what is available\n *\n * @beta\n */\nexport function isAvailable(world: World, player: PlayerId, kind: 'unit' | 'upgrade', id: string): boolean {\n\tconst { registry } = world\n\tif (kind === 'unit' ? !registry.units.has(id) : !registry.upgrades.has(id)) return false\n\tconst def: UnitTypeDef | UpgradeDef = kind === 'unit' ? registry.unit(id) : registry.upgrade(id)\n\tconst race = raceOf(world, player)\n\tconst available = availableTo(def, race)\n\tif (!world.hooks.has('available')) return available\n\treturn world.hooks.run('available', { player, kind, id, race, available }).available\n}\n\n/**\n * The races players get as a world is made: what each was given, one drawn for those given `random`, and the game's\n * first for a player given none. Nobody's in a game without races. Throws for a race the game does not have\n */\nexport function settleRaces(players: Iterable<Player>, registry: Registry, draw: (count: number) => number, among?: readonly string[]): void {\n\tconst races = registry.races.all()\n\t// what random draws from: those of the game named, all where none are\n\tconst drawn = races.filter((race) => among?.includes(race.id))\n\tconst pool = drawn.length ? drawn : races\n\tfor (const player of players) {\n\t\tconst given = player.race\n\t\tif (player.neutral || player.creeps || !races.length) {\n\t\t\tif (given !== undefined && given !== RANDOM_RACE && !registry.races.has(given))\n\t\t\t\tthrow new Error(`Player ${player.id} is given the race \"${given}\", and ${races.length ? 'plays none' : 'the game has no races'}`)\n\t\t\tplayer.race = undefined\n\t\t\tcontinue\n\t\t}\n\t\tif (given === RANDOM_RACE) player.race = pool[draw(pool.length)].id\n\t\telse if (given === undefined) player.race = races[0].id\n\t\telse if (!registry.races.has(given))\n\t\t\tthrow new Error(`Player ${player.id} is given the race \"${given}\", which is not a race of the game (${raceList(registry)})`)\n\t}\n}\n\n/**\n * Throws for races that cannot be: one there twice, one called `random`, a unit type or upgrade of a race the game does\n * not have, a resource a race starts with that the game has not, or a start as data (a race's, or the game's) that names\n * a unit type the game has not, saying which was meant where one is close. Run as a registry is made (`createRegistry`,\n * every world's); for a game's own tests\n *\n * @beta\n */\nexport function checkRaces(game: Rules): void {\n\tconst known = new Set<string>()\n\tfor (const race of game.races ?? []) {\n\t\tif (race.id === RANDOM_RACE) throw new Error(`A race cannot be called \"${RANDOM_RACE}\": it is what is chosen for one drawn as the game starts`)\n\t\tif (known.has(race.id)) throw new Error(`The race \"${race.id}\" is there twice`)\n\t\tknown.add(race.id)\n\t}\n\tconst check = (what: string, race: string | undefined) => {\n\t\tif (race !== undefined && !known.has(race))\n\t\t\tthrow new Error(\n\t\t\t\t`${what} is of the race \"${race}\", which ${known.size ? `is not a race of the game (${[...known].join(', ')})` : 'the game does not have: it has no races'}`\n\t\t\t)\n\t}\n\tfor (const unit of game.units) check(`Unit type \"${unit.id}\"`, unit.race)\n\tfor (const upgrade of game.upgrades ?? []) check(`Upgrade \"${upgrade.id}\"`, upgrade.race)\n\tconst resources = new Set((game.resources ?? []).map((resource) => resource.id))\n\tfor (const race of game.races ?? []) {\n\t\tfor (const kind in race.resources)\n\t\t\tif (!resources.has(kind)) throw new Error(`The race \"${race.id}\" starts with \"${kind}\", which is not a resource of the game`)\n\t}\n\t// a start as data names unit types the game has to have\n\tconst units = new Set(game.units.map((unit) => unit.id))\n\tconst starts = [\n\t\t{ whose: 'The game', start: game.startingBase },\n\t\t...(game.races ?? []).map((race) => ({ whose: `The race \"${race.id}\"`, start: race.startingBase }))\n\t]\n\tfor (const { whose, start } of starts) {\n\t\tfor (const { where, id } of startIds(start)) {\n\t\t\tif (units.has(id)) continue\n\t\t\tconst meant = nearestId(id, units)\n\t\t\tthrow new Error(`${whose} starts with \"${id}\" (${where}), which is no unit type of the game${meant ? `. Did you mean \"${meant}\"?` : ''}`)\n\t\t}\n\t}\n}\n\n/**\n * Gives each player of a world just made what their race starts them with (`RaceDef.resources`), but those given\n * resources of their own\n */\nexport function raceResources(world: World, players: readonly { id: PlayerId; resources?: unknown }[]): void {\n\tfor (const init of players) {\n\t\tconst player = world.players.get(init.id)\n\t\tif (!player?.race || init.resources) continue\n\t\tconst own = world.registry.race(player.race).resources\n\t\tfor (const kind in own) player.resources[kind] = own[kind]!\n\t}\n}\n\nconst raceList = (registry: Registry): string => (registry.races.size ? registry.races.keys().join(', ') : 'it has none')\n"],"mappings":";;;;;;AA+EA,IAAM,SAAS;CAAC;CAAU;CAAU;CAAY;CAAU;CAAS;CAAQ;CAAY;CAAU;AAAQ;;AAGzG,SAAgB,cAAc,OAAsC;CACnE,IAAI,OAAO,UAAU,YAAY,UAAU,MAAM,OAAO,KAAA;CACxD,MAAM,SAAS;CACf,IAAI,OAAO,OAAO,WAAW,UAAU,OAAO,OAAO;CACrD,KAAK,MAAM,OAAO,QAAQ;EACzB,MAAM,QAAQ,OAAO;EACrB,IAAI,iBAAiB,QAAQ,OAAO,MAAM;CAC3C;AAED;;AAGA,SAAgB,UAAU,MAAwB;CACjD,MAAM,QAAmB,CAAC;CAC1B,KAAK,MAAM,QAAQ,KAAK,SAAS,CAAC,GAAG;EAEpC,IAAI,KAAK,UAAU,UAAU,OAAO;EACpC,KAAK,MAAM,EAAE,IAAI,GAAG,UAAU,KAAK,SAAS,CAAC,GAAG;GAC/C,MAAM,QAAQ,MAAM;GACpB,MAAM,KAAK;IACV,GAAG;IACH,IAAI,OAAO,OAAO;KACjB,MAAM,SAAS,MAAM,KAAK;KAC1B,IAAI,WAAW,KAAA,KAAa,MAAM,QAAQ,IAAI,MAAM,CAAC,EAAE,SAAS,KAAK,IAAI,KAAK,IAAI,OAAO,KAAK;IAC/F;GACD,CAAC;EACF;CACD;CACA,OAAO;AACR;;;;;;AAOA,IAAa,cAAc,QAA0B;;;;;;;AAQrD,IAAa,cAAc;;;;;;AAO3B,IAAa,UAAU,OAAc,WAAyC,MAAM,QAAQ,IAAI,MAAM,CAAC,EAAE;;;;;;;;AASzG,SAAgB,QAAQ,OAAc,QAAkB,MAAoB;CAC3E,MAAM,MAAM,MAAM,OAAO,MAAM;CAC/B,IAAI,IAAI,WAAW,IAAI,QAAQ,MAAM,IAAI,MAAM,UAAU,OAAO,6DAA6D;CAC7H,IAAI,CAAC,MAAM,SAAS,MAAM,IAAI,IAAI,GAAG,MAAM,IAAI,MAAM,IAAI,KAAK,+BAA+B,SAAS,MAAM,QAAQ,EAAE,EAAE;CACxH,IAAI,OAAO;AACZ;;;;;;;;AASA,SAAgB,YAAY,OAAc,QAAkB,MAA0B,IAAqB;CAC1G,MAAM,EAAE,aAAa;CACrB,IAAI,SAAS,SAAS,CAAC,SAAS,MAAM,IAAI,EAAE,IAAI,CAAC,SAAS,SAAS,IAAI,EAAE,GAAG,OAAO;CACnF,MAAM,MAAgC,SAAS,SAAS,SAAS,KAAK,EAAE,IAAI,SAAS,QAAQ,EAAE;CAC/F,MAAM,OAAO,OAAO,OAAO,MAAM;CACjC,MAAM,YAAY,YAAY,KAAK,IAAI;CACvC,IAAI,CAAC,MAAM,MAAM,IAAI,WAAW,GAAG,OAAO;CAC1C,OAAO,MAAM,MAAM,IAAI,aAAa;EAAE;EAAQ;EAAM;EAAI;EAAM;CAAU,CAAC,CAAC,CAAC;AAC5E;;;;;AAMA,SAAgB,YAAY,SAA2B,UAAoB,MAAiC,OAAiC;CAC5I,MAAM,QAAQ,SAAS,MAAM,IAAI;CAEjC,MAAM,QAAQ,MAAM,QAAQ,SAAS,OAAO,SAAS,KAAK,EAAE,CAAC;CAC7D,MAAM,OAAO,MAAM,SAAS,QAAQ;CACpC,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,QAAQ,OAAO;EACrB,IAAI,OAAO,WAAW,OAAO,UAAU,CAAC,MAAM,QAAQ;GACrD,IAAI,UAAU,KAAA,KAAa,UAAA,YAAyB,CAAC,SAAS,MAAM,IAAI,KAAK,GAC5E,MAAM,IAAI,MAAM,UAAU,OAAO,GAAG,sBAAsB,MAAM,SAAS,MAAM,SAAS,eAAe,yBAAyB;GACjI,OAAO,OAAO,KAAA;GACd;EACD;EACA,IAAI,UAAA,UAAuB,OAAO,OAAO,KAAK,KAAK,KAAK,MAAM,EAAE,CAAC;OAC5D,IAAI,UAAU,KAAA,GAAW,OAAO,OAAO,MAAM,EAAE,CAAC;OAChD,IAAI,CAAC,SAAS,MAAM,IAAI,KAAK,GACjC,MAAM,IAAI,MAAM,UAAU,OAAO,GAAG,sBAAsB,MAAM,sCAAsC,SAAS,QAAQ,EAAE,EAAE;CAC7H;AACD;;;;;;;;;AAUA,SAAgB,WAAW,MAAmB;CAC7C,MAAM,wBAAQ,IAAI,IAAY;CAC9B,KAAK,MAAM,QAAQ,KAAK,SAAS,CAAC,GAAG;EACpC,IAAI,KAAK,OAAA,UAAoB,MAAM,IAAI,MAAM,4BAA4B,YAAY,yDAAyD;EAC9I,IAAI,MAAM,IAAI,KAAK,EAAE,GAAG,MAAM,IAAI,MAAM,aAAa,KAAK,GAAG,iBAAiB;EAC9E,MAAM,IAAI,KAAK,EAAE;CAClB;CACA,MAAM,SAAS,MAAc,SAA6B;EACzD,IAAI,SAAS,KAAA,KAAa,CAAC,MAAM,IAAI,IAAI,GACxC,MAAM,IAAI,MACT,GAAG,KAAK,mBAAmB,KAAK,WAAW,MAAM,OAAO,8BAA8B,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,KAAK,2CAClH;CACF;CACA,KAAK,MAAM,QAAQ,KAAK,OAAO,MAAM,cAAc,KAAK,GAAG,IAAI,KAAK,IAAI;CACxE,KAAK,MAAM,WAAW,KAAK,YAAY,CAAC,GAAG,MAAM,YAAY,QAAQ,GAAG,IAAI,QAAQ,IAAI;CACxF,MAAM,YAAY,IAAI,KAAK,KAAK,aAAa,CAAC,EAAA,CAAG,KAAK,aAAa,SAAS,EAAE,CAAC;CAC/E,KAAK,MAAM,QAAQ,KAAK,SAAS,CAAC,GACjC,KAAK,MAAM,QAAQ,KAAK,WACvB,IAAI,CAAC,UAAU,IAAI,IAAI,GAAG,MAAM,IAAI,MAAM,aAAa,KAAK,GAAG,iBAAiB,KAAK,uCAAuC;CAG9H,MAAM,QAAQ,IAAI,IAAI,KAAK,MAAM,KAAK,SAAS,KAAK,EAAE,CAAC;CACvD,MAAM,SAAS,CACd;EAAE,OAAO;EAAY,OAAO,KAAK;CAAa,GAC9C,IAAI,KAAK,SAAS,CAAC,EAAA,CAAG,KAAK,UAAU;EAAE,OAAO,aAAa,KAAK,GAAG;EAAI,OAAO,KAAK;CAAa,EAAE,CACnG;CACA,KAAK,MAAM,EAAE,OAAO,WAAW,QAC9B,KAAK,MAAM,EAAE,OAAO,QAAQ,SAAS,KAAK,GAAG;EAC5C,IAAI,MAAM,IAAI,EAAE,GAAG;EACnB,MAAM,QAAQ,UAAU,IAAI,KAAK;EACjC,MAAM,IAAI,MAAM,GAAG,MAAM,gBAAgB,GAAG,KAAK,MAAM,sCAAsC,QAAQ,mBAAmB,MAAM,MAAM,IAAI;CACzI;AAEF;;;;;AAMA,SAAgB,cAAc,OAAc,SAAiE;CAC5G,KAAK,MAAM,QAAQ,SAAS;EAC3B,MAAM,SAAS,MAAM,QAAQ,IAAI,KAAK,EAAE;EACxC,IAAI,CAAC,QAAQ,QAAQ,KAAK,WAAW;EACrC,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC;EAC7C,KAAK,MAAM,QAAQ,KAAK,OAAO,UAAU,QAAQ,IAAI;CACtD;AACD;AAEA,IAAM,YAAY,aAAgC,SAAS,MAAM,OAAO,SAAS,MAAM,KAAK,CAAC,CAAC,KAAK,IAAI,IAAI"}

package/dist/randomGroups.js

@@ -0,0 +1,91 @@
+import { defineComponent } from "./components.js";
+import { defineListener } from "./events.js";
+import { entityDied } from "./engineEvents.js";
+import { createItem, dropOnGround } from "./items.js";
+//#region src/randomGroups.ts
+/** One of a list by weight, or nothing for an empty list */
+function byWeight(list, rng) {
+	const total = list.reduce((sum, entry) => sum + Math.max(entry.weight, 0), 0);
+	if (total <= 0) return void 0;
+	let at = rng.next() * total;
+	for (const entry of list) {
+		at -= Math.max(entry.weight, 0);
+		if (at < 0) return entry;
+	}
+	return list[list.length - 1];
+}
+/**
+* The unit types a random group can be drawn from, as the game has them
+*
+* @internal
+*/
+function groupChoices(group, registry) {
+	if (group.choices?.length) return group.choices.filter((choice) => registry.units.has(choice.type) && choice.weight > 0);
+	if (group.level === void 0) return [];
+	return registry.units.all().filter((def) => def.kind === "unit" && def.bounty && (def.level ?? 1) === group.level).map((def) => ({
+		type: def.id,
+		weight: 1
+	}));
+}
+/**
+* A unit type drawn from a random group, as the game starts: nothing when it has none to draw from
+*
+* @internal
+*/
+var drawFromGroup = (group, registry, rng) => byWeight(groupChoices(group, registry), rng)?.type;
+/**
+* An item drawn from a table as something dies: nothing when it drops nothing this time
+*
+* @internal
+*/
+function drawFromTable(table, registry, rng) {
+	if (table.chance !== void 0 && rng.next() >= table.chance) return void 0;
+	return byWeight(tableItems(table, registry), rng)?.item;
+}
+/**
+* The items a table draws from, each with its weight: an item by id as it is, a line of a level or a class its
+* weight shared among the game's items that match (in the game's order: the same draw from the same seed)
+*
+* @internal
+*/
+function tableItems(table, registry) {
+	const out = [];
+	for (const entry of table.items) {
+		if (entry.item !== void 0) {
+			if (registry.items.has(entry.item)) out.push({
+				item: entry.item,
+				weight: entry.weight
+			});
+			continue;
+		}
+		if (entry.level === void 0 && entry.class === void 0) continue;
+		const matching = registry.items.all().filter((def) => (entry.level === void 0 || (def.level ?? 1) === entry.level) && (entry.class === void 0 || def.class === entry.class));
+		for (const def of matching) out.push({
+			item: def.id,
+			weight: entry.weight / matching.length
+		});
+	}
+	return out;
+}
+/**
+* The item table a thing placed on a map drops from when it dies (`MapObject.drops`), by name
+*
+* @internal
+*/
+var mapDrops = defineComponent({ id: "core.mapDrops" });
+/** What a thing placed on a map drops when it dies: one item from its table, on the ground where it fell */
+var dropFromTable = defineListener({
+	id: "core.dropFromTable",
+	event: entityDied,
+	run(world, { entity }) {
+		const name = entity.get(mapDrops);
+		if (!name) return;
+		const table = world.map.itemTable(name);
+		const item = table && drawFromTable(table, world.registry, world.rng);
+		if (item) dropOnGround(world, createItem(world, item), entity.pos);
+	}
+});
+//#endregion
+export { drawFromGroup, drawFromTable, dropFromTable, groupChoices, mapDrops, tableItems };
+
+//# sourceMappingURL=randomGroups.js.map

package/dist/randomGroups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"randomGroups.js","names":[],"sources":["../src/randomGroups.ts"],"sourcesContent":["import { entityDied } from '#engine/engineEvents'\nimport { defineComponent } from './components'\nimport { defineListener } from './events'\nimport { createItem, dropOnGround } from './items'\nimport type { MapItemTable, MapRandomGroup } from './map'\nimport type { Registry } from './registry'\nimport type { Rng } from './rng'\n\n/** One of a list by weight, or nothing for an empty list */\nfunction byWeight<T extends { weight: number }>(list: readonly T[], rng: Rng): T | undefined {\n\tconst total = list.reduce((sum, entry) => sum + Math.max(entry.weight, 0), 0)\n\tif (total <= 0) return undefined\n\tlet at = rng.next() * total\n\tfor (const entry of list) {\n\t\tat -= Math.max(entry.weight, 0)\n\t\tif (at < 0) return entry\n\t}\n\treturn list[list.length - 1]\n}\n\n/**\n * The unit types a random group can be drawn from, as the game has them\n *\n * @internal\n */\nexport function groupChoices(group: MapRandomGroup, registry: Registry): { type: string; weight: number }[] {\n\tif (group.choices?.length) return group.choices.filter((choice) => registry.units.has(choice.type) && choice.weight > 0)\n\tif (group.level === undefined) return []\n\t// any creep of the level: a unit type with a bounty\n\treturn registry.units\n\t\t.all()\n\t\t.filter((def) => def.kind === 'unit' && def.bounty && (def.level ?? 1) === group.level)\n\t\t.map((def) => ({ type: def.id, weight: 1 }))\n}\n\n/**\n * A unit type drawn from a random group, as the game starts: nothing when it has none to draw from\n *\n * @internal\n */\nexport const drawFromGroup = (group: MapRandomGroup, registry: Registry, rng: Rng): string | undefined =>\n\tbyWeight(groupChoices(group, registry), rng)?.type\n\n/**\n * An item drawn from a table as something dies: nothing when it drops nothing this time\n *\n * @internal\n */\nexport function drawFromTable(table: MapItemTable, registry: Registry, rng: Rng): string | undefined {\n\tif (table.chance !== undefined && rng.next() >= table.chance) return undefined\n\treturn byWeight(tableItems(table, registry), rng)?.item\n}\n\n/**\n * The items a table draws from, each with its weight: an item by id as it is, a line of a level or a class its\n * weight shared among the game's items that match (in the game's order: the same draw from the same seed)\n *\n * @internal\n */\nexport function tableItems(table: MapItemTable, registry: Registry): { item: string; weight: number }[] {\n\tconst out: { item: string; weight: number }[] = []\n\tfor (const entry of table.items) {\n\t\tif (entry.item !== undefined) {\n\t\t\tif (registry.items.has(entry.item)) out.push({ item: entry.item, weight: entry.weight })\n\t\t\tcontinue\n\t\t}\n\t\tif (entry.level === undefined && entry.class === undefined) continue\n\t\tconst matching = registry.items\n\t\t\t.all()\n\t\t\t.filter((def) => (entry.level === undefined || (def.level ?? 1) === entry.level) && (entry.class === undefined || def.class === entry.class))\n\t\tfor (const def of matching) out.push({ item: def.id, weight: entry.weight / matching.length })\n\t}\n\treturn out\n}\n\n/**\n * The item table a thing placed on a map drops from when it dies (`MapObject.drops`), by name\n *\n * @internal\n */\nexport const mapDrops = defineComponent<string>({ id: 'core.mapDrops' })\n\n/** What a thing placed on a map drops when it dies: one item from its table, on the ground where it fell */\nexport const dropFromTable = defineListener({\n\tid: 'core.dropFromTable',\n\tevent: entityDied,\n\trun(world, { entity }) {\n\t\tconst name = entity.get(mapDrops)\n\t\tif (!name) return\n\t\tconst table = world.map.itemTable(name)\n\t\tconst item = table && drawFromTable(table, world.registry, world.rng)\n\t\tif (item) dropOnGround(world, createItem(world, item), entity.pos)\n\t}\n})\n"],"mappings":";;;;;;AASA,SAAS,SAAuC,MAAoB,KAAyB;CAC5F,MAAM,QAAQ,KAAK,QAAQ,KAAK,UAAU,MAAM,KAAK,IAAI,MAAM,QAAQ,CAAC,GAAG,CAAC;CAC5E,IAAI,SAAS,GAAG,OAAO,KAAA;CACvB,IAAI,KAAK,IAAI,KAAK,IAAI;CACtB,KAAK,MAAM,SAAS,MAAM;EACzB,MAAM,KAAK,IAAI,MAAM,QAAQ,CAAC;EAC9B,IAAI,KAAK,GAAG,OAAO;CACpB;CACA,OAAO,KAAK,KAAK,SAAS;AAC3B;;;;;;AAOA,SAAgB,aAAa,OAAuB,UAAwD;CAC3G,IAAI,MAAM,SAAS,QAAQ,OAAO,MAAM,QAAQ,QAAQ,WAAW,SAAS,MAAM,IAAI,OAAO,IAAI,KAAK,OAAO,SAAS,CAAC;CACvH,IAAI,MAAM,UAAU,KAAA,GAAW,OAAO,CAAC;CAEvC,OAAO,SAAS,MACd,IAAI,CAAC,CACL,QAAQ,QAAQ,IAAI,SAAS,UAAU,IAAI,WAAW,IAAI,SAAS,OAAO,MAAM,KAAK,CAAC,CACtF,KAAK,SAAS;EAAE,MAAM,IAAI;EAAI,QAAQ;CAAE,EAAE;AAC7C;;;;;;AAOA,IAAa,iBAAiB,OAAuB,UAAoB,QACxE,SAAS,aAAa,OAAO,QAAQ,GAAG,GAAG,CAAC,EAAE;;;;;;AAO/C,SAAgB,cAAc,OAAqB,UAAoB,KAA8B;CACpG,IAAI,MAAM,WAAW,KAAA,KAAa,IAAI,KAAK,KAAK,MAAM,QAAQ,OAAO,KAAA;CACrE,OAAO,SAAS,WAAW,OAAO,QAAQ,GAAG,GAAG,CAAC,EAAE;AACpD;;;;;;;AAQA,SAAgB,WAAW,OAAqB,UAAwD;CACvG,MAAM,MAA0C,CAAC;CACjD,KAAK,MAAM,SAAS,MAAM,OAAO;EAChC,IAAI,MAAM,SAAS,KAAA,GAAW;GAC7B,IAAI,SAAS,MAAM,IAAI,MAAM,IAAI,GAAG,IAAI,KAAK;IAAE,MAAM,MAAM;IAAM,QAAQ,MAAM;GAAO,CAAC;GACvF;EACD;EACA,IAAI,MAAM,UAAU,KAAA,KAAa,MAAM,UAAU,KAAA,GAAW;EAC5D,MAAM,WAAW,SAAS,MACxB,IAAI,CAAC,CACL,QAAQ,SAAS,MAAM,UAAU,KAAA,MAAc,IAAI,SAAS,OAAO,MAAM,WAAW,MAAM,UAAU,KAAA,KAAa,IAAI,UAAU,MAAM,MAAM;EAC7I,KAAK,MAAM,OAAO,UAAU,IAAI,KAAK;GAAE,MAAM,IAAI;GAAI,QAAQ,MAAM,SAAS,SAAS;EAAO,CAAC;CAC9F;CACA,OAAO;AACR;;;;;;AAOA,IAAa,WAAW,gBAAwB,EAAE,IAAI,gBAAgB,CAAC;;AAGvE,IAAa,gBAAgB,eAAe;CAC3C,IAAI;CACJ,OAAO;CACP,IAAI,OAAO,EAAE,UAAU;EACtB,MAAM,OAAO,OAAO,IAAI,QAAQ;EAChC,IAAI,CAAC,MAAM;EACX,MAAM,QAAQ,MAAM,IAAI,UAAU,IAAI;EACtC,MAAM,OAAO,SAAS,cAAc,OAAO,MAAM,UAAU,MAAM,GAAG;EACpE,IAAI,MAAM,aAAa,OAAO,WAAW,OAAO,IAAI,GAAG,OAAO,GAAG;CAClE;AACD,CAAC"}