@v12-engine/engine 0.1.1 → 0.4.0

package/dist/exactMath.js

@@ -0,0 +1,273 @@
+//#region src/exactMath.ts
+/**
+* The maths the simulation does, the same to the last bit in every engine (determinism D3). JavaScript says exactly
+* what `+`, `-`, `*`, `/` and `Math.sqrt` give, but not `Math.sin`, `Math.cos`, `Math.atan`, `Math.atan2` or
+* `Math.hypot`: V8, SpiderMonkey and JavaScriptCore each have their own, and two versions of one can differ (Node 22's
+* `atan2` and Chromium's do, in the last bit). These are fdlibm's (FreeBSD's msun), written with what is exact
+* everywhere, so a world run in a page, in a worker, on a server or in a replay comes out the same.
+*
+* Within a unit in the last place of `Math`'s; they are not faster. What only draws (a view, an effect) has no need of
+* them: what decides does
+*/
+/** The high 32 bits of a number as a double: its sign, its exponent and the top of its fraction */
+var view = /* @__PURE__ */ new DataView(/* @__PURE__ */ new ArrayBuffer(8));
+function highWord(x) {
+	view.setFloat64(0, x);
+	return view.getInt32(0);
+}
+var S1 = -.16666666666666632;
+var S2 = .00833333333332249;
+var S3 = -.0001984126982985795;
+var S4 = 27557313707070068e-22;
+var S5 = -2.5050760253406863e-8;
+var S6 = 158969099521155e-24;
+/** sin on [-π/4, π/4], of `x + y` where `y` is the tail of a reduced argument (`tail` false when there is none) */
+function kernelSin(x, y, tail) {
+	const z = x * x;
+	const w = z * z;
+	const r = S2 + z * (S3 + z * S4) + z * w * (S5 + z * S6);
+	const v = z * x;
+	if (!tail) return x + v * (S1 + z * r);
+	return x - (z * (.5 * y - v * r) - y - v * S1);
+}
+var C1 = .0416666666666666;
+var C2 = -.001388888888887411;
+var C3 = 2480158728947673e-20;
+var C4 = -2.7557314351390663e-7;
+var C5 = 2.087572321298175e-9;
+var C6 = -11359647557788195e-27;
+/** cos on [-π/4, π/4], of `x + y` */
+function kernelCos(x, y) {
+	const z = x * x;
+	let w = z * z;
+	const r = z * (C1 + z * (C2 + z * C3)) + w * w * (C4 + z * (C5 + z * C6));
+	const hz = .5 * z;
+	w = 1 - hz;
+	return w + (1 - w - hz + (z * r - x * y));
+}
+var INV_PIO2 = .6366197723675814;
+var PIO2_1 = 1.5707963267341256;
+var PIO2_1T = 6077100506506192e-26;
+var PIO2_2 = 6077100506303966e-26;
+var PIO2_2T = 20222662487959506e-37;
+var PIO2_3 = 20222662487111665e-37;
+var PIO2_3T = 84784276603689e-45;
+var TWO_PI = 6.283185307179586;
+/** 1.5 × 2⁵²: added and taken away, it rounds a number to the nearest integer, ties to even, in every engine */
+var ROUNDER = 6755399441055744;
+/** `x` less the nearest multiple of π/2: which multiple (`n`), and the rest as a head and a tail (`y0 + y1`) */
+var reduced = {
+	n: 0,
+	y0: 0,
+	y1: 0
+};
+function reduce(x) {
+	if (Math.abs(x) > 1647099.3291652855) x -= TWO_PI * (x / TWO_PI + ROUNDER - ROUNDER);
+	const fn = x * INV_PIO2 + ROUNDER - ROUNDER;
+	let r = x - fn * PIO2_1;
+	let w = fn * PIO2_1T;
+	let y0 = r - w;
+	const j = highWord(x) >> 20 & 2047;
+	let i = j - (highWord(y0) >> 20 & 2047);
+	if (i > 16) {
+		let t = r;
+		w = fn * PIO2_2;
+		r = t - w;
+		w = fn * PIO2_2T - (t - r - w);
+		y0 = r - w;
+		i = j - (highWord(y0) >> 20 & 2047);
+		if (i > 49) {
+			t = r;
+			w = fn * PIO2_3;
+			r = t - w;
+			w = fn * PIO2_3T - (t - r - w);
+			y0 = r - w;
+		}
+	}
+	reduced.n = fn;
+	reduced.y0 = y0;
+	reduced.y1 = r - y0 - w;
+}
+/**
+* The sine, the same in every engine (fdlibm's)
+*
+* @beta
+*/
+function sin(x) {
+	const ax = Math.abs(x);
+	if (ax <= .7853981633974483) return ax < 7.450580596923828e-9 ? x : kernelSin(x, 0, false);
+	if (!Number.isFinite(x)) return NaN;
+	reduce(x);
+	const { y0, y1 } = reduced;
+	switch (reduced.n & 3) {
+		case 0: return kernelSin(y0, y1, true);
+		case 1: return kernelCos(y0, y1);
+		case 2: return -kernelSin(y0, y1, true);
+		default: return -kernelCos(y0, y1);
+	}
+}
+/**
+* The cosine, the same in every engine (fdlibm's)
+*
+* @beta
+*/
+function cos(x) {
+	const ax = Math.abs(x);
+	if (ax <= .7853981633974483) return ax < 7.450580596923828e-9 ? 1 : kernelCos(x, 0);
+	if (!Number.isFinite(x)) return NaN;
+	reduce(x);
+	const { y0, y1 } = reduced;
+	switch (reduced.n & 3) {
+		case 0: return kernelCos(y0, y1);
+		case 1: return -kernelSin(y0, y1, true);
+		case 2: return -kernelCos(y0, y1);
+		default: return kernelSin(y0, y1, true);
+	}
+}
+var ATAN_HI = [
+	.4636476090008061,
+	.7853981633974483,
+	.982793723247329,
+	1.5707963267948966
+];
+var ATAN_LO = [
+	22698777452961687e-33,
+	3061616997868383e-32,
+	13903311031230998e-33,
+	6123233995736766e-32
+];
+var AT = [
+	.3333333333333293,
+	-.19999999999876483,
+	.14285714272503466,
+	-.11111110405462356,
+	.09090887133436507,
+	-.0769187620504483,
+	.06661073137387531,
+	-.058335701337905735,
+	.049768779946159324,
+	-.036531572744216916,
+	.016285820115365782
+];
+/**
+* The arctangent, the same in every engine (fdlibm's)
+*
+* @beta
+*/
+function atan(x) {
+	if (Number.isNaN(x)) return NaN;
+	const negative = x < 0 || Object.is(x, -0);
+	let ax = Math.abs(x);
+	if (ax >= 0x40000000000000000) return negative ? -(ATAN_HI[3] + ATAN_LO[3]) : ATAN_HI[3] + ATAN_LO[3];
+	let id;
+	if (ax < .4375) {
+		if (ax < 7.450580596923828e-9) return x;
+		id = -1;
+		ax = x;
+	} else if (ax < 1.1875) {
+		if (ax < .6875) {
+			id = 0;
+			ax = (2 * ax - 1) / (2 + ax);
+		} else {
+			id = 1;
+			ax = (ax - 1) / (ax + 1);
+		}
+	} else if (ax < 2.4375) {
+		id = 2;
+		ax = (ax - 1.5) / (1 + 1.5 * ax);
+	} else {
+		id = 3;
+		ax = -1 / ax;
+	}
+	const z = ax * ax;
+	const w = z * z;
+	const s1 = z * (AT[0] + w * (AT[2] + w * (AT[4] + w * (AT[6] + w * (AT[8] + w * AT[10])))));
+	const s2 = w * (AT[1] + w * (AT[3] + w * (AT[5] + w * (AT[7] + w * AT[9]))));
+	if (id < 0) return ax - ax * (s1 + s2);
+	const result = ATAN_HI[id] - (ax * (s1 + s2) - ATAN_LO[id] - ax);
+	return negative ? -result : result;
+}
+var PI = 3.141592653589793;
+var PI_LO = 12246467991473532e-32;
+var PI_O_2 = 1.5707963267948966;
+var PI_O_4 = .7853981633974483;
+/**
+* The angle of a point from the x axis, `atan2(y, x)`, the same in every engine (fdlibm's)
+*
+* @beta
+*/
+function atan2(y, x) {
+	if (Number.isNaN(x) || Number.isNaN(y)) return NaN;
+	if (x === 1) return atan(y);
+	const yNegative = y < 0 || Object.is(y, -0);
+	const xNegative = x < 0 || Object.is(x, -0);
+	if (y === 0) return xNegative ? yNegative ? -3.141592653589793 : PI : y;
+	if (x === 0) return yNegative ? -1.5707963267948966 : PI_O_2;
+	if (!Number.isFinite(x)) {
+		if (!Number.isFinite(y)) {
+			const angle = xNegative ? 3 * PI_O_4 : PI_O_4;
+			return yNegative ? -angle : angle;
+		}
+		const angle = xNegative ? PI : 0;
+		return yNegative ? -angle : angle;
+	}
+	if (!Number.isFinite(y)) return yNegative ? -1.5707963267948966 : PI_O_2;
+	const ratio = Math.abs(y / x);
+	let z;
+	if (ratio > 0x1000000000000000) z = 1.5707963267948966;
+	else if (xNegative && ratio < 8673617379884035e-34) z = 0;
+	else z = atan(ratio);
+	if (!xNegative) return yNegative ? -z : z;
+	return yNegative ? z - PI_LO - PI : PI - (z - PI_LO);
+}
+/**
+* The length of `(x, y)`, `√(x² + y²)`, the same in every engine (`Math.hypot` is not: it scales its arguments as each
+* engine likes). For the lengths of a game, which are neither near 1e154 nor near 1e-154
+*
+* @beta
+*/
+var hypot = (x, y) => Math.sqrt(x * x + y * y);
+var LN2 = .6931471805599453;
+/** Terms of the series: at a remainder under half of ln 2, the next term is under 1e-24 of the sum, well under a double's last place */
+var EXP_TERMS = 18;
+/**
+* e^x, the same in every engine (`Math.exp` is not: each has its own): `x` is split into a count of ln 2 and a
+* remainder under half of one, the remainder's exponential is its Taylor series (adding and multiplying alone, which
+* are exact everywhere), and the result is that doubled or halved the count of times. Within a few units in the last
+* place of `Math.exp`'s; the point is sameness, not speed. What a response curve of the computer player's is made of
+* (`curve.saturate`, AI plan B1)
+*/
+function exp(x) {
+	if (x !== x) return NaN;
+	if (x > 709.782712893384) return Infinity;
+	if (x < -745.1332191019412) return 0;
+	const k = Math.round(x / LN2);
+	const r = x - k * LN2;
+	let term = 1;
+	let sum = 1;
+	for (let i = 1; i <= EXP_TERMS; i++) {
+		term *= r / i;
+		sum += term;
+	}
+	if (k > 0) for (let i = 0; i < k; i++) sum *= 2;
+	else for (let i = 0; i < -k; i++) sum *= .5;
+	return sum;
+}
+/**
+* The simulation's maths, the same in every engine: what a game's rules use in the place of `Math`'s, so that its
+* worlds come out the same in a page, on a server and in a replay (`sin`, `cos`, `atan`, `atan2`, `hypot`, `exp`)
+*
+* @beta
+*/
+var exactMath = {
+	sin,
+	cos,
+	atan,
+	atan2,
+	hypot,
+	exp
+};
+//#endregion
+export { atan, atan2, cos, exactMath, exp, hypot, sin };
+
+//# sourceMappingURL=exactMath.js.map

package/dist/exactMath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exactMath.js","names":[],"sources":["../src/exactMath.ts"],"sourcesContent":["/**\n * The maths the simulation does, the same to the last bit in every engine (determinism D3). JavaScript says exactly\n * what `+`, `-`, `*`, `/` and `Math.sqrt` give, but not `Math.sin`, `Math.cos`, `Math.atan`, `Math.atan2` or\n * `Math.hypot`: V8, SpiderMonkey and JavaScriptCore each have their own, and two versions of one can differ (Node 22's\n * `atan2` and Chromium's do, in the last bit). These are fdlibm's (FreeBSD's msun), written with what is exact\n * everywhere, so a world run in a page, in a worker, on a server or in a replay comes out the same.\n *\n * Within a unit in the last place of `Math`'s; they are not faster. What only draws (a view, an effect) has no need of\n * them: what decides does\n */\n\n/** The high 32 bits of a number as a double: its sign, its exponent and the top of its fraction */\nconst view = new DataView(new ArrayBuffer(8))\nfunction highWord(x: number): number {\n\tview.setFloat64(0, x)\n\treturn view.getInt32(0)\n}\n\n// ---- sin, cos (k_sin.c, k_cos.c, e_rem_pio2.c)\n\nconst S1 = -1.66666666666666324348e-1\nconst S2 = 8.33333333332248946124e-3\nconst S3 = -1.98412698298579493134e-4\nconst S4 = 2.75573137070700676789e-6\nconst S5 = -2.50507602534068634195e-8\nconst S6 = 1.58969099521155010221e-10\n\n/** sin on [-π/4, π/4], of `x + y` where `y` is the tail of a reduced argument (`tail` false when there is none) */\nfunction kernelSin(x: number, y: number, tail: boolean): number {\n\tconst z = x * x\n\tconst w = z * z\n\tconst r = S2 + z * (S3 + z * S4) + z * w * (S5 + z * S6)\n\tconst v = z * x\n\tif (!tail) return x + v * (S1 + z * r)\n\treturn x - (z * (0.5 * y - v * r) - y - v * S1)\n}\n\nconst C1 = 4.16666666666666019037e-2\nconst C2 = -1.38888888888741095749e-3\nconst C3 = 2.48015872894767294178e-5\nconst C4 = -2.75573143513906633035e-7\nconst C5 = 2.0875723212981748279e-9\nconst C6 = -1.13596475577881948265e-11\n\n/** cos on [-π/4, π/4], of `x + y` */\nfunction kernelCos(x: number, y: number): number {\n\tconst z = x * x\n\tlet w = z * z\n\tconst r = z * (C1 + z * (C2 + z * C3)) + w * w * (C4 + z * (C5 + z * C6))\n\tconst hz = 0.5 * z\n\tw = 1 - hz\n\treturn w + (1 - w - hz + (z * r - x * y))\n}\n\nconst INV_PIO2 = 6.36619772367581382433e-1\nconst PIO2_1 = 1.57079632673412561417\nconst PIO2_1T = 6.07710050650619224932e-11\nconst PIO2_2 = 6.0771005063039659766e-11\nconst PIO2_2T = 2.02226624879595063154e-21\nconst PIO2_3 = 2.0222662487111664558e-21\nconst PIO2_3T = 8.47842766036889956997e-32\nconst TWO_PI = 6.283185307179586\n/** 1.5 × 2⁵²: added and taken away, it rounds a number to the nearest integer, ties to even, in every engine */\nconst ROUNDER = 6755399441055744\n\n/** `x` less the nearest multiple of π/2: which multiple (`n`), and the rest as a head and a tail (`y0 + y1`) */\nconst reduced = { n: 0, y0: 0, y1: 0 }\nfunction reduce(x: number): void {\n\t// far out (more than 2²⁰·π/2), whole turns are taken off first: less exact than fdlibm's long reduction, as exact\n\t// in every engine, and an angle in a game is never there\n\tif (Math.abs(x) > 1647099.3291652855) x -= TWO_PI * (x / TWO_PI + ROUNDER - ROUNDER)\n\tconst fn = x * INV_PIO2 + ROUNDER - ROUNDER\n\tlet r = x - fn * PIO2_1\n\tlet w = fn * PIO2_1T\n\tlet y0 = r - w\n\tconst j = (highWord(x) >> 20) & 0x7ff\n\tlet i = j - ((highWord(y0) >> 20) & 0x7ff)\n\tif (i > 16) {\n\t\t// a second step, where the first took off nearly all of it\n\t\tlet t = r\n\t\tw = fn * PIO2_2\n\t\tr = t - w\n\t\tw = fn * PIO2_2T - (t - r - w)\n\t\ty0 = r - w\n\t\ti = j - ((highWord(y0) >> 20) & 0x7ff)\n\t\tif (i > 49) {\n\t\t\tt = r\n\t\t\tw = fn * PIO2_3\n\t\t\tr = t - w\n\t\t\tw = fn * PIO2_3T - (t - r - w)\n\t\t\ty0 = r - w\n\t\t}\n\t}\n\treduced.n = fn\n\treduced.y0 = y0\n\treduced.y1 = r - y0 - w\n}\n\n/**\n * The sine, the same in every engine (fdlibm's)\n *\n * @beta\n */\nexport function sin(x: number): number {\n\tconst ax = Math.abs(x)\n\tif (ax <= 0.7853981633974483) return ax < 7.450580596923828e-9 ? x : kernelSin(x, 0, false)\n\tif (!Number.isFinite(x)) return NaN\n\treduce(x)\n\tconst { y0, y1 } = reduced\n\tswitch (reduced.n & 3) {\n\t\tcase 0:\n\t\t\treturn kernelSin(y0, y1, true)\n\t\tcase 1:\n\t\t\treturn kernelCos(y0, y1)\n\t\tcase 2:\n\t\t\treturn -kernelSin(y0, y1, true)\n\t\tdefault:\n\t\t\treturn -kernelCos(y0, y1)\n\t}\n}\n\n/**\n * The cosine, the same in every engine (fdlibm's)\n *\n * @beta\n */\nexport function cos(x: number): number {\n\tconst ax = Math.abs(x)\n\tif (ax <= 0.7853981633974483) return ax < 7.450580596923828e-9 ? 1 : kernelCos(x, 0)\n\tif (!Number.isFinite(x)) return NaN\n\treduce(x)\n\tconst { y0, y1 } = reduced\n\tswitch (reduced.n & 3) {\n\t\tcase 0:\n\t\t\treturn kernelCos(y0, y1)\n\t\tcase 1:\n\t\t\treturn -kernelSin(y0, y1, true)\n\t\tcase 2:\n\t\t\treturn -kernelCos(y0, y1)\n\t\tdefault:\n\t\t\treturn kernelSin(y0, y1, true)\n\t}\n}\n\n// ---- atan, atan2 (s_atan.c, e_atan2.c)\n\nconst ATAN_HI = [4.63647609000806093515e-1, 7.85398163397448278999e-1, 9.82793723247329054082e-1, 1.570796326794896558]\nconst ATAN_LO = [2.26987774529616870924e-17, 3.06161699786838301793e-17, 1.39033110312309984516e-17, 6.12323399573676603587e-17]\nconst AT = [\n\t3.33333333333329318027e-1, -1.99999999998764832476e-1, 1.42857142725034663711e-1, -1.1111110405462355788e-1, 9.09088713343650656196e-2,\n\t-7.69187620504482999495e-2, 6.66107313738753120669e-2, -5.83357013379057348645e-2, 4.97687799461593236017e-2, -3.6531572744216915527e-2,\n\t1.62858201153657823623e-2\n]\n\n/**\n * The arctangent, the same in every engine (fdlibm's)\n *\n * @beta\n */\nexport function atan(x: number): number {\n\tif (Number.isNaN(x)) return NaN\n\tconst negative = x < 0 || Object.is(x, -0)\n\tlet ax = Math.abs(x)\n\tif (ax >= 7.378697629483821e19) return negative ? -(ATAN_HI[3] + ATAN_LO[3]) : ATAN_HI[3] + ATAN_LO[3]\n\tlet id: number\n\tif (ax < 0.4375) {\n\t\tif (ax < 7.450580596923828e-9) return x\n\t\tid = -1\n\t\tax = x\n\t} else if (ax < 1.1875) {\n\t\tif (ax < 0.6875) {\n\t\t\tid = 0\n\t\t\tax = (2 * ax - 1) / (2 + ax)\n\t\t} else {\n\t\t\tid = 1\n\t\t\tax = (ax - 1) / (ax + 1)\n\t\t}\n\t} else if (ax < 2.4375) {\n\t\tid = 2\n\t\tax = (ax - 1.5) / (1 + 1.5 * ax)\n\t} else {\n\t\tid = 3\n\t\tax = -1 / ax\n\t}\n\tconst z = ax * ax\n\tconst w = z * z\n\tconst s1 = z * (AT[0] + w * (AT[2] + w * (AT[4] + w * (AT[6] + w * (AT[8] + w * AT[10])))))\n\tconst s2 = w * (AT[1] + w * (AT[3] + w * (AT[5] + w * (AT[7] + w * AT[9]))))\n\tif (id < 0) return ax - ax * (s1 + s2)\n\tconst result = ATAN_HI[id] - (ax * (s1 + s2) - ATAN_LO[id] - ax)\n\treturn negative ? -result : result\n}\n\nconst PI = 3.141592653589793116\nconst PI_LO = 1.2246467991473531772e-16\nconst PI_O_2 = 1.570796326794896558\nconst PI_O_4 = 7.85398163397448279e-1\n\n/**\n * The angle of a point from the x axis, `atan2(y, x)`, the same in every engine (fdlibm's)\n *\n * @beta\n */\nexport function atan2(y: number, x: number): number {\n\tif (Number.isNaN(x) || Number.isNaN(y)) return NaN\n\tif (x === 1) return atan(y)\n\tconst yNegative = y < 0 || Object.is(y, -0)\n\tconst xNegative = x < 0 || Object.is(x, -0)\n\tif (y === 0) return xNegative ? (yNegative ? -PI : PI) : y\n\tif (x === 0) return yNegative ? -PI_O_2 : PI_O_2\n\tif (!Number.isFinite(x)) {\n\t\tif (!Number.isFinite(y)) {\n\t\t\tconst angle = xNegative ? 3 * PI_O_4 : PI_O_4\n\t\t\treturn yNegative ? -angle : angle\n\t\t}\n\t\tconst angle = xNegative ? PI : 0\n\t\treturn yNegative ? -angle : angle\n\t}\n\tif (!Number.isFinite(y)) return yNegative ? -PI_O_2 : PI_O_2\n\tconst ratio = Math.abs(y / x)\n\tlet z: number\n\tif (ratio > 1.152921504606847e18) z = PI_O_2 + 0.5 * PI_LO\n\telse if (xNegative && ratio < 8.673617379884035e-19) z = 0\n\telse z = atan(ratio)\n\tif (!xNegative) return yNegative ? -z : z\n\treturn yNegative ? z - PI_LO - PI : PI - (z - PI_LO)\n}\n\n/**\n * The length of `(x, y)`, `√(x² + y²)`, the same in every engine (`Math.hypot` is not: it scales its arguments as each\n * engine likes). For the lengths of a game, which are neither near 1e154 nor near 1e-154\n *\n * @beta\n */\nexport const hypot = (x: number, y: number): number => Math.sqrt(x * x + y * y)\n\n// ---- exp\n\nconst LN2 = 6.93147180559945286227e-1\n/** Terms of the series: at a remainder under half of ln 2, the next term is under 1e-24 of the sum, well under a double's last place */\nconst EXP_TERMS = 18\n\n/**\n * e^x, the same in every engine (`Math.exp` is not: each has its own): `x` is split into a count of ln 2 and a\n * remainder under half of one, the remainder's exponential is its Taylor series (adding and multiplying alone, which\n * are exact everywhere), and the result is that doubled or halved the count of times. Within a few units in the last\n * place of `Math.exp`'s; the point is sameness, not speed. What a response curve of the computer player's is made of\n * (`curve.saturate`, AI plan B1)\n */\nexport function exp(x: number): number {\n\tif (x !== x) return NaN\n\tif (x > 709.782712893384) return Infinity\n\tif (x < -745.1332191019412) return 0\n\tconst k = Math.round(x / LN2)\n\tconst r = x - k * LN2\n\tlet term = 1\n\tlet sum = 1\n\tfor (let i = 1; i <= EXP_TERMS; i++) {\n\t\tterm *= r / i\n\t\tsum += term\n\t}\n\t// 2^k by doubling or halving: a count of exact steps, never `**`\n\tif (k > 0) for (let i = 0; i < k; i++) sum *= 2\n\telse for (let i = 0; i < -k; i++) sum *= 0.5\n\treturn sum\n}\n\n/**\n * The simulation's maths, the same in every engine: what a game's rules use in the place of `Math`'s, so that its\n * worlds come out the same in a page, on a server and in a replay (`sin`, `cos`, `atan`, `atan2`, `hypot`, `exp`)\n *\n * @beta\n */\nexport const exactMath = { sin, cos, atan, atan2, hypot, exp } as const\n"],"mappings":";;;;;;;;;;;;AAYA,IAAM,uBAAO,IAAI,yBAAS,IAAI,YAAY,CAAC,CAAC;AAC5C,SAAS,SAAS,GAAmB;CACpC,KAAK,WAAW,GAAG,CAAC;CACpB,OAAO,KAAK,SAAS,CAAC;AACvB;AAIA,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;;AAGX,SAAS,UAAU,GAAW,GAAW,MAAuB;CAC/D,MAAM,IAAI,IAAI;CACd,MAAM,IAAI,IAAI;CACd,MAAM,IAAI,KAAK,KAAK,KAAK,IAAI,MAAM,IAAI,KAAK,KAAK,IAAI;CACrD,MAAM,IAAI,IAAI;CACd,IAAI,CAAC,MAAM,OAAO,IAAI,KAAK,KAAK,IAAI;CACpC,OAAO,KAAK,KAAK,KAAM,IAAI,IAAI,KAAK,IAAI,IAAI;AAC7C;AAEA,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;AACX,IAAM,KAAK;;AAGX,SAAS,UAAU,GAAW,GAAmB;CAChD,MAAM,IAAI,IAAI;CACd,IAAI,IAAI,IAAI;CACZ,MAAM,IAAI,KAAK,KAAK,KAAK,KAAK,IAAI,OAAO,IAAI,KAAK,KAAK,KAAK,KAAK,IAAI;CACrE,MAAM,KAAK,KAAM;CACjB,IAAI,IAAI;CACR,OAAO,KAAK,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI;AACvC;AAEA,IAAM,WAAW;AACjB,IAAM,SAAS;AACf,IAAM,UAAU;AAChB,IAAM,SAAS;AACf,IAAM,UAAU;AAChB,IAAM,SAAS;AACf,IAAM,UAAU;AAChB,IAAM,SAAS;;AAEf,IAAM,UAAU;;AAGhB,IAAM,UAAU;CAAE,GAAG;CAAG,IAAI;CAAG,IAAI;AAAE;AACrC,SAAS,OAAO,GAAiB;CAGhC,IAAI,KAAK,IAAI,CAAC,IAAI,oBAAoB,KAAK,UAAU,IAAI,SAAS,UAAU;CAC5E,MAAM,KAAK,IAAI,WAAW,UAAU;CACpC,IAAI,IAAI,IAAI,KAAK;CACjB,IAAI,IAAI,KAAK;CACb,IAAI,KAAK,IAAI;CACb,MAAM,IAAK,SAAS,CAAC,KAAK,KAAM;CAChC,IAAI,IAAI,KAAM,SAAS,EAAE,KAAK,KAAM;CACpC,IAAI,IAAI,IAAI;EAEX,IAAI,IAAI;EACR,IAAI,KAAK;EACT,IAAI,IAAI;EACR,IAAI,KAAK,WAAW,IAAI,IAAI;EAC5B,KAAK,IAAI;EACT,IAAI,KAAM,SAAS,EAAE,KAAK,KAAM;EAChC,IAAI,IAAI,IAAI;GACX,IAAI;GACJ,IAAI,KAAK;GACT,IAAI,IAAI;GACR,IAAI,KAAK,WAAW,IAAI,IAAI;GAC5B,KAAK,IAAI;EACV;CACD;CACA,QAAQ,IAAI;CACZ,QAAQ,KAAK;CACb,QAAQ,KAAK,IAAI,KAAK;AACvB;;;;;;AAOA,SAAgB,IAAI,GAAmB;CACtC,MAAM,KAAK,KAAK,IAAI,CAAC;CACrB,IAAI,MAAM,mBAAoB,OAAO,KAAK,uBAAuB,IAAI,UAAU,GAAG,GAAG,KAAK;CAC1F,IAAI,CAAC,OAAO,SAAS,CAAC,GAAG,OAAO;CAChC,OAAO,CAAC;CACR,MAAM,EAAE,IAAI,OAAO;CACnB,QAAQ,QAAQ,IAAI,GAApB;EACC,KAAK,GACJ,OAAO,UAAU,IAAI,IAAI,IAAI;EAC9B,KAAK,GACJ,OAAO,UAAU,IAAI,EAAE;EACxB,KAAK,GACJ,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI;EAC/B,SACC,OAAO,CAAC,UAAU,IAAI,EAAE;CAC1B;AACD;;;;;;AAOA,SAAgB,IAAI,GAAmB;CACtC,MAAM,KAAK,KAAK,IAAI,CAAC;CACrB,IAAI,MAAM,mBAAoB,OAAO,KAAK,uBAAuB,IAAI,UAAU,GAAG,CAAC;CACnF,IAAI,CAAC,OAAO,SAAS,CAAC,GAAG,OAAO;CAChC,OAAO,CAAC;CACR,MAAM,EAAE,IAAI,OAAO;CACnB,QAAQ,QAAQ,IAAI,GAApB;EACC,KAAK,GACJ,OAAO,UAAU,IAAI,EAAE;EACxB,KAAK,GACJ,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI;EAC/B,KAAK,GACJ,OAAO,CAAC,UAAU,IAAI,EAAE;EACzB,SACC,OAAO,UAAU,IAAI,IAAI,IAAI;CAC/B;AACD;AAIA,IAAM,UAAU;CAAC;CAA2B;CAA2B;CAA2B;AAAoB;AACtH,IAAM,UAAU;CAAC;CAA4B;CAA4B;CAA4B;AAA0B;AAC/H,IAAM,KAAK;CACV;CAA2B;CAA4B;CAA2B;CAA2B;CAC7G;CAA4B;CAA2B;CAA4B;CAA2B;CAC9G;AACD;;;;;;AAOA,SAAgB,KAAK,GAAmB;CACvC,IAAI,OAAO,MAAM,CAAC,GAAG,OAAO;CAC5B,MAAM,WAAW,IAAI,KAAK,OAAO,GAAG,GAAG,EAAE;CACzC,IAAI,KAAK,KAAK,IAAI,CAAC;CACnB,IAAI,MAAM,qBAAsB,OAAO,WAAW,EAAE,QAAQ,KAAK,QAAQ,MAAM,QAAQ,KAAK,QAAQ;CACpG,IAAI;CACJ,IAAI,KAAK,OAAQ;EAChB,IAAI,KAAK,sBAAsB,OAAO;EACtC,KAAK;EACL,KAAK;CACN,OAAO,IAAI,KAAK,QAAQ;EACvB,IAAI,KAAK,OAAQ;GAChB,KAAK;GACL,MAAM,IAAI,KAAK,MAAM,IAAI;EAC1B,OAAO;GACN,KAAK;GACL,MAAM,KAAK,MAAM,KAAK;EACvB;CACD,OAAO,IAAI,KAAK,QAAQ;EACvB,KAAK;EACL,MAAM,KAAK,QAAQ,IAAI,MAAM;CAC9B,OAAO;EACN,KAAK;EACL,KAAK,KAAK;CACX;CACA,MAAM,IAAI,KAAK;CACf,MAAM,IAAI,IAAI;CACd,MAAM,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,IAAI,GAAG;CACnF,MAAM,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,IAAI,GAAG;CACtE,IAAI,KAAK,GAAG,OAAO,KAAK,MAAM,KAAK;CACnC,MAAM,SAAS,QAAQ,OAAO,MAAM,KAAK,MAAM,QAAQ,MAAM;CAC7D,OAAO,WAAW,CAAC,SAAS;AAC7B;AAEA,IAAM,KAAK;AACX,IAAM,QAAQ;AACd,IAAM,SAAS;AACf,IAAM,SAAS;;;;;;AAOf,SAAgB,MAAM,GAAW,GAAmB;CACnD,IAAI,OAAO,MAAM,CAAC,KAAK,OAAO,MAAM,CAAC,GAAG,OAAO;CAC/C,IAAI,MAAM,GAAG,OAAO,KAAK,CAAC;CAC1B,MAAM,YAAY,IAAI,KAAK,OAAO,GAAG,GAAG,EAAE;CAC1C,MAAM,YAAY,IAAI,KAAK,OAAO,GAAG,GAAG,EAAE;CAC1C,IAAI,MAAM,GAAG,OAAO,YAAa,YAAY,qBAAM,KAAM;CACzD,IAAI,MAAM,GAAG,OAAO,YAAY,sBAAU;CAC1C,IAAI,CAAC,OAAO,SAAS,CAAC,GAAG;EACxB,IAAI,CAAC,OAAO,SAAS,CAAC,GAAG;GACxB,MAAM,QAAQ,YAAY,IAAI,SAAS;GACvC,OAAO,YAAY,CAAC,QAAQ;EAC7B;EACA,MAAM,QAAQ,YAAY,KAAK;EAC/B,OAAO,YAAY,CAAC,QAAQ;CAC7B;CACA,IAAI,CAAC,OAAO,SAAS,CAAC,GAAG,OAAO,YAAY,sBAAU;CACtD,MAAM,QAAQ,KAAK,IAAI,IAAI,CAAC;CAC5B,IAAI;CACJ,IAAI,QAAQ,oBAAsB,IAAI;MACjC,IAAI,aAAa,QAAQ,sBAAuB,IAAI;MACpD,IAAI,KAAK,KAAK;CACnB,IAAI,CAAC,WAAW,OAAO,YAAY,CAAC,IAAI;CACxC,OAAO,YAAY,IAAI,QAAQ,KAAK,MAAM,IAAI;AAC/C;;;;;;;AAQA,IAAa,SAAS,GAAW,MAAsB,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC;AAI9E,IAAM,MAAM;;AAEZ,IAAM,YAAY;;;;;;;;AASlB,SAAgB,IAAI,GAAmB;CACtC,IAAI,MAAM,GAAG,OAAO;CACpB,IAAI,IAAI,kBAAkB,OAAO;CACjC,IAAI,IAAI,oBAAoB,OAAO;CACnC,MAAM,IAAI,KAAK,MAAM,IAAI,GAAG;CAC5B,MAAM,IAAI,IAAI,IAAI;CAClB,IAAI,OAAO;CACX,IAAI,MAAM;CACV,KAAK,IAAI,IAAI,GAAG,KAAK,WAAW,KAAK;EACpC,QAAQ,IAAI;EACZ,OAAO;CACR;CAEA,IAAI,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,IAAI,GAAG,KAAK,OAAO;MACzC,KAAK,IAAI,IAAI,GAAG,IAAI,CAAC,GAAG,KAAK,OAAO;CACzC,OAAO;AACR;;;;;;;AAQA,IAAa,YAAY;CAAE;CAAK;CAAK;CAAM;CAAO;CAAO;AAAI"}

package/dist/features.d.ts

@@ -1,7 +1,7 @@
 import { type HookDef } from './hooks';
 /**
  * The rules the engine brings along, written as hook handlers like any game module's. A module can leave any
- * of them out by id (`GameModule.withoutHooks`), or put its own in place of one by giving a handler the same id.
+ * of them out by id (`Rules.withoutHooks`), or put its own in place of one by giving a handler the same id.
  *
  * @beta
  */

package/dist/features.js

@@ -0,0 +1,127 @@
+import { bounty } from "./engineEvents.js";
+import { replicateEvent } from "./replication.js";
+import { earn } from "./player.js";
+import { engineMessage } from "./messages.js";
+import { form } from "./formState.js";
+import { defineHook } from "./hooks.js";
+import { Path } from "./paths.js";
+import { attackLanded, breakBuffs, carrierDied, castTriggers, damageTriggers, killTriggers } from "./abilities/triggers.js";
+import { dropLoot } from "./items.js";
+import { garrisonHooks } from "./transport.js";
+import { summonHooks, worthless } from "./summons.js";
+import { leaveForm } from "./forms.js";
+//#region src/features.ts
+/**
+* The rules the engine brings along, written as hook handlers like any game module's. A module can leave any
+* of them out by id (`Rules.withoutHooks`), or put its own in place of one by giving a handler the same id.
+*
+* @beta
+*/
+var coreHooks = [
+	defineHook({
+		hook: "canPlace",
+		id: "mapPathsClear",
+		run(world, event) {
+			if (event.cancelled) return;
+			const { site } = event;
+			for (const def of world.map.paths) {
+				if (!def.keepClear) continue;
+				const path = new Path(def.points, def.width);
+				for (let cz = Math.floor(site.z - site.hd); cz < Math.ceil(site.z + site.hd); cz++) for (let cx = Math.floor(site.x - site.hw); cx < Math.ceil(site.x + site.hw); cx++) {
+					if (!path.containsCell(cx, cz)) continue;
+					event.cancelled = true;
+					event.reason = engineMessage("cannotBuildThere");
+					return;
+				}
+			}
+		}
+	}),
+	defineHook({
+		hook: "beforeDeath",
+		id: "undying",
+		run(_world, event) {
+			if (!event.fromDamage || !event.entity.def.undying) return;
+			event.cancelled = true;
+			event.entity.health = Math.max(event.entity.health, 1);
+		}
+	}),
+	defineHook({
+		hook: "death",
+		id: "formEnds",
+		run(world, { entity }) {
+			if (entity.get(form)?.back.includes("death")) leaveForm(world, entity, "death");
+		}
+	}),
+	defineHook({
+		hook: "death",
+		id: "loot",
+		run(world, { entity, killer }) {
+			if (killer && world.areEnemies(killer.owner, entity.owner) && !worthless(entity)) dropLoot(world, entity, killer);
+		}
+	}),
+	defineHook({
+		hook: "death",
+		id: "bounty",
+		run(world, { entity, killer }) {
+			const { bounty: bounty$1 } = entity.def;
+			const { currency } = world.registry;
+			if (!bounty$1 || !currency || !killer || !world.areEnemies(killer.owner, entity.owner) || worthless(entity)) return;
+			const amount = world.rng.int(bounty$1[0], bounty$1[1]);
+			earn(world.player(killer.owner).resources, currency, amount);
+			world.events.emit(bounty, {
+				entity,
+				player: killer.owner,
+				amount
+			});
+		}
+	}),
+	defineHook({
+		hook: "afterDamage",
+		id: "onHit",
+		run(world, { target, source, attack, dealt }) {
+			if (attack && source?.alive) attackLanded(world, source, target, dealt);
+		}
+	}),
+	defineHook({
+		hook: "afterDamage",
+		id: "triggers",
+		run(world, event) {
+			damageTriggers(world, event);
+		}
+	}),
+	defineHook({
+		hook: "afterCast",
+		id: "onCast",
+		run(world, { caster, ability, item, charged }) {
+			if (!item && !charged) castTriggers(world, caster, ability);
+			if (caster.alive && caster.buffs.length) breakBuffs(world, caster, "cast", ability.id);
+		}
+	}),
+	defineHook({
+		hook: "death",
+		id: "onCarrierDeath",
+		run(world, { entity }) {
+			if (entity.buffs.length) carrierDied(world, entity);
+		}
+	}),
+	defineHook({
+		hook: "afterDeath",
+		id: "onKill",
+		run(world, { entity, killer, attack, carried }) {
+			if (killer?.alive && world.areEnemies(killer.owner, entity.owner)) killTriggers(world, killer, entity, attack, carried);
+		}
+	}),
+	...summonHooks,
+	...garrisonHooks
+];
+/** A bounty, to whoever got it */
+var toldBounty = replicateEvent(bounty, "bounty", ({ entity, player, amount }, view) => player === view.player ? {
+	type: "bounty",
+	x: entity.pos.x,
+	z: entity.pos.z,
+	amount
+} : void 0);
+//#endregion
+export { coreHooks, toldBounty };
+
+//# sourceMappingURL=features.js.map

package/dist/features.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.js","names":["bounty","bountyEvent"],"sources":["../src/features.ts"],"sourcesContent":["import { bounty as bountyEvent } from '#engine/engineEvents'\nimport { attackLanded, breakBuffs, carrierDied, castTriggers, damageTriggers, killTriggers } from './abilities/triggers'\nimport { garrisonHooks } from './transport'\nimport { summonHooks, worthless } from './summons'\nimport { leaveForm } from './forms'\nimport { form } from './formState'\nimport { defineHook, type HookDef } from './hooks'\nimport { dropLoot } from './items'\nimport { engineMessage } from './messages'\nimport { Path } from './paths'\nimport { earn } from './player'\nimport { replicateEvent } from './replication'\n\n/**\n * The rules the engine brings along, written as hook handlers like any game module's. A module can leave any\n * of them out by id (`Rules.withoutHooks`), or put its own in place of one by giving a handler the same id.\n *\n * @beta\n */\nexport const coreHooks: HookDef[] = [\n\tdefineHook({\n\t\thook: 'canPlace',\n\t\tid: 'mapPathsClear',\n\t\trun(world, event) {\n\t\t\t// nothing is built on a path of the map that says so (`MapPath.keepClear`): a road that has to stay open\n\t\t\tif (event.cancelled) return\n\t\t\tconst { site } = event\n\t\t\tfor (const def of world.map.paths) {\n\t\t\t\tif (!def.keepClear) continue\n\t\t\t\tconst path = new Path(def.points, def.width)\n\t\t\t\tfor (let cz = Math.floor(site.z - site.hd); cz < Math.ceil(site.z + site.hd); cz++) {\n\t\t\t\t\tfor (let cx = Math.floor(site.x - site.hw); cx < Math.ceil(site.x + site.hw); cx++) {\n\t\t\t\t\t\tif (!path.containsCell(cx, cz)) continue\n\t\t\t\t\t\tevent.cancelled = true\n\t\t\t\t\t\tevent.reason = engineMessage('cannotBuildThere')\n\t\t\t\t\t\treturn\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'beforeDeath',\n\t\tid: 'undying',\n\t\trun(_world, event) {\n\t\t\t// what cannot die of damage is left standing with next to nothing\n\t\t\tif (!event.fromDamage || !event.entity.def.undying) return\n\t\t\tevent.cancelled = true\n\t\t\tevent.entity.health = Math.max(event.entity.health, 1)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'death',\n\t\tid: 'formEnds',\n\t\trun(world, { entity }) {\n\t\t\t// a hero in a form that ends with its death falls as itself, and is brought back as itself\n\t\t\tif (entity.get(form)?.back.includes('death')) leaveForm(world, entity, 'death')\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'death',\n\t\tid: 'loot',\n\t\trun(world, { entity, killer }) {\n\t\t\tif (killer && world.areEnemies(killer.owner, entity.owner) && !worthless(entity)) dropLoot(world, entity, killer)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'death',\n\t\tid: 'bounty',\n\t\trun(world, { entity, killer }) {\n\t\t\tconst { bounty } = entity.def\n\t\t\tconst { currency } = world.registry\n\t\t\tif (!bounty || !currency || !killer || !world.areEnemies(killer.owner, entity.owner) || worthless(entity)) return\n\t\t\tconst amount = world.rng.int(bounty[0], bounty[1])\n\t\t\tearn(world.player(killer.owner).resources, currency, amount)\n\t\t\tworld.events.emit(bountyEvent, { entity, player: killer.owner, amount })\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'afterDamage',\n\t\tid: 'onHit',\n\t\trun(world, { target, source, attack, dealt }) {\n\t\t\t// effects of an attack that hit and did not kill: a slow, a second strike... (counted and used up on a kill too)\n\t\t\tif (attack && source?.alive) attackLanded(world, source, target, dealt)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'afterDamage',\n\t\tid: 'triggers',\n\t\trun(world, event) {\n\t\t\t// what the hurt one's passives do (thorns, a shield at low health), its source's on an ability's hit, the buffs it breaks\n\t\t\tdamageTriggers(world, event)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'afterCast',\n\t\tid: 'onCast',\n\t\trun(world, { caster, ability, item, charged }) {\n\t\t\t// the caster's passives that react to its casts. What spends a charge does not count to the next one\n\t\t\tif (!item && !charged) castTriggers(world, caster, ability)\n\t\t\t// what breaks on a cast, but what the cast itself put on\n\t\t\tif (caster.alive && caster.buffs.length) breakBuffs(world, caster, 'cast', ability.id)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'death',\n\t\tid: 'onCarrierDeath',\n\t\trun(world, { entity }) {\n\t\t\t// what the buffs on the one who dies leave where it falls (Doom's demon), while it still stands there\n\t\t\tif (entity.buffs.length) carrierDied(world, entity)\n\t\t}\n\t}),\n\tdefineHook({\n\t\thook: 'afterDeath',\n\t\tid: 'onKill',\n\t\trun(world, { entity, killer, attack, carried }) {\n\t\t\tif (killer?.alive && world.areEnemies(killer.owner, entity.owner)) killTriggers(world, killer, entity, attack, carried)\n\t\t}\n\t}),\n\t...summonHooks,\n\t...garrisonHooks\n]\n\n/** A bounty, to whoever got it */\nexport const toldBounty = replicateEvent(bountyEvent, 'bounty', ({ entity, player, amount }, view) =>\n\tplayer === view.player ? { type: 'bounty', x: entity.pos.x, z: entity.pos.z, amount } : undefined\n)\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAmBA,IAAa,YAAuB;CACnC,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,OAAO;GAEjB,IAAI,MAAM,WAAW;GACrB,MAAM,EAAE,SAAS;GACjB,KAAK,MAAM,OAAO,MAAM,IAAI,OAAO;IAClC,IAAI,CAAC,IAAI,WAAW;IACpB,MAAM,OAAO,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK;IAC3C,KAAK,IAAI,KAAK,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,GAAG,KAAK,KAAK,KAAK,KAAK,IAAI,KAAK,EAAE,GAAG,MAC7E,KAAK,IAAI,KAAK,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,GAAG,KAAK,KAAK,KAAK,KAAK,IAAI,KAAK,EAAE,GAAG,MAAM;KACnF,IAAI,CAAC,KAAK,aAAa,IAAI,EAAE,GAAG;KAChC,MAAM,YAAY;KAClB,MAAM,SAAS,cAAc,kBAAkB;KAC/C;IACD;GAEF;EACD;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,QAAQ,OAAO;GAElB,IAAI,CAAC,MAAM,cAAc,CAAC,MAAM,OAAO,IAAI,SAAS;GACpD,MAAM,YAAY;GAClB,MAAM,OAAO,SAAS,KAAK,IAAI,MAAM,OAAO,QAAQ,CAAC;EACtD;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,UAAU;GAEtB,IAAI,OAAO,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,OAAO,GAAG,UAAU,OAAO,QAAQ,OAAO;EAC/E;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,QAAQ,UAAU;GAC9B,IAAI,UAAU,MAAM,WAAW,OAAO,OAAO,OAAO,KAAK,KAAK,CAAC,UAAU,MAAM,GAAG,SAAS,OAAO,QAAQ,MAAM;EACjH;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,QAAQ,UAAU;GAC9B,MAAM,EAAE,QAAA,aAAW,OAAO;GAC1B,MAAM,EAAE,aAAa,MAAM;GAC3B,IAAI,CAACA,YAAU,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,WAAW,OAAO,OAAO,OAAO,KAAK,KAAK,UAAU,MAAM,GAAG;GAC3G,MAAM,SAAS,MAAM,IAAI,IAAIA,SAAO,IAAIA,SAAO,EAAE;GACjD,KAAK,MAAM,OAAO,OAAO,KAAK,CAAC,CAAC,WAAW,UAAU,MAAM;GAC3D,MAAM,OAAO,KAAKC,QAAa;IAAE;IAAQ,QAAQ,OAAO;IAAO;GAAO,CAAC;EACxE;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,QAAQ,QAAQ,QAAQ,SAAS;GAE7C,IAAI,UAAU,QAAQ,OAAO,aAAa,OAAO,QAAQ,QAAQ,KAAK;EACvE;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,OAAO;GAEjB,eAAe,OAAO,KAAK;EAC5B;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,QAAQ,SAAS,MAAM,WAAW;GAE9C,IAAI,CAAC,QAAQ,CAAC,SAAS,aAAa,OAAO,QAAQ,OAAO;GAE1D,IAAI,OAAO,SAAS,OAAO,MAAM,QAAQ,WAAW,OAAO,QAAQ,QAAQ,QAAQ,EAAE;EACtF;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,UAAU;GAEtB,IAAI,OAAO,MAAM,QAAQ,YAAY,OAAO,MAAM;EACnD;CACD,CAAC;CACD,WAAW;EACV,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,EAAE,QAAQ,QAAQ,QAAQ,WAAW;GAC/C,IAAI,QAAQ,SAAS,MAAM,WAAW,OAAO,OAAO,OAAO,KAAK,GAAG,aAAa,OAAO,QAAQ,QAAQ,QAAQ,OAAO;EACvH;CACD,CAAC;CACD,GAAG;CACH,GAAG;AACJ;;AAGA,IAAa,aAAa,eAAeA,QAAa,WAAW,EAAE,QAAQ,QAAQ,UAAU,SAC5F,WAAW,KAAK,SAAS;CAAE,MAAM;CAAU,GAAG,OAAO,IAAI;CAAG,GAAG,OAAO,IAAI;CAAG;AAAO,IAAI,KAAA,CACzF"}

package/dist/fields.d.ts

@@ -34,7 +34,11 @@ export type Checked<F extends Fields> = {
 } & {
     [K in OptionalKeys<F>]?: Exclude<Out<F[K]>, undefined>;
 };
-/** @beta */
+/**
+ * The error a checker throws for a value that is not what was wanted; its message says where and what
+ *
+ * @beta
+ */
 export declare class Invalid extends Error {
 }
 /**
@@ -43,7 +47,11 @@ export declare class Invalid extends Error {
  * @beta
  */
 export declare const isObject: (value: unknown) => value is Record<string, unknown>;
-/** @beta */
+/**
+ * Checks a value is true or false and gives it, or throws `Invalid`
+ *
+ * @beta
+ */
 export declare const bool: Check<boolean>;
 /**
  * Any finite number
@@ -87,11 +95,23 @@ export declare const rgb: Check<[number, number, number]>;
  * @beta
  */
 export declare const list: Check<unknown[]>;
-/** @beta */
+/**
+ * Checks a value is text of at most 200 characters and gives it, or throws `Invalid`
+ *
+ * @beta
+ */
 export declare const string: Check<string>;
-/** @beta */
+/**
+ * Checks a value is a list of at most 1000 entity ids and gives it, or throws `Invalid`
+ *
+ * @beta
+ */
 export declare const ids: Check<number[]>;
-/** @beta */
+/**
+ * Checks a value is a point `{ x, z }` of numbers and gives it, or throws `Invalid`
+ *
+ * @beta
+ */
 export declare const point: Check<Vec2>;
 /**
  * What may be left out

package/dist/fields.js

@@ -0,0 +1,140 @@
+//#region src/fields.ts
+/**
+* The error a checker throws for a value that is not what was wanted; its message says where and what
+*
+* @beta
+*/
+var Invalid = class extends Error {};
+var fail = (path, wanted) => {
+	throw new Invalid(`${path} is ${wanted}`);
+};
+/**
+* Whether a value is a plain object (not a list, not null): what most of a file's fields are
+*
+* @beta
+*/
+var isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** The longest string accepted. Ids and names are short; nothing needs more */
+var MAX_STRING = 200;
+/** The most ids accepted in one list: more than anyone can select */
+var MAX_IDS = 1e3;
+/**
+* Checks a value is true or false and gives it, or throws `Invalid`
+*
+* @beta
+*/
+var bool = (value, path) => typeof value === "boolean" ? value : fail(path, "true or false");
+/**
+* Any finite number
+*
+* @beta
+*/
+var number = (value, path) => typeof value === "number" && Number.isFinite(value) ? value : fail(path, "a number");
+/**
+* A whole number, 0 or more
+*
+* @beta
+*/
+var index = (value, path) => Number.isInteger(value) && value >= 0 ? value : fail(path, "a whole number, 0 or more");
+/**
+* The id of an entity or a player
+*
+* @beta
+*/
+var id = (value, path) => Number.isInteger(value) && value >= 0 ? value : fail(path, "an id");
+/**
+* Any number of seconds: a finite number, not below 0
+*
+* @beta
+*/
+var seconds = (value, path) => {
+	const n = number(value, path);
+	return n >= 0 ? n : fail(path, "a number of seconds, not below 0");
+};
+/**
+* Words of any length: what a file says (a line of dialog, a name), not what a player sends (`string`)
+*
+* @beta
+*/
+var text = (value, path) => typeof value === "string" ? value : fail(path, "text");
+/**
+* A colour as the client draws it: `[r, g, b]`, each a number
+*
+* @beta
+*/
+var rgb = (value, path) => Array.isArray(value) && value.length === 3 && value.every((n) => typeof n === "number" && Number.isFinite(n)) ? [
+	value[0],
+	value[1],
+	value[2]
+] : fail(path, "a colour: [r, g, b]");
+/**
+* A list of anything, or none for one left out: each of its values checked by the caller, by its own path
+*
+* @beta
+*/
+var list = (value, path) => value === void 0 ? [] : Array.isArray(value) ? value : fail(path, "a list");
+/**
+* Checks a value is text of at most 200 characters and gives it, or throws `Invalid`
+*
+* @beta
+*/
+var string = (value, path) => typeof value === "string" && value.length <= MAX_STRING ? value : fail(path, `text of at most ${MAX_STRING} characters`);
+/**
+* Checks a value is a list of at most 1000 entity ids and gives it, or throws `Invalid`
+*
+* @beta
+*/
+var ids = (value, path) => {
+	if (!Array.isArray(value) || value.length > MAX_IDS) fail(path, `a list of at most ${MAX_IDS} ids`);
+	return value.map((item, i) => id(item, `${path}[${i}]`));
+};
+/**
+* Checks a value is a point `{ x, z }` of numbers and gives it, or throws `Invalid`
+*
+* @beta
+*/
+var point = (value, path) => {
+	if (typeof value !== "object" || value === null) fail(path, "a point: { x, z }");
+	const { x, z } = value;
+	return {
+		x: number(x, `${path}.x`),
+		z: number(z, `${path}.z`)
+	};
+};
+/**
+* What may be left out
+*
+* @beta
+*/
+function optional(check) {
+	return (value, path) => value === void 0 ? void 0 : check(value, path);
+}
+/**
+* One of a few fixed values
+*
+* @beta
+*/
+function oneOf(...values) {
+	return (value, path) => values.includes(value) ? value : fail(path, `one of ${values.join(", ")}`);
+}
+/**
+* An object with these fields. Fields that are not asked for are dropped, so nothing unchecked gets through
+*
+* @beta
+*/
+function object(fields) {
+	return (value, path) => {
+		if (typeof value !== "object" || value === null || Array.isArray(value)) fail(path, "an object");
+		const source = value;
+		const result = {};
+		for (const key in fields) {
+			const checked = fields[key](source[key], path ? `${path}.${key}` : key);
+			if (checked !== void 0) result[key] = checked;
+		}
+		return result;
+	};
+}
+//#endregion
+export { Invalid, bool, id, ids, index, isObject, list, number, object, oneOf, optional, point, rgb, seconds, string, text };
+
+//# sourceMappingURL=fields.js.map

package/dist/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","names":[],"sources":["../src/fields.ts"],"sourcesContent":["import type { Vec2 } from './math'\n\n/**\n * Checkers for what comes in from the outside, like the commands of a player. On a server that is whatever\n * anyone sends, so nothing is taken on trust: a checker either hands back the value as the type it promises,\n * or throws `Invalid` saying what is wrong with it, and where (`td.intro.lanes[2].items[0].at is a number`): the\n * commands of a player, a cinematic's file, a lane's own items and the game's other files are checked by these alike.\n *\n * ```ts\n * const fields = { building: id, unitType: string, queue: optional(bool) }\n * type Fields = Checked<typeof fields> // { building: number; unitType: string; queue?: boolean }\n * ```\n *\n * @beta\n */\nexport type Check<T> = (value: unknown, path: string) => T\n\n/**\n * A set of named checkers: what an object must have\n *\n * @beta\n */\nexport type Fields = Record<string, Check<unknown>>\n\ntype Out<C> = C extends Check<infer T> ? T : never\n/** The fields a checker lets be left out: the ones it may hand back `undefined` for */\ntype OptionalKeys<F extends Fields> = { [K in keyof F]: undefined extends Out<F[K]> ? K : never }[keyof F]\n\n/**\n * The type a set of checkers hands back. Fields that may be left out are optional\n *\n * @beta\n */\nexport type Checked<F extends Fields> = {\n\t[K in keyof F as K extends OptionalKeys<F> ? never : K]: Out<F[K]>\n} & {\n\t[K in OptionalKeys<F>]?: Exclude<Out<F[K]>, undefined>\n}\n\n/**\n * The error a checker throws for a value that is not what was wanted; its message says where and what\n *\n * @beta\n */\nexport class Invalid extends Error {}\n\nconst fail = (path: string, wanted: string): never => {\n\tthrow new Invalid(`${path} is ${wanted}`)\n}\n\n/**\n * Whether a value is a plain object (not a list, not null): what most of a file's fields are\n *\n * @beta\n */\nexport const isObject = (value: unknown): value is Record<string, unknown> => typeof value === 'object' && value !== null && !Array.isArray(value)\n\n/** The longest string accepted. Ids and names are short; nothing needs more */\nconst MAX_STRING = 200\n/** The most ids accepted in one list: more than anyone can select */\nconst MAX_IDS = 1000\n\n/**\n * Checks a value is true or false and gives it, or throws `Invalid`\n *\n * @beta\n */\nexport const bool: Check<boolean> = (value, path) => (typeof value === 'boolean' ? value : fail(path, 'true or false'))\n\n/**\n * Any finite number\n *\n * @beta\n */\nexport const number: Check<number> = (value, path) => (typeof value === 'number' && Number.isFinite(value) ? value : fail(path, 'a number'))\n\n/**\n * A whole number, 0 or more\n *\n * @beta\n */\nexport const index: Check<number> = (value, path) =>\n\tNumber.isInteger(value) && (value as number) >= 0 ? (value as number) : fail(path, 'a whole number, 0 or more')\n\n/**\n * The id of an entity or a player\n *\n * @beta\n */\nexport const id: Check<number> = (value, path) => (Number.isInteger(value) && (value as number) >= 0 ? (value as number) : fail(path, 'an id'))\n\n/**\n * Any number of seconds: a finite number, not below 0\n *\n * @beta\n */\nexport const seconds: Check<number> = (value, path) => {\n\tconst n = number(value, path)\n\treturn n >= 0 ? n : fail(path, 'a number of seconds, not below 0')\n}\n\n/**\n * Words of any length: what a file says (a line of dialog, a name), not what a player sends (`string`)\n *\n * @beta\n */\nexport const text: Check<string> = (value, path) => (typeof value === 'string' ? value : fail(path, 'text'))\n\n/**\n * A colour as the client draws it: `[r, g, b]`, each a number\n *\n * @beta\n */\nexport const rgb: Check<[number, number, number]> = (value, path) =>\n\tArray.isArray(value) && value.length === 3 && value.every((n) => typeof n === 'number' && Number.isFinite(n))\n\t\t? [value[0], value[1], value[2]]\n\t\t: fail(path, 'a colour: [r, g, b]')\n\n/**\n * A list of anything, or none for one left out: each of its values checked by the caller, by its own path\n *\n * @beta\n */\nexport const list: Check<unknown[]> = (value, path) => (value === undefined ? [] : Array.isArray(value) ? value : fail(path, 'a list'))\n\n/**\n * Checks a value is text of at most 200 characters and gives it, or throws `Invalid`\n *\n * @beta\n */\nexport const string: Check<string> = (value, path) =>\n\ttypeof value === 'string' && value.length <= MAX_STRING ? value : fail(path, `text of at most ${MAX_STRING} characters`)\n\n/**\n * Checks a value is a list of at most 1000 entity ids and gives it, or throws `Invalid`\n *\n * @beta\n */\nexport const ids: Check<number[]> = (value, path) => {\n\tif (!Array.isArray(value) || value.length > MAX_IDS) fail(path, `a list of at most ${MAX_IDS} ids`)\n\treturn (value as unknown[]).map((item, i) => id(item, `${path}[${i}]`))\n}\n\n/**\n * Checks a value is a point `{ x, z }` of numbers and gives it, or throws `Invalid`\n *\n * @beta\n */\nexport const point: Check<Vec2> = (value, path) => {\n\tif (typeof value !== 'object' || value === null) fail(path, 'a point: { x, z }')\n\tconst { x, z } = value as Record<string, unknown>\n\treturn { x: number(x, `${path}.x`), z: number(z, `${path}.z`) }\n}\n\n/**\n * What may be left out\n *\n * @beta\n */\nexport function optional<T>(check: Check<T>): Check<T | undefined> {\n\treturn (value, path) => (value === undefined ? undefined : check(value, path))\n}\n\n/**\n * One of a few fixed values\n *\n * @beta\n */\nexport function oneOf<const T extends readonly (string | number)[]>(...values: T): Check<T[number]> {\n\treturn (value, path) => (values.includes(value as T[number]) ? (value as T[number]) : fail(path, `one of ${values.join(', ')}`))\n}\n\n/**\n * An object with these fields. Fields that are not asked for are dropped, so nothing unchecked gets through\n *\n * @beta\n */\nexport function object<F extends Fields>(fields: F): Check<Checked<F>> {\n\treturn (value, path) => {\n\t\tif (typeof value !== 'object' || value === null || Array.isArray(value)) fail(path, 'an object')\n\t\tconst source = value as Record<string, unknown>\n\t\tconst result: Record<string, unknown> = {}\n\t\tfor (const key in fields) {\n\t\t\tconst checked = fields[key](source[key], path ? `${path}.${key}` : key)\n\t\t\tif (checked !== undefined) result[key] = checked\n\t\t}\n\t\treturn result as Checked<F>\n\t}\n}\n"],"mappings":";;;;;;AA4CA,IAAa,UAAb,cAA6B,MAAM,CAAC;AAEpC,IAAM,QAAQ,MAAc,WAA0B;CACrD,MAAM,IAAI,QAAQ,GAAG,KAAK,MAAM,QAAQ;AACzC;;;;;;AAOA,IAAa,YAAY,UAAqD,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;;AAGjJ,IAAM,aAAa;;AAEnB,IAAM,UAAU;;;;;;AAOhB,IAAa,QAAwB,OAAO,SAAU,OAAO,UAAU,YAAY,QAAQ,KAAK,MAAM,eAAe;;;;;;AAOrH,IAAa,UAAyB,OAAO,SAAU,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,IAAI,QAAQ,KAAK,MAAM,UAAU;;;;;;AAO1I,IAAa,SAAwB,OAAO,SAC3C,OAAO,UAAU,KAAK,KAAM,SAAoB,IAAK,QAAmB,KAAK,MAAM,2BAA2B;;;;;;AAO/G,IAAa,MAAqB,OAAO,SAAU,OAAO,UAAU,KAAK,KAAM,SAAoB,IAAK,QAAmB,KAAK,MAAM,OAAO;;;;;;AAO7I,IAAa,WAA0B,OAAO,SAAS;CACtD,MAAM,IAAI,OAAO,OAAO,IAAI;CAC5B,OAAO,KAAK,IAAI,IAAI,KAAK,MAAM,kCAAkC;AAClE;;;;;;AAOA,IAAa,QAAuB,OAAO,SAAU,OAAO,UAAU,WAAW,QAAQ,KAAK,MAAM,MAAM;;;;;;AAO1G,IAAa,OAAwC,OAAO,SAC3D,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,KAAK,MAAM,OAAO,MAAM,OAAO,MAAM,YAAY,OAAO,SAAS,CAAC,CAAC,IACzG;CAAC,MAAM;CAAI,MAAM;CAAI,MAAM;AAAE,IAC7B,KAAK,MAAM,qBAAqB;;;;;;AAOpC,IAAa,QAA0B,OAAO,SAAU,UAAU,KAAA,IAAY,CAAC,IAAI,MAAM,QAAQ,KAAK,IAAI,QAAQ,KAAK,MAAM,QAAQ;;;;;;AAOrI,IAAa,UAAyB,OAAO,SAC5C,OAAO,UAAU,YAAY,MAAM,UAAU,aAAa,QAAQ,KAAK,MAAM,mBAAmB,WAAW,YAAY;;;;;;AAOxH,IAAa,OAAwB,OAAO,SAAS;CACpD,IAAI,CAAC,MAAM,QAAQ,KAAK,KAAK,MAAM,SAAS,SAAS,KAAK,MAAM,qBAAqB,QAAQ,KAAK;CAClG,OAAQ,MAAoB,KAAK,MAAM,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,EAAE,EAAE,CAAC;AACvE;;;;;;AAOA,IAAa,SAAsB,OAAO,SAAS;CAClD,IAAI,OAAO,UAAU,YAAY,UAAU,MAAM,KAAK,MAAM,mBAAmB;CAC/E,MAAM,EAAE,GAAG,MAAM;CACjB,OAAO;EAAE,GAAG,OAAO,GAAG,GAAG,KAAK,GAAG;EAAG,GAAG,OAAO,GAAG,GAAG,KAAK,GAAG;CAAE;AAC/D;;;;;;AAOA,SAAgB,SAAY,OAAuC;CAClE,QAAQ,OAAO,SAAU,UAAU,KAAA,IAAY,KAAA,IAAY,MAAM,OAAO,IAAI;AAC7E;;;;;;AAOA,SAAgB,MAAoD,GAAG,QAA6B;CACnG,QAAQ,OAAO,SAAU,OAAO,SAAS,KAAkB,IAAK,QAAsB,KAAK,MAAM,UAAU,OAAO,KAAK,IAAI,GAAG;AAC/H;;;;;;AAOA,SAAgB,OAAyB,QAA8B;CACtE,QAAQ,OAAO,SAAS;EACvB,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,QAAQ,KAAK,GAAG,KAAK,MAAM,WAAW;EAC/F,MAAM,SAAS;EACf,MAAM,SAAkC,CAAC;EACzC,KAAK,MAAM,OAAO,QAAQ;GACzB,MAAM,UAAU,OAAO,IAAI,CAAC,OAAO,MAAM,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG;GACtE,IAAI,YAAY,KAAA,GAAW,OAAO,OAAO;EAC1C;EACA,OAAO;CACR;AACD"}