@v12-engine/engine 0.1.0 → 0.4.0

package/dist/fixture.d.ts

@@ -1,13 +1,13 @@
-import type { GameModule } from './game';
+import type { Rules } from './game';
 import { type GameMap } from './map';
 /**
  * The fixture game (see the top of this file): every role of the kit, with round numbers. Gold and lumber, 1000 of each
- * to start with; a hall and five workers at each start; heroes on (`withHeroes`); no fog explored at the start. A new
+ * to start with; a hall and five workers at each start; heroes on (`heroesPack`); no fog explored at the start. A new
  * one each time, for a test to change
  *
  * @beta
  */
-export declare function fixtureGame(): GameModule;
+export declare function fixtureGame(): Rules;
 /**
  * A map of the fixture game, 64 cells a side: two players, starting at opposite corners (12, 12 and 52, 52), a gold
  * mine and a row of trees by each start, and a camp of three creeps in the middle

package/dist/fixture.js

@@ -0,0 +1,512 @@
+import { dist } from "./math.js";
+import { createMap } from "./map/types.js";
+import { heroesPack } from "./packs/heroes/index.js";
+//#region src/fixture.ts
+var worker = {
+	id: "worker",
+	name: "Worker",
+	kind: "unit",
+	radius: .4,
+	stats: {
+		health: 100,
+		attackDamage: 5,
+		attackSpeed: 1,
+		attackRange: .5,
+		moveSpeed: 4
+	},
+	sight: 8,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 0,
+		targets: ["unit", "building"]
+	}],
+	cost: { gold: 50 },
+	supply: 1,
+	buildTime: 10,
+	harvester: {
+		capacity: 10,
+		gatherTime: 1
+	},
+	builds: [
+		"hall",
+		"supply",
+		"barracks",
+		"tower",
+		"altar"
+	]
+};
+var soldier = {
+	id: "soldier",
+	name: "Soldier",
+	kind: "unit",
+	radius: .45,
+	stats: {
+		health: 200,
+		attackDamage: 10,
+		attackSpeed: 1,
+		attackRange: .5,
+		armor: 10,
+		moveSpeed: 4
+	},
+	sight: 10,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 8
+	}],
+	cost: { gold: 100 },
+	supply: 2,
+	buildTime: 10,
+	abilities: ["guard"]
+};
+var archer = {
+	id: "archer",
+	name: "Archer",
+	kind: "unit",
+	radius: .45,
+	stats: {
+		health: 100,
+		attackDamage: 10,
+		attackSpeed: 1,
+		attackRange: 6,
+		moveSpeed: 4
+	},
+	sight: 10,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 8,
+		projectileSpeed: 20,
+		targets: ["ground", "air"]
+	}],
+	cost: {
+		gold: 100,
+		lumber: 20
+	},
+	supply: 2,
+	buildTime: 10
+};
+var hero = {
+	id: "hero",
+	name: "Hero",
+	kind: "unit",
+	radius: .5,
+	stats: {
+		health: 300,
+		mana: 100,
+		manaRegen: 1,
+		attackDamage: 20,
+		attackSpeed: 1,
+		attackRange: .5,
+		armor: 10,
+		moveSpeed: 4
+	},
+	sight: 12,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 8
+	}],
+	hero: {
+		growth: { stats: {
+			health: 20,
+			mana: 10,
+			attackDamage: 2
+		} },
+		learns: ["heal", "guard"]
+	},
+	inventory: 6,
+	cost: {
+		gold: 400,
+		lumber: 100
+	},
+	supply: 5,
+	buildTime: 40
+};
+var creep = {
+	id: "creep",
+	name: "Creep",
+	kind: "unit",
+	radius: .45,
+	stats: {
+		health: 200,
+		attackDamage: 10,
+		attackSpeed: 1,
+		attackRange: .5,
+		moveSpeed: 3
+	},
+	sight: 8,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 5
+	}],
+	level: 1,
+	bounty: [10, 10],
+	xp: 20
+};
+var hall = {
+	id: "hall",
+	name: "Hall",
+	kind: "building",
+	radius: 2,
+	footprint: {
+		w: 4,
+		d: 4
+	},
+	stats: {
+		health: 1500,
+		armor: 10
+	},
+	sight: 12,
+	cost: {
+		gold: 400,
+		lumber: 200
+	},
+	buildTime: 40,
+	supplyGiven: 10,
+	trains: ["worker"],
+	dropOff: true,
+	upgradesTo: "keep"
+};
+var keep = {
+	...hall,
+	id: "keep",
+	name: "Keep",
+	stats: {
+		health: 2e3,
+		armor: 10
+	},
+	cost: {
+		gold: 300,
+		lumber: 200
+	},
+	provides: ["hall"],
+	upgradesTo: void 0
+};
+var supply = {
+	id: "supply",
+	name: "Supply",
+	kind: "building",
+	radius: 1,
+	footprint: {
+		w: 2,
+		d: 2
+	},
+	stats: {
+		health: 500,
+		armor: 10
+	},
+	sight: 6,
+	cost: { gold: 50 },
+	buildTime: 10,
+	supplyGiven: 10
+};
+var barracks = {
+	id: "barracks",
+	name: "Barracks",
+	kind: "building",
+	radius: 1.5,
+	footprint: {
+		w: 3,
+		d: 3
+	},
+	stats: {
+		health: 1e3,
+		armor: 10
+	},
+	sight: 9,
+	cost: {
+		gold: 150,
+		lumber: 50
+	},
+	buildTime: 20,
+	trains: ["soldier", "archer"],
+	researches: ["armour"]
+};
+var tower = {
+	id: "tower",
+	name: "Tower",
+	kind: "building",
+	radius: 1,
+	footprint: {
+		w: 2,
+		d: 2
+	},
+	stats: {
+		health: 500,
+		attackDamage: 20,
+		attackSpeed: 1,
+		attackRange: 8,
+		armor: 10
+	},
+	sight: 12,
+	attacks: [{
+		damagePoint: .3,
+		acquisitionRange: 8,
+		projectileSpeed: 20,
+		targets: ["ground", "air"]
+	}],
+	cost: {
+		gold: 100,
+		lumber: 50
+	},
+	buildTime: 20,
+	requires: ["barracks"]
+};
+var altar = {
+	id: "altar",
+	name: "Altar",
+	kind: "building",
+	radius: 1.5,
+	footprint: {
+		w: 3,
+		d: 3
+	},
+	stats: {
+		health: 1e3,
+		armor: 10
+	},
+	sight: 9,
+	cost: {
+		gold: 200,
+		lumber: 50
+	},
+	buildTime: 30,
+	trains: ["hero"],
+	revives: true
+};
+var mine = {
+	id: "mine",
+	name: "Mine",
+	kind: "resource",
+	radius: 2,
+	footprint: {
+		w: 4,
+		d: 4
+	},
+	stats: { health: 1 },
+	sight: 0,
+	invulnerable: true,
+	resource: {
+		id: "gold",
+		amount: 1e4,
+		slots: 1,
+		entered: true
+	}
+};
+var tree = {
+	id: "tree",
+	name: "Tree",
+	kind: "resource",
+	radius: .5,
+	footprint: {
+		w: 1,
+		d: 1
+	},
+	stats: { health: 1 },
+	sight: 0,
+	invulnerable: true,
+	fellable: true,
+	resource: {
+		id: "lumber",
+		amount: 50,
+		slots: 1,
+		gatherTime: 5
+	}
+};
+var armour = {
+	id: "armour",
+	name: "Armour",
+	description: "+10 armor for soldiers and archers",
+	cost: {
+		gold: 100,
+		lumber: 50
+	},
+	researchTime: 20,
+	maxLevel: 2,
+	effects: [{
+		units: ["soldier", "archer"],
+		stats: { armor: 10 }
+	}]
+};
+var guarded = {
+	id: "guarded",
+	name: "Guarded",
+	description: "+20 armor",
+	duration: 10,
+	stats: { armor: 20 }
+};
+var abilities = [
+	{
+		id: "heal",
+		name: "Heal",
+		description: "Heals a friendly unit for 100 or 200",
+		target: "unit",
+		targets: {
+			allies: true,
+			self: false
+		},
+		manaCost: 10,
+		cooldown: 5,
+		range: 6,
+		effects: [{
+			type: "heal",
+			amount: [100, 200]
+		}]
+	},
+	{
+		id: "guard",
+		name: "Guard",
+		description: "+20 armor for 10 seconds",
+		target: "none",
+		cooldown: 10,
+		effects: [{
+			type: "buff",
+			buff: "guarded",
+			on: "caster"
+		}]
+	},
+	{
+		id: "drink",
+		name: "Drink",
+		description: "Heals 100",
+		target: "none",
+		cooldown: 10,
+		effects: [{
+			type: "heal",
+			amount: 100,
+			on: "caster"
+		}]
+	}
+];
+var items = [{
+	id: "sword",
+	name: "Sword",
+	description: "+10 attack damage",
+	tier: "basic",
+	cost: { gold: 100 },
+	bonus: { stats: { attackDamage: 10 } }
+}, {
+	id: "potion",
+	name: "Potion",
+	description: "Heals 100 when drunk",
+	tier: "consumable",
+	cost: { gold: 50 },
+	charges: 1,
+	ability: "drink"
+}];
+/** A hall where a player starts, and five workers on the side of the closest mine */
+function placeStartingBase(world, player, at) {
+	const base = world.spawn("hall", player, at);
+	let closest;
+	for (const entity of world.entities.values()) {
+		if (entity.def.resource?.id !== "gold" || dist(entity.pos, base.pos) > 20) continue;
+		if (!closest || dist(entity.pos, base.pos) < dist(closest, base.pos)) closest = entity.pos;
+	}
+	const towards = closest ? {
+		x: Math.sign(closest.x - at.x),
+		z: Math.sign(closest.z - at.z)
+	} : {
+		x: 1,
+		z: 0
+	};
+	for (let i = 0; i < 5; i++) world.spawn("worker", player, {
+		x: at.x + towards.x * 4 + (i - 2) * towards.z,
+		z: at.z + towards.z * 4 + (i - 2) * towards.x
+	});
+}
+/**
+* The fixture game (see the top of this file): every role of the kit, with round numbers. Gold and lumber, 1000 of each
+* to start with; a hall and five workers at each start; heroes on (`heroesPack`); no fog explored at the start. A new
+* one each time, for a test to change
+*
+* @beta
+*/
+function fixtureGame() {
+	return {
+		id: "fixture",
+		name: "Fixture",
+		version: "1.0.0",
+		units: [
+			worker,
+			soldier,
+			archer,
+			hero,
+			creep,
+			hall,
+			keep,
+			supply,
+			barracks,
+			tower,
+			altar,
+			mine,
+			tree
+		].map((def) => structuredClone(def)),
+		upgrades: [structuredClone(armour)],
+		abilities: structuredClone(abilities),
+		buffs: [structuredClone(guarded)],
+		items: structuredClone(items),
+		resources: [{
+			id: "gold",
+			name: "Gold",
+			start: 1e3
+		}, {
+			id: "lumber",
+			name: "Lumber",
+			start: 1e3
+		}],
+		currency: "gold",
+		packs: [heroesPack()],
+		startingBase: { spawn: placeStartingBase }
+	};
+}
+/**
+* A map of the fixture game, 64 cells a side: two players, starting at opposite corners (12, 12 and 52, 52), a gold
+* mine and a row of trees by each start, and a camp of three creeps in the middle
+*
+* @beta
+*/
+function fixtureMap() {
+	const map = createMap({
+		name: "Fixture",
+		width: 64,
+		depth: 64,
+		game: "fixture"
+	});
+	map.players[0].start = {
+		x: 12,
+		z: 12
+	};
+	map.players[1].start = {
+		x: 52,
+		z: 52
+	};
+	let id = 1;
+	const object = (type, x, z) => map.objects.push({
+		id: id++,
+		type,
+		owner: 0,
+		x,
+		z,
+		facing: 0,
+		scale: 1
+	});
+	object("mine", 12, 22);
+	object("mine", 52, 42);
+	for (let i = 0; i < 6; i++) {
+		object("tree", 22.5 + i, 4.5);
+		object("tree", 36.5 + i, 59.5);
+	}
+	map.camps.push({
+		id: id++,
+		x: 32,
+		z: 32,
+		units: [
+			"creep",
+			"creep",
+			"creep"
+		]
+	});
+	return map;
+}
+//#endregion
+export { fixtureGame, fixtureMap };
+
+//# sourceMappingURL=fixture.js.map

package/dist/fixture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixture.js","names":[],"sources":["../src/fixture.ts"],"sourcesContent":["/**\n * The fixture game: the smallest game the engine's kit has a part for each of its roles in (a hall and its workers,\n * supply, a barracks of a fighter and an archer, a tower, an altar and a hero, a gold mine and trees, a creep, an\n * upgrade, abilities and items), for the engine's own tests and a game's. Its numbers are round (health 100 or 200,\n * damage 10, speed 4) so that what a test expects reads as what it means: a soldier hits an archer ten times\n */\nimport type { AbilityDef, BuffDef, ItemDef, UnitTypeDef, UpgradeDef } from './defs'\nimport type { Rules } from './game'\nimport { createMap, type GameMap } from './map'\nimport { dist, type Vec2 } from './math'\nimport { heroesPack } from './packs/heroes'\nimport type { PlayerId } from './entity'\nimport type { World } from './world'\n\nconst worker: UnitTypeDef = {\n\tid: 'worker',\n\tname: 'Worker',\n\tkind: 'unit',\n\tradius: 0.4,\n\tstats: { health: 100, attackDamage: 5, attackSpeed: 1, attackRange: 0.5, moveSpeed: 4 },\n\tsight: 8,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 0, targets: ['unit', 'building'] }],\n\tcost: { gold: 50 },\n\tsupply: 1,\n\tbuildTime: 10,\n\tharvester: { capacity: 10, gatherTime: 1 },\n\tbuilds: ['hall', 'supply', 'barracks', 'tower', 'altar']\n}\n\nconst soldier: UnitTypeDef = {\n\tid: 'soldier',\n\tname: 'Soldier',\n\tkind: 'unit',\n\tradius: 0.45,\n\tstats: { health: 200, attackDamage: 10, attackSpeed: 1, attackRange: 0.5, armor: 10, moveSpeed: 4 },\n\tsight: 10,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 8 }],\n\tcost: { gold: 100 },\n\tsupply: 2,\n\tbuildTime: 10,\n\tabilities: ['guard']\n}\n\nconst archer: UnitTypeDef = {\n\tid: 'archer',\n\tname: 'Archer',\n\tkind: 'unit',\n\tradius: 0.45,\n\tstats: { health: 100, attackDamage: 10, attackSpeed: 1, attackRange: 6, moveSpeed: 4 },\n\tsight: 10,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 8, projectileSpeed: 20, targets: ['ground', 'air'] }],\n\tcost: { gold: 100, lumber: 20 },\n\tsupply: 2,\n\tbuildTime: 10\n}\n\nconst hero: UnitTypeDef = {\n\tid: 'hero',\n\tname: 'Hero',\n\tkind: 'unit',\n\tradius: 0.5,\n\tstats: { health: 300, mana: 100, manaRegen: 1, attackDamage: 20, attackSpeed: 1, attackRange: 0.5, armor: 10, moveSpeed: 4 },\n\tsight: 12,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 8 }],\n\thero: { growth: { stats: { health: 20, mana: 10, attackDamage: 2 } }, learns: ['heal', 'guard'] },\n\tinventory: 6,\n\tcost: { gold: 400, lumber: 100 },\n\tsupply: 5,\n\tbuildTime: 40\n}\n\nconst creep: UnitTypeDef = {\n\tid: 'creep',\n\tname: 'Creep',\n\tkind: 'unit',\n\tradius: 0.45,\n\tstats: { health: 200, attackDamage: 10, attackSpeed: 1, attackRange: 0.5, moveSpeed: 3 },\n\tsight: 8,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 5 }],\n\tlevel: 1,\n\tbounty: [10, 10],\n\txp: 20\n}\n\nconst hall: UnitTypeDef = {\n\tid: 'hall',\n\tname: 'Hall',\n\tkind: 'building',\n\tradius: 2,\n\tfootprint: { w: 4, d: 4 },\n\tstats: { health: 1500, armor: 10 },\n\tsight: 12,\n\tcost: { gold: 400, lumber: 200 },\n\tbuildTime: 40,\n\tsupplyGiven: 10,\n\ttrains: ['worker'],\n\tdropOff: true,\n\tupgradesTo: 'keep'\n}\n\nconst keep: UnitTypeDef = {\n\t...hall,\n\tid: 'keep',\n\tname: 'Keep',\n\tstats: { health: 2000, armor: 10 },\n\tcost: { gold: 300, lumber: 200 },\n\tprovides: ['hall'],\n\tupgradesTo: undefined\n}\n\nconst supply: UnitTypeDef = {\n\tid: 'supply',\n\tname: 'Supply',\n\tkind: 'building',\n\tradius: 1,\n\tfootprint: { w: 2, d: 2 },\n\tstats: { health: 500, armor: 10 },\n\tsight: 6,\n\tcost: { gold: 50 },\n\tbuildTime: 10,\n\tsupplyGiven: 10\n}\n\nconst barracks: UnitTypeDef = {\n\tid: 'barracks',\n\tname: 'Barracks',\n\tkind: 'building',\n\tradius: 1.5,\n\tfootprint: { w: 3, d: 3 },\n\tstats: { health: 1000, armor: 10 },\n\tsight: 9,\n\tcost: { gold: 150, lumber: 50 },\n\tbuildTime: 20,\n\ttrains: ['soldier', 'archer'],\n\tresearches: ['armour']\n}\n\nconst tower: UnitTypeDef = {\n\tid: 'tower',\n\tname: 'Tower',\n\tkind: 'building',\n\tradius: 1,\n\tfootprint: { w: 2, d: 2 },\n\tstats: { health: 500, attackDamage: 20, attackSpeed: 1, attackRange: 8, armor: 10 },\n\tsight: 12,\n\tattacks: [{ damagePoint: 0.3, acquisitionRange: 8, projectileSpeed: 20, targets: ['ground', 'air'] }],\n\tcost: { gold: 100, lumber: 50 },\n\tbuildTime: 20,\n\trequires: ['barracks']\n}\n\nconst altar: UnitTypeDef = {\n\tid: 'altar',\n\tname: 'Altar',\n\tkind: 'building',\n\tradius: 1.5,\n\tfootprint: { w: 3, d: 3 },\n\tstats: { health: 1000, armor: 10 },\n\tsight: 9,\n\tcost: { gold: 200, lumber: 50 },\n\tbuildTime: 30,\n\ttrains: ['hero'],\n\trevives: true\n}\n\nconst mine: UnitTypeDef = {\n\tid: 'mine',\n\tname: 'Mine',\n\tkind: 'resource',\n\tradius: 2,\n\tfootprint: { w: 4, d: 4 },\n\tstats: { health: 1 },\n\tsight: 0,\n\tinvulnerable: true,\n\tresource: { id: 'gold', amount: 10000, slots: 1, entered: true }\n}\n\nconst tree: UnitTypeDef = {\n\tid: 'tree',\n\tname: 'Tree',\n\tkind: 'resource',\n\tradius: 0.5,\n\tfootprint: { w: 1, d: 1 },\n\tstats: { health: 1 },\n\tsight: 0,\n\tinvulnerable: true,\n\tfellable: true,\n\tresource: { id: 'lumber', amount: 50, slots: 1, gatherTime: 5 }\n}\n\nconst armour: UpgradeDef = {\n\tid: 'armour',\n\tname: 'Armour',\n\tdescription: '+10 armor for soldiers and archers',\n\tcost: { gold: 100, lumber: 50 },\n\tresearchTime: 20,\n\tmaxLevel: 2,\n\teffects: [{ units: ['soldier', 'archer'], stats: { armor: 10 } }]\n}\n\nconst guarded: BuffDef = { id: 'guarded', name: 'Guarded', description: '+20 armor', duration: 10, stats: { armor: 20 } }\n\nconst abilities: AbilityDef[] = [\n\t{\n\t\tid: 'heal',\n\t\tname: 'Heal',\n\t\tdescription: 'Heals a friendly unit for 100 or 200',\n\t\ttarget: 'unit',\n\t\ttargets: { allies: true, self: false },\n\t\tmanaCost: 10,\n\t\tcooldown: 5,\n\t\trange: 6,\n\t\teffects: [{ type: 'heal', amount: [100, 200] }]\n\t},\n\t{\n\t\tid: 'guard',\n\t\tname: 'Guard',\n\t\tdescription: '+20 armor for 10 seconds',\n\t\ttarget: 'none',\n\t\tcooldown: 10,\n\t\teffects: [{ type: 'buff', buff: 'guarded', on: 'caster' }]\n\t},\n\t{ id: 'drink', name: 'Drink', description: 'Heals 100', target: 'none', cooldown: 10, effects: [{ type: 'heal', amount: 100, on: 'caster' }] }\n]\n\nconst items: ItemDef[] = [\n\t{ id: 'sword', name: 'Sword', description: '+10 attack damage', tier: 'basic', cost: { gold: 100 }, bonus: { stats: { attackDamage: 10 } } },\n\t{ id: 'potion', name: 'Potion', description: 'Heals 100 when drunk', tier: 'consumable', cost: { gold: 50 }, charges: 1, ability: 'drink' }\n]\n\n/** A hall where a player starts, and five workers on the side of the closest mine */\nfunction placeStartingBase(world: World, player: PlayerId, at: Vec2): void {\n\tconst base = world.spawn('hall', player, at)\n\tlet closest: Vec2 | undefined\n\tfor (const entity of world.entities.values()) {\n\t\tif (entity.def.resource?.id !== 'gold' || dist(entity.pos, base.pos) > 20) continue\n\t\tif (!closest || dist(entity.pos, base.pos) < dist(closest, base.pos)) closest = entity.pos\n\t}\n\tconst towards = closest ? { x: Math.sign(closest.x - at.x), z: Math.sign(closest.z - at.z) } : { x: 1, z: 0 }\n\tfor (let i = 0; i < 5; i++)\n\t\tworld.spawn('worker', player, { x: at.x + towards.x * 4 + (i - 2) * towards.z, z: at.z + towards.z * 4 + (i - 2) * towards.x })\n}\n\n/**\n * The fixture game (see the top of this file): every role of the kit, with round numbers. Gold and lumber, 1000 of each\n * to start with; a hall and five workers at each start; heroes on (`heroesPack`); no fog explored at the start. A new\n * one each time, for a test to change\n *\n * @beta\n */\nexport function fixtureGame(): Rules {\n\treturn {\n\t\tid: 'fixture',\n\t\tname: 'Fixture',\n\t\tversion: '1.0.0',\n\t\tunits: [worker, soldier, archer, hero, creep, hall, keep, supply, barracks, tower, altar, mine, tree].map((def) => structuredClone(def)),\n\t\tupgrades: [structuredClone(armour)],\n\t\tabilities: structuredClone(abilities),\n\t\tbuffs: [structuredClone(guarded)],\n\t\titems: structuredClone(items),\n\t\tresources: [\n\t\t\t{ id: 'gold', name: 'Gold', start: 1000 },\n\t\t\t{ id: 'lumber', name: 'Lumber', start: 1000 }\n\t\t],\n\t\tcurrency: 'gold',\n\t\tpacks: [heroesPack()],\n\t\tstartingBase: { spawn: placeStartingBase }\n\t}\n}\n\n/**\n * A map of the fixture game, 64 cells a side: two players, starting at opposite corners (12, 12 and 52, 52), a gold\n * mine and a row of trees by each start, and a camp of three creeps in the middle\n *\n * @beta\n */\nexport function fixtureMap(): GameMap {\n\tconst map = createMap({ name: 'Fixture', width: 64, depth: 64, game: 'fixture' })\n\tmap.players[0].start = { x: 12, z: 12 }\n\tmap.players[1].start = { x: 52, z: 52 }\n\tlet id = 1\n\tconst object = (type: string, x: number, z: number) => map.objects.push({ id: id++, type, owner: 0, x, z, facing: 0, scale: 1 })\n\tobject('mine', 12, 22)\n\tobject('mine', 52, 42)\n\tfor (let i = 0; i < 6; i++) {\n\t\tobject('tree', 22.5 + i, 4.5)\n\t\tobject('tree', 36.5 + i, 59.5)\n\t}\n\tmap.camps.push({ id: id++, x: 32, z: 32, units: ['creep', 'creep', 'creep'] })\n\treturn map\n}\n"],"mappings":";;;;AAcA,IAAM,SAAsB;CAC3B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,OAAO;EAAE,QAAQ;EAAK,cAAc;EAAG,aAAa;EAAG,aAAa;EAAK,WAAW;CAAE;CACtF,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;EAAG,SAAS,CAAC,QAAQ,UAAU;CAAE,CAAC;CAClF,MAAM,EAAE,MAAM,GAAG;CACjB,QAAQ;CACR,WAAW;CACX,WAAW;EAAE,UAAU;EAAI,YAAY;CAAE;CACzC,QAAQ;EAAC;EAAQ;EAAU;EAAY;EAAS;CAAO;AACxD;AAEA,IAAM,UAAuB;CAC5B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,OAAO;EAAE,QAAQ;EAAK,cAAc;EAAI,aAAa;EAAG,aAAa;EAAK,OAAO;EAAI,WAAW;CAAE;CAClG,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;CAAE,CAAC;CACnD,MAAM,EAAE,MAAM,IAAI;CAClB,QAAQ;CACR,WAAW;CACX,WAAW,CAAC,OAAO;AACpB;AAEA,IAAM,SAAsB;CAC3B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,OAAO;EAAE,QAAQ;EAAK,cAAc;EAAI,aAAa;EAAG,aAAa;EAAG,WAAW;CAAE;CACrF,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;EAAG,iBAAiB;EAAI,SAAS,CAAC,UAAU,KAAK;CAAE,CAAC;CACpG,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAG;CAC9B,QAAQ;CACR,WAAW;AACZ;AAEA,IAAM,OAAoB;CACzB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,OAAO;EAAE,QAAQ;EAAK,MAAM;EAAK,WAAW;EAAG,cAAc;EAAI,aAAa;EAAG,aAAa;EAAK,OAAO;EAAI,WAAW;CAAE;CAC3H,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;CAAE,CAAC;CACnD,MAAM;EAAE,QAAQ,EAAE,OAAO;GAAE,QAAQ;GAAI,MAAM;GAAI,cAAc;EAAE,EAAE;EAAG,QAAQ,CAAC,QAAQ,OAAO;CAAE;CAChG,WAAW;CACX,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAI;CAC/B,QAAQ;CACR,WAAW;AACZ;AAEA,IAAM,QAAqB;CAC1B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,OAAO;EAAE,QAAQ;EAAK,cAAc;EAAI,aAAa;EAAG,aAAa;EAAK,WAAW;CAAE;CACvF,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;CAAE,CAAC;CACnD,OAAO;CACP,QAAQ,CAAC,IAAI,EAAE;CACf,IAAI;AACL;AAEA,IAAM,OAAoB;CACzB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO;EAAE,QAAQ;EAAM,OAAO;CAAG;CACjC,OAAO;CACP,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAI;CAC/B,WAAW;CACX,aAAa;CACb,QAAQ,CAAC,QAAQ;CACjB,SAAS;CACT,YAAY;AACb;AAEA,IAAM,OAAoB;CACzB,GAAG;CACH,IAAI;CACJ,MAAM;CACN,OAAO;EAAE,QAAQ;EAAM,OAAO;CAAG;CACjC,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAI;CAC/B,UAAU,CAAC,MAAM;CACjB,YAAY,KAAA;AACb;AAEA,IAAM,SAAsB;CAC3B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO;EAAE,QAAQ;EAAK,OAAO;CAAG;CAChC,OAAO;CACP,MAAM,EAAE,MAAM,GAAG;CACjB,WAAW;CACX,aAAa;AACd;AAEA,IAAM,WAAwB;CAC7B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO;EAAE,QAAQ;EAAM,OAAO;CAAG;CACjC,OAAO;CACP,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAG;CAC9B,WAAW;CACX,QAAQ,CAAC,WAAW,QAAQ;CAC5B,YAAY,CAAC,QAAQ;AACtB;AAEA,IAAM,QAAqB;CAC1B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO;EAAE,QAAQ;EAAK,cAAc;EAAI,aAAa;EAAG,aAAa;EAAG,OAAO;CAAG;CAClF,OAAO;CACP,SAAS,CAAC;EAAE,aAAa;EAAK,kBAAkB;EAAG,iBAAiB;EAAI,SAAS,CAAC,UAAU,KAAK;CAAE,CAAC;CACpG,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAG;CAC9B,WAAW;CACX,UAAU,CAAC,UAAU;AACtB;AAEA,IAAM,QAAqB;CAC1B,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO;EAAE,QAAQ;EAAM,OAAO;CAAG;CACjC,OAAO;CACP,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAG;CAC9B,WAAW;CACX,QAAQ,CAAC,MAAM;CACf,SAAS;AACV;AAEA,IAAM,OAAoB;CACzB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO,EAAE,QAAQ,EAAE;CACnB,OAAO;CACP,cAAc;CACd,UAAU;EAAE,IAAI;EAAQ,QAAQ;EAAO,OAAO;EAAG,SAAS;CAAK;AAChE;AAEA,IAAM,OAAoB;CACzB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,QAAQ;CACR,WAAW;EAAE,GAAG;EAAG,GAAG;CAAE;CACxB,OAAO,EAAE,QAAQ,EAAE;CACnB,OAAO;CACP,cAAc;CACd,UAAU;CACV,UAAU;EAAE,IAAI;EAAU,QAAQ;EAAI,OAAO;EAAG,YAAY;CAAE;AAC/D;AAEA,IAAM,SAAqB;CAC1B,IAAI;CACJ,MAAM;CACN,aAAa;CACb,MAAM;EAAE,MAAM;EAAK,QAAQ;CAAG;CAC9B,cAAc;CACd,UAAU;CACV,SAAS,CAAC;EAAE,OAAO,CAAC,WAAW,QAAQ;EAAG,OAAO,EAAE,OAAO,GAAG;CAAE,CAAC;AACjE;AAEA,IAAM,UAAmB;CAAE,IAAI;CAAW,MAAM;CAAW,aAAa;CAAa,UAAU;CAAI,OAAO,EAAE,OAAO,GAAG;AAAE;AAExH,IAAM,YAA0B;CAC/B;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,SAAS;GAAE,QAAQ;GAAM,MAAM;EAAM;EACrC,UAAU;EACV,UAAU;EACV,OAAO;EACP,SAAS,CAAC;GAAE,MAAM;GAAQ,QAAQ,CAAC,KAAK,GAAG;EAAE,CAAC;CAC/C;CACA;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,UAAU;EACV,SAAS,CAAC;GAAE,MAAM;GAAQ,MAAM;GAAW,IAAI;EAAS,CAAC;CAC1D;CACA;EAAE,IAAI;EAAS,MAAM;EAAS,aAAa;EAAa,QAAQ;EAAQ,UAAU;EAAI,SAAS,CAAC;GAAE,MAAM;GAAQ,QAAQ;GAAK,IAAI;EAAS,CAAC;CAAE;AAC9I;AAEA,IAAM,QAAmB,CACxB;CAAE,IAAI;CAAS,MAAM;CAAS,aAAa;CAAqB,MAAM;CAAS,MAAM,EAAE,MAAM,IAAI;CAAG,OAAO,EAAE,OAAO,EAAE,cAAc,GAAG,EAAE;AAAE,GAC3I;CAAE,IAAI;CAAU,MAAM;CAAU,aAAa;CAAwB,MAAM;CAAc,MAAM,EAAE,MAAM,GAAG;CAAG,SAAS;CAAG,SAAS;AAAQ,CAC3I;;AAGA,SAAS,kBAAkB,OAAc,QAAkB,IAAgB;CAC1E,MAAM,OAAO,MAAM,MAAM,QAAQ,QAAQ,EAAE;CAC3C,IAAI;CACJ,KAAK,MAAM,UAAU,MAAM,SAAS,OAAO,GAAG;EAC7C,IAAI,OAAO,IAAI,UAAU,OAAO,UAAU,KAAK,OAAO,KAAK,KAAK,GAAG,IAAI,IAAI;EAC3E,IAAI,CAAC,WAAW,KAAK,OAAO,KAAK,KAAK,GAAG,IAAI,KAAK,SAAS,KAAK,GAAG,GAAG,UAAU,OAAO;CACxF;CACA,MAAM,UAAU,UAAU;EAAE,GAAG,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC;EAAG,GAAG,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC;CAAE,IAAI;EAAE,GAAG;EAAG,GAAG;CAAE;CAC5G,KAAK,IAAI,IAAI,GAAG,IAAI,GAAG,KACtB,MAAM,MAAM,UAAU,QAAQ;EAAE,GAAG,GAAG,IAAI,QAAQ,IAAI,KAAK,IAAI,KAAK,QAAQ;EAAG,GAAG,GAAG,IAAI,QAAQ,IAAI,KAAK,IAAI,KAAK,QAAQ;CAAE,CAAC;AAChI;;;;;;;;AASA,SAAgB,cAAqB;CACpC,OAAO;EACN,IAAI;EACJ,MAAM;EACN,SAAS;EACT,OAAO;GAAC;GAAQ;GAAS;GAAQ;GAAM;GAAO;GAAM;GAAM;GAAQ;GAAU;GAAO;GAAO;GAAM;EAAI,CAAC,CAAC,KAAK,QAAQ,gBAAgB,GAAG,CAAC;EACvI,UAAU,CAAC,gBAAgB,MAAM,CAAC;EAClC,WAAW,gBAAgB,SAAS;EACpC,OAAO,CAAC,gBAAgB,OAAO,CAAC;EAChC,OAAO,gBAAgB,KAAK;EAC5B,WAAW,CACV;GAAE,IAAI;GAAQ,MAAM;GAAQ,OAAO;EAAK,GACxC;GAAE,IAAI;GAAU,MAAM;GAAU,OAAO;EAAK,CAC7C;EACA,UAAU;EACV,OAAO,CAAC,WAAW,CAAC;EACpB,cAAc,EAAE,OAAO,kBAAkB;CAC1C;AACD;;;;;;;AAQA,SAAgB,aAAsB;CACrC,MAAM,MAAM,UAAU;EAAE,MAAM;EAAW,OAAO;EAAI,OAAO;EAAI,MAAM;CAAU,CAAC;CAChF,IAAI,QAAQ,EAAE,CAAC,QAAQ;EAAE,GAAG;EAAI,GAAG;CAAG;CACtC,IAAI,QAAQ,EAAE,CAAC,QAAQ;EAAE,GAAG;EAAI,GAAG;CAAG;CACtC,IAAI,KAAK;CACT,MAAM,UAAU,MAAc,GAAW,MAAc,IAAI,QAAQ,KAAK;EAAE,IAAI;EAAM;EAAM,OAAO;EAAG;EAAG;EAAG,QAAQ;EAAG,OAAO;CAAE,CAAC;CAC/H,OAAO,QAAQ,IAAI,EAAE;CACrB,OAAO,QAAQ,IAAI,EAAE;CACrB,KAAK,IAAI,IAAI,GAAG,IAAI,GAAG,KAAK;EAC3B,OAAO,QAAQ,OAAO,GAAG,GAAG;EAC5B,OAAO,QAAQ,OAAO,GAAG,IAAI;CAC9B;CACA,IAAI,MAAM,KAAK;EAAE,IAAI;EAAM,GAAG;EAAI,GAAG;EAAI,OAAO;GAAC;GAAS;GAAS;EAAO;CAAE,CAAC;CAC7E,OAAO;AACR"}

package/dist/fog.d.ts

@@ -23,9 +23,15 @@ export interface FogSave {
     /** Whether the map is explored from the start, for the teams to come too (`FogOfWar.exploredFromStart`) */
     exploredFromStart?: true;
 }
-/** @beta */
+/**
+ * What each team sees and has seen of the map, by cell, and the bit each team has in `Entity.seenBy`
+ *
+ * @beta
+ */
 export declare class FogOfWar {
+    /** The map's width in cells */
     readonly width: number;
+    /** The map's depth in cells */
     readonly depth: number;
     private readonly visible;
     private readonly explored;
@@ -44,19 +50,28 @@ export declare class FogOfWar {
     private readonly lit;
     private readonly words;
     private updating;
+    /**
+     * Whether `lit` holds what each team sees now, as the grids do: from the end of an update until the grids are written
+     * otherwise (a reveal outside an update, a save taken back)
+     */
+    private litIsSight;
     /** The cells at or under each level, as bits: what a viewer on that level sees of what it lights. Made as they are first asked for */
     private readonly levelMasks;
     /** The highest level of the ground: a viewer on it or above sees everything it lights. -1 until worked out */
     private top;
     /** Bumped every time visibility is recomputed */
     version: number;
-    constructor(width: number, depth: number, teams: number[], 
+    constructor(
+    /** The map's width in cells */
+    width: number, 
+    /** The map's depth in cells */
+    depth: number, teams: number[], 
     /** Level of every cell: nobody sees up a cliff. All on the ground floor when left out */
     levels?: Uint8Array);
     /** Gives a team that has none yet fog of its own: a player moved to a new team mid-game. Nothing for one there is */
     addTeam(team: number): void;
     /**
-     * Whether the whole map is explored from the start (`FogRules.startExplored`, `MapDef.explored`): every team's, and
+     * Whether the whole map is explored from the start (`FogSettings.startExplored`, `MapDef.explored`): every team's, and
      * the teams' made from now on. What stands on it and is no player's is then known to every team from the first moment
      * (the sessions' `TeamMemory.startKnown`). Set with `exploreFromStart`
      */
@@ -67,17 +82,22 @@ export declare class FogOfWar {
     /** The team's bit in per-entity team masks. 0 for a team without fog (neutral), which then never shows up in one */
     /** What each team sees and has explored, for a save, with each team's bit */
     save(): FogSave;
+    /** Takes the fog back from a save, teams and revealed ones too; throws when a team's cells are missing or of another size */
     restore(save: FogSave): void;
+    /** The bit a team has in per-entity bitmasks such as `Entity.seenBy`; 0 for a team that is not known */
     teamBit(team: number): number;
+    /** The teams the fog holds cells for */
     get teams(): number[];
     /** Debug switch: the team sees everything */
     setRevealed(team: number, revealed: boolean): void;
+    /** Whether the team is shown everything (`setRevealed`) */
     isRevealed(team: number): boolean;
     /**
      * Starts working out what is seen: what is lit from here to `endUpdate` is collected as bits, and the grids
      * are written when it ends, so `visible` and `explored` say what they did before until then
      */
     beginUpdate(): void;
+    /** Ends the update begun by `beginUpdate`: writes what was lit into the grids, so that visibility changes at once */
     endUpdate(): void;
     /**
      * Says the ground's levels changed (`Terrain.levels` written to while the world runs): what a viewer on a level sees
@@ -90,8 +110,11 @@ export declare class FogOfWar {
     private maskOf;
     /** Lights up what a viewer at the point sees. Ground above the viewer's `level` stays dark, so a flyer passes Infinity */
     reveal(team: number, x: number, z: number, radius: number, level?: number): void;
+    /** The state of the cell at (x, z) for the team: `FOG_VISIBLE` when it is revealed, else visible, explored or unexplored */
     stateAt(team: number, x: number, z: number): number;
+    /** Whether the team sees the cell at (x, z) now */
     isVisible(team: number, x: number, z: number): boolean;
+    /** Whether the team has seen the cell at (x, z) at some time */
     isExplored(team: number, x: number, z: number): boolean;
     /** A team has seen every cell once: the map starts explored for it */
     exploreAll(team: number): void;