@v12-engine/engine 0.1.1 → 0.4.0

package/dist/spawning.js

@@ -0,0 +1,224 @@
+import { footprintOf, isScenery } from "./defs.js";
+import { constructionStarted, entitySpawned } from "./engineEvents.js";
+import { constructionSite } from "./systems/construction.js";
+import { Entity, deposit, fighting, moving } from "./entity.js";
+import { agentParamsOf } from "./navigation/agentParams.js";
+import { halt, setGhost } from "./systems/movement.js";
+import { dashing } from "./dashing.js";
+import { clearOrders } from "./orders/queue.js";
+import { resourceAt } from "./orders/build.js";
+//#region src/spawning.ts
+/**
+* How entities come into the world and are moved about in it, as the world's own part (`World.spawn`, `place`,
+* `setOwner`, `setHidden`, `setLifetime`): what a type is given as it is made, its place on the ground, the grid and the
+* ways, whose it is, whether it is inside something, how long it lasts. The world's methods are this.world part's
+*/
+var Spawning = class {
+	world;
+	constructor(world) {
+		this.world = world;
+	}
+	spawn(typeId, owner, position, options = {}) {
+		const def = this.world.registry.unit(typeId);
+		this.world.player(owner);
+		let pos = position;
+		let cell;
+		if (def.kind !== "unit") {
+			const fp = footprintOf(def);
+			cell = this.world.grid.cellFor(position.x, position.z, fp.w, fp.d);
+			pos = {
+				x: cell.x + fp.w / 2,
+				z: cell.z + fp.d / 2
+			};
+		} else pos = this.world.layerOf(def).closestPoint(position, 8) ?? position;
+		const entity = new Entity(this.world.newEntityId(), def, owner, pos);
+		entity.facing = entity.prevFacing = options.facing ?? 0;
+		const like = options.looksLike;
+		entity.scale = options.scale ?? like?.scale ?? 1;
+		entity.look = options.look ?? like?.look;
+		if (like) entity.likeness = like.likeness ? { ...like.likeness } : {
+			type: like.def.id,
+			owner: like.owner
+		};
+		entity.cell = cell;
+		entity.expireIn(options.lifetime ?? def.lifetime ?? null);
+		entity.lifetime = entity.expires ?? 0;
+		if (def.invisible) entity.unseenIn = def.invisible.after ?? 0;
+		if (def.uses) entity.health = entity.maxHealth = def.uses;
+		if (def.kind === "unit") {
+			const speed = def.stats.moveSpeed;
+			if (speed) {
+				entity.set(moving, {
+					speed,
+					status: "idle",
+					goal: {
+						x: pos.x,
+						z: pos.z
+					},
+					goalEntity: 0,
+					range: 0,
+					groupId: 0,
+					navGoal: {
+						x: pos.x,
+						z: pos.z
+					},
+					navVersion: 0,
+					corner: {
+						x: pos.x,
+						z: pos.z
+					},
+					bestDistance: 0,
+					stalledTime: 0,
+					anchored: false,
+					ghost: false,
+					finalFacing: null
+				});
+				this.world.nav.addAgent(entity.id, pos, agentParamsOf(entity, speed));
+			}
+		} else {
+			const fp = footprintOf(def);
+			this.world.grid.occupy(cell.x, cell.z, fp.w, fp.d, entity.id);
+			const under = resourceAt(this.world, def, pos);
+			if (under) {
+				under.get(deposit).under = entity.id;
+				entity.on = under.id;
+			}
+			if (!this.world.nav.addObstacle(entity.id, entity.rect) && !this.world.obstaclesRefused++) this.world.log.warn("navigation", `There is no room for another obstacle: ${def.id} does not block the way, nor what is put down after it while there is none`, { entity: entity.id });
+			if (def.resource) entity.set(deposit, {
+				amount: def.resource.amount,
+				occupants: 0
+			});
+			if (options.underConstruction) {
+				const site = typeof options.underConstruction === "object" ? options.underConstruction : {};
+				entity.set(constructionSite, {
+					progress: 0,
+					buildTime: site.buildTime ?? def.buildTime ?? 1,
+					builders: 0,
+					...site.paid && { paid: site.paid }
+				});
+				entity.health = Math.max(1, Math.round(entity.maxHealth * this.world.settings.production.constructionHealth));
+			}
+		}
+		entity.mana = Math.min(def.initialMana ?? entity.maxMana, entity.maxMana);
+		for (const id of def.abilities ?? []) entity.addAbility({
+			id,
+			level: 1,
+			cooldown: 0,
+			autocast: this.world.registry.ability(id).autocast ?? false
+		});
+		if (def.attacks?.length) entity.set(fighting, {
+			cooldown: 0,
+			swing: 0,
+			swingTarget: 0,
+			autoTarget: 0,
+			lastAttacker: 0,
+			guard: null,
+			passive: false
+		});
+		for (const part of this.world.registry.spawning) part.onSpawn(entity, this.world);
+		if (this.world.hooks.has("made")) this.world.hooks.run("made", entity);
+		for (const [id, value] of Object.entries(options.data ?? {})) {
+			const component = this.world.registry.component(id);
+			if (!component) throw new Error(`Cannot spawn ${typeId} with "${id}": the game has no component of that id`);
+			entity.set(component, value);
+		}
+		this.world.entities.set(entity.id, entity);
+		this.world.index.add(entity);
+		if (entity.isStructure) this.world.spatial.insertStatic(entity);
+		entity.setScenery(isScenery(def) && this.world.player(owner).neutral && !entity.has(constructionSite) && entity.expires === null);
+		if (!entity.scenery) this.world.units.set(entity.id, entity);
+		else for (const [team, inSight] of this.world.sceneryInSight) if (this.world.isVisibleTo(entity, team)) inSight.add(entity);
+		for (const [id, level] of this.world.player(owner).upgrades) this.world.registry.upgrade(id).apply?.(this.world, entity, level);
+		if (options.name) this.world.setName(entity, options.name);
+		this.world.hooks.run("spawn", entity);
+		this.world.events.emit(entitySpawned, entity);
+		if (entity.has(constructionSite)) this.world.events.emit(constructionStarted, entity);
+		return entity;
+	}
+	/**
+	* What its parts call off as an entity leaves its owner, dying or given away (`Component.onLeave`)
+	*
+	* @internal
+	*/
+	leave(entity) {
+		for (const part of this.world.registry.leaving) if (entity.has(part)) part.onLeave(entity, this.world);
+	}
+	/**
+	* Turns scenery into an actor, for good: something gave it a reason to be looked at every tick, like a buff
+	* that has to run out. Whatever does that to an entity calls this.world; the debug checks catch what forgets to.
+	* It joins `World.units` at the end, out of id order (see `World.units`), which a save keeps as it is
+	*/
+	wake(entity) {
+		if (!entity.scenery) return;
+		entity.setScenery(false);
+		this.world.units.set(entity.id, entity);
+	}
+	/** Puts a unit somewhere else, where it stands: the way through is not its concern. Structures stay where they were built */
+	place(entity, point) {
+		if (entity.isStructure) throw new Error(`${entity.def.id}#${entity.id} is a structure: it cannot be moved`);
+		entity.moveTo(point.x, point.z);
+		if (entity.get(moving) && !entity.hidden && !entity.get(dashing)?.height) this.world.nav.teleport(entity.id, point);
+	}
+	/**
+	* Gives an entity to another player, from now on in everything: whose it is, whom it fights, what it counts for.
+	* What it was doing is called off, and what it was making is given back to the one it belonged to
+	*/
+	setOwner(entity, owner) {
+		if (entity.owner === owner) return;
+		this.world.player(owner);
+		clearOrders(this.world, entity);
+		this.leave(entity);
+		if (entity.get(fighting)) Object.assign(entity.get(fighting), {
+			autoTarget: 0,
+			lastAttacker: 0,
+			guard: null
+		});
+		this.world.index.remove(entity);
+		entity.changeOwner(owner);
+		this.world.index.add(entity);
+		this.world.spatial.ownerChanged();
+		if (entity.scenery && !this.world.player(owner).neutral) this.wake(entity);
+	}
+	/**
+	* Takes a unit out of the world for a while, or puts it back: a worker inside a gold mine, a unit carried in
+	* something. While hidden it is not found, not seen and in nobody's way, and its orders wait. It comes back at
+	* `at`, or where it went in, on the nearest ground it can stand on. Structures cannot hide
+	*/
+	setHidden(entity, hidden, at) {
+		if (entity.hidden === hidden) return;
+		if (entity.isStructure) throw new Error(`${entity.def.id}#${entity.id} is a structure: it cannot hide`);
+		const m = entity.get(moving);
+		if (hidden) {
+			if (m) {
+				halt(this.world, entity);
+				this.world.nav.removeAgent(entity.id);
+			}
+			this.wake(entity);
+			entity.setInside(true);
+			return;
+		}
+		entity.setInside(false);
+		const point = this.world.navFor(entity).closestPoint(at ?? entity.pos, 8) ?? at ?? entity.pos;
+		entity.moveTo(point.x, point.z);
+		entity.prevPos.x = point.x;
+		entity.prevPos.z = point.z;
+		if (!m) return;
+		this.world.nav.addAgent(entity.id, point, agentParamsOf(entity, m.speed));
+		const { ghost } = m;
+		m.ghost = false;
+		delete m.phased;
+		m.anchored = false;
+		m.status = "idle";
+		setGhost(this.world, entity, ghost);
+	}
+	/** Gives an entity a time after which it is gone by itself, like a ward, or takes it away with `null` */
+	setLifetime(entity, seconds) {
+		if (seconds !== null) this.wake(entity);
+		entity.expireIn(seconds);
+		entity.lifetime = seconds ?? 0;
+	}
+};
+//#endregion
+export { Spawning };
+
+//# sourceMappingURL=spawning.js.map

package/dist/spawning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spawning.js","names":[],"sources":["../src/spawning.ts"],"sourcesContent":["import { constructionStarted, entitySpawned } from '#engine/engineEvents'\nimport { dashing } from './dashing'\nimport { footprintOf, isScenery } from './defs'\nimport { deposit, Entity, fighting, moving, type PlayerId } from './entity'\nimport type { Vec2 } from './math'\nimport { agentParamsOf } from './navigation/agentParams'\nimport { resourceAt } from './orders/build'\nimport { clearOrders } from './orders/queue'\nimport { constructionSite } from './systems/construction'\nimport { halt, setGhost } from './systems/movement'\nimport type { SpawnOptions, World } from './world'\n/**\n * How entities come into the world and are moved about in it, as the world's own part (`World.spawn`, `place`,\n * `setOwner`, `setHidden`, `setLifetime`): what a type is given as it is made, its place on the ground, the grid and the\n * ways, whose it is, whether it is inside something, how long it lasts. The world's methods are this.world part's\n */\nexport class Spawning {\n\tconstructor(private readonly world: World) {}\n\n\tspawn(typeId: string, owner: PlayerId, position: Vec2, options: SpawnOptions = {}): Entity {\n\t\tconst def = this.world.registry.unit(typeId)\n\t\tthis.world.player(owner)\n\t\tlet pos = position\n\t\tlet cell: { x: number; z: number } | undefined\n\t\tif (def.kind !== 'unit') {\n\t\t\tconst fp = footprintOf(def)\n\t\t\tcell = this.world.grid.cellFor(position.x, position.z, fp.w, fp.d)\n\t\t\tpos = { x: cell.x + fp.w / 2, z: cell.z + fp.d / 2 }\n\t\t} else {\n\t\t\tpos = this.world.layerOf(def).closestPoint(position, 8) ?? position\n\t\t}\n\n\t\tconst entity = new Entity(this.world.newEntityId(), def, owner, pos)\n\t\tentity.facing = entity.prevFacing = options.facing ?? 0\n\t\tconst like = options.looksLike\n\t\tentity.scale = options.scale ?? like?.scale ?? 1\n\t\tentity.look = options.look ?? like?.look\n\t\tif (like) entity.likeness = like.likeness ? { ...like.likeness } : { type: like.def.id, owner: like.owner }\n\t\tentity.cell = cell\n\t\tentity.expireIn(options.lifetime ?? def.lifetime ?? null)\n\t\tentity.lifetime = entity.expires ?? 0\n\t\tif (def.invisible) entity.unseenIn = def.invisible.after ?? 0\n\t\tif (def.uses) entity.health = entity.maxHealth = def.uses\n\n\t\tif (def.kind === 'unit') {\n\t\t\tconst speed = def.stats.moveSpeed\n\t\t\tif (speed) {\n\t\t\t\tentity.set(moving, {\n\t\t\t\t\tspeed,\n\t\t\t\t\tstatus: 'idle',\n\t\t\t\t\tgoal: { x: pos.x, z: pos.z },\n\t\t\t\t\tgoalEntity: 0,\n\t\t\t\t\trange: 0,\n\t\t\t\t\tgroupId: 0,\n\t\t\t\t\tnavGoal: { x: pos.x, z: pos.z },\n\t\t\t\t\tnavVersion: 0,\n\t\t\t\t\tcorner: { x: pos.x, z: pos.z },\n\t\t\t\t\tbestDistance: 0,\n\t\t\t\t\tstalledTime: 0,\n\t\t\t\t\tanchored: false,\n\t\t\t\t\tghost: false,\n\t\t\t\t\tfinalFacing: null\n\t\t\t\t})\n\t\t\t\tthis.world.nav.addAgent(entity.id, pos, agentParamsOf(entity, speed))\n\t\t\t}\n\t\t} else {\n\t\t\tconst fp = footprintOf(def)\n\t\t\tthis.world.grid.occupy(cell!.x, cell!.z, fp.w, fp.d, entity.id)\n\t\t\t// on a resource (a cursed mine on a gold mine): the two know of each other\n\t\t\tconst under = resourceAt(this.world, def, pos)\n\t\t\tif (under) {\n\t\t\t\tunder.get(deposit)!.under = entity.id\n\t\t\t\tentity.on = under.id\n\t\t\t}\n\t\t\t// placing is refused before the room runs out (`placementProblem`); what is put down by a script past it stands,\n\t\t\t// and does not block: said, never thrown in the middle of a tick\n\t\t\t// (said once: a map past the room would say it for each of thousands of trees, and stall the page that shows it)\n\t\t\tif (!this.world.nav.addObstacle(entity.id, entity.rect) && !this.world.obstaclesRefused++)\n\t\t\t\tthis.world.log.warn(\n\t\t\t\t\t'navigation',\n\t\t\t\t\t`There is no room for another obstacle: ${def.id} does not block the way, nor what is put down after it while there is none`,\n\t\t\t\t\t{\n\t\t\t\t\t\tentity: entity.id\n\t\t\t\t\t}\n\t\t\t\t)\n\t\t\tif (def.resource) entity.set(deposit, { amount: def.resource.amount, occupants: 0 })\n\t\t\tif (options.underConstruction) {\n\t\t\t\tconst site = typeof options.underConstruction === 'object' ? options.underConstruction : {}\n\t\t\t\tentity.set(constructionSite, {\n\t\t\t\t\tprogress: 0,\n\t\t\t\t\tbuildTime: site.buildTime ?? def.buildTime ?? 1,\n\t\t\t\t\tbuilders: 0,\n\t\t\t\t\t...(site.paid && { paid: site.paid })\n\t\t\t\t})\n\t\t\t\tentity.health = Math.max(1, Math.round(entity.maxHealth * this.world.settings.production.constructionHealth))\n\t\t\t}\n\t\t}\n\t\tentity.mana = Math.min(def.initialMana ?? entity.maxMana, entity.maxMana)\n\t\tfor (const id of def.abilities ?? []) {\n\t\t\tentity.addAbility({ id, level: 1, cooldown: 0, autocast: this.world.registry.ability(id).autocast ?? false })\n\t\t}\n\t\tif (def.attacks?.length)\n\t\t\tentity.set(fighting, { cooldown: 0, swing: 0, swingTarget: 0, autoTarget: 0, lastAttacker: 0, guard: null, passive: false })\n\t\t// what each part of the game gives it as it is made, by its type: a queue, slots, a hold (`Component.onSpawn`)\n\t\tfor (const part of this.world.registry.spawning) part.onSpawn!(entity, this.world)\n\n\t\t// what a pack gives it of its own: a hero's level, a shop's wares (`heroesPack`)\n\t\tif (this.world.hooks.has('made')) this.world.hooks.run('made', entity)\n\t\t// what the caller says it starts with: over what its parts and packs gave\n\t\tfor (const [id, value] of Object.entries(options.data ?? {})) {\n\t\t\tconst component = this.world.registry.component(id)\n\t\t\tif (!component) throw new Error(`Cannot spawn ${typeId} with \"${id}\": the game has no component of that id`)\n\t\t\tentity.set(component, value)\n\t\t}\n\n\t\tthis.world.entities.set(entity.id, entity)\n\t\tthis.world.index.add(entity)\n\t\tif (entity.isStructure) this.world.spatial.insertStatic(entity)\n\t\tentity.setScenery(isScenery(def) && this.world.player(owner).neutral && !entity.has(constructionSite) && entity.expires === null)\n\t\tif (!entity.scenery) this.world.units.set(entity.id, entity)\n\t\t// scenery that appears where a team is looking is in sight right away, not at the next fog update\n\t\telse {\n\t\t\tfor (const [team, inSight] of this.world.sceneryInSight) if (this.world.isVisibleTo(entity, team)) inSight.add(entity)\n\t\t}\n\t\t// what the owner's research does besides stats (`UpgradeDef.apply`)\n\t\tfor (const [id, level] of this.world.player(owner).upgrades) this.world.registry.upgrade(id).apply?.(this.world, entity, level)\n\t\t// before the hooks, which may want to know who it is\n\t\tif (options.name) this.world.setName(entity, options.name)\n\t\tthis.world.hooks.run('spawn', entity)\n\t\tthis.world.events.emit(entitySpawned, entity)\n\t\tif (entity.has(constructionSite)) this.world.events.emit(constructionStarted, entity)\n\t\treturn entity\n\t}\n\n\t/**\n\t * What its parts call off as an entity leaves its owner, dying or given away (`Component.onLeave`)\n\t *\n\t * @internal\n\t */\n\tleave(entity: Entity): void {\n\t\tfor (const part of this.world.registry.leaving) if (entity.has(part)) part.onLeave!(entity, this.world)\n\t}\n\n\t/**\n\t * Turns scenery into an actor, for good: something gave it a reason to be looked at every tick, like a buff\n\t * that has to run out. Whatever does that to an entity calls this.world; the debug checks catch what forgets to.\n\t * It joins `World.units` at the end, out of id order (see `World.units`), which a save keeps as it is\n\t */\n\twake(entity: Entity): void {\n\t\tif (!entity.scenery) return\n\t\tentity.setScenery(false)\n\t\tthis.world.units.set(entity.id, entity)\n\t}\n\n\t/** Puts a unit somewhere else, where it stands: the way through is not its concern. Structures stay where they were built */\n\tplace(entity: Entity, point: Vec2): void {\n\t\tif (entity.isStructure) throw new Error(`${entity.def.id}#${entity.id} is a structure: it cannot be moved`)\n\t\tentity.moveTo(point.x, point.z)\n\t\tif (entity.get(moving) && !entity.hidden && !entity.get(dashing)?.height) this.world.nav.teleport(entity.id, point)\n\t}\n\n\t/**\n\t * Gives an entity to another player, from now on in everything: whose it is, whom it fights, what it counts for.\n\t * What it was doing is called off, and what it was making is given back to the one it belonged to\n\t */\n\tsetOwner(entity: Entity, owner: PlayerId): void {\n\t\tif (entity.owner === owner) return\n\t\tthis.world.player(owner)\n\t\tclearOrders(this.world, entity)\n\t\tthis.leave(entity)\n\t\tif (entity.get(fighting)) Object.assign(entity.get(fighting)!, { autoTarget: 0, lastAttacker: 0, guard: null })\n\t\tthis.world.index.remove(entity)\n\t\tentity.changeOwner(owner)\n\t\tthis.world.index.add(entity)\n\t\t// filed this.world tick under its old owner's: the grid's cells by owner wait for the next filing\n\t\tthis.world.spatial.ownerChanged()\n\t\t// a tree that now belongs to someone counts for them: it is not scenery any more\n\t\tif (entity.scenery && !this.world.player(owner).neutral) this.wake(entity)\n\t}\n\n\t/**\n\t * Takes a unit out of the world for a while, or puts it back: a worker inside a gold mine, a unit carried in\n\t * something. While hidden it is not found, not seen and in nobody's way, and its orders wait. It comes back at\n\t * `at`, or where it went in, on the nearest ground it can stand on. Structures cannot hide\n\t */\n\tsetHidden(entity: Entity, hidden: boolean, at?: Vec2): void {\n\t\tif (entity.hidden === hidden) return\n\t\tif (entity.isStructure) throw new Error(`${entity.def.id}#${entity.id} is a structure: it cannot hide`)\n\t\tconst m = entity.get(moving)\n\t\tif (hidden) {\n\t\t\tif (m) {\n\t\t\t\thalt(this.world, entity)\n\t\t\t\tthis.world.nav.removeAgent(entity.id)\n\t\t\t}\n\t\t\tthis.wake(entity)\n\t\t\tentity.setInside(true)\n\t\t\treturn\n\t\t}\n\t\tentity.setInside(false)\n\t\tconst nav = this.world.navFor(entity)\n\t\tconst point = nav.closestPoint(at ?? entity.pos, 8) ?? at ?? entity.pos\n\t\tentity.moveTo(point.x, point.z)\n\t\tentity.prevPos.x = point.x\n\t\tentity.prevPos.z = point.z\n\t\tif (!m) return\n\t\tthis.world.nav.addAgent(entity.id, point, agentParamsOf(entity, m.speed))\n\t\t// the agent is new, so it lost its flags\n\t\tconst { ghost } = m\n\t\tm.ghost = false\n\t\t// phasing is seen to again on the next tick (`BuffDef.phasing`)\n\t\tdelete m.phased\n\t\tm.anchored = false\n\t\tm.status = 'idle'\n\t\tsetGhost(this.world, entity, ghost)\n\t}\n\n\t/** Gives an entity a time after which it is gone by itself, like a ward, or takes it away with `null` */\n\tsetLifetime(entity: Entity, seconds: number | null): void {\n\t\tif (seconds !== null) this.wake(entity)\n\t\tentity.expireIn(seconds)\n\t\tentity.lifetime = seconds ?? 0\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;AAgBA,IAAa,WAAb,MAAsB;CACQ;CAA7B,YAAY,OAA+B;EAAd,KAAA,QAAA;CAAe;CAE5C,MAAM,QAAgB,OAAiB,UAAgB,UAAwB,CAAC,GAAW;EAC1F,MAAM,MAAM,KAAK,MAAM,SAAS,KAAK,MAAM;EAC3C,KAAK,MAAM,OAAO,KAAK;EACvB,IAAI,MAAM;EACV,IAAI;EACJ,IAAI,IAAI,SAAS,QAAQ;GACxB,MAAM,KAAK,YAAY,GAAG;GAC1B,OAAO,KAAK,MAAM,KAAK,QAAQ,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC;GACjE,MAAM;IAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAAG,GAAG,KAAK,IAAI,GAAG,IAAI;GAAE;EACpD,OACC,MAAM,KAAK,MAAM,QAAQ,GAAG,CAAC,CAAC,aAAa,UAAU,CAAC,KAAK;EAG5D,MAAM,SAAS,IAAI,OAAO,KAAK,MAAM,YAAY,GAAG,KAAK,OAAO,GAAG;EACnE,OAAO,SAAS,OAAO,aAAa,QAAQ,UAAU;EACtD,MAAM,OAAO,QAAQ;EACrB,OAAO,QAAQ,QAAQ,SAAS,MAAM,SAAS;EAC/C,OAAO,OAAO,QAAQ,QAAQ,MAAM;EACpC,IAAI,MAAM,OAAO,WAAW,KAAK,WAAW,EAAE,GAAG,KAAK,SAAS,IAAI;GAAE,MAAM,KAAK,IAAI;GAAI,OAAO,KAAK;EAAM;EAC1G,OAAO,OAAO;EACd,OAAO,SAAS,QAAQ,YAAY,IAAI,YAAY,IAAI;EACxD,OAAO,WAAW,OAAO,WAAW;EACpC,IAAI,IAAI,WAAW,OAAO,WAAW,IAAI,UAAU,SAAS;EAC5D,IAAI,IAAI,MAAM,OAAO,SAAS,OAAO,YAAY,IAAI;EAErD,IAAI,IAAI,SAAS,QAAQ;GACxB,MAAM,QAAQ,IAAI,MAAM;GACxB,IAAI,OAAO;IACV,OAAO,IAAI,QAAQ;KAClB;KACA,QAAQ;KACR,MAAM;MAAE,GAAG,IAAI;MAAG,GAAG,IAAI;KAAE;KAC3B,YAAY;KACZ,OAAO;KACP,SAAS;KACT,SAAS;MAAE,GAAG,IAAI;MAAG,GAAG,IAAI;KAAE;KAC9B,YAAY;KACZ,QAAQ;MAAE,GAAG,IAAI;MAAG,GAAG,IAAI;KAAE;KAC7B,cAAc;KACd,aAAa;KACb,UAAU;KACV,OAAO;KACP,aAAa;IACd,CAAC;IACD,KAAK,MAAM,IAAI,SAAS,OAAO,IAAI,KAAK,cAAc,QAAQ,KAAK,CAAC;GACrE;EACD,OAAO;GACN,MAAM,KAAK,YAAY,GAAG;GAC1B,KAAK,MAAM,KAAK,OAAO,KAAM,GAAG,KAAM,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,EAAE;GAE9D,MAAM,QAAQ,WAAW,KAAK,OAAO,KAAK,GAAG;GAC7C,IAAI,OAAO;IACV,MAAM,IAAI,OAAO,CAAC,CAAE,QAAQ,OAAO;IACnC,OAAO,KAAK,MAAM;GACnB;GAIA,IAAI,CAAC,KAAK,MAAM,IAAI,YAAY,OAAO,IAAI,OAAO,IAAI,KAAK,CAAC,KAAK,MAAM,oBACtE,KAAK,MAAM,IAAI,KACd,cACA,0CAA0C,IAAI,GAAG,6EACjD,EACC,QAAQ,OAAO,GAChB,CACD;GACD,IAAI,IAAI,UAAU,OAAO,IAAI,SAAS;IAAE,QAAQ,IAAI,SAAS;IAAQ,WAAW;GAAE,CAAC;GACnF,IAAI,QAAQ,mBAAmB;IAC9B,MAAM,OAAO,OAAO,QAAQ,sBAAsB,WAAW,QAAQ,oBAAoB,CAAC;IAC1F,OAAO,IAAI,kBAAkB;KAC5B,UAAU;KACV,WAAW,KAAK,aAAa,IAAI,aAAa;KAC9C,UAAU;KACV,GAAI,KAAK,QAAQ,EAAE,MAAM,KAAK,KAAK;IACpC,CAAC;IACD,OAAO,SAAS,KAAK,IAAI,GAAG,KAAK,MAAM,OAAO,YAAY,KAAK,MAAM,SAAS,WAAW,kBAAkB,CAAC;GAC7G;EACD;EACA,OAAO,OAAO,KAAK,IAAI,IAAI,eAAe,OAAO,SAAS,OAAO,OAAO;EACxE,KAAK,MAAM,MAAM,IAAI,aAAa,CAAC,GAClC,OAAO,WAAW;GAAE;GAAI,OAAO;GAAG,UAAU;GAAG,UAAU,KAAK,MAAM,SAAS,QAAQ,EAAE,CAAC,CAAC,YAAY;EAAM,CAAC;EAE7G,IAAI,IAAI,SAAS,QAChB,OAAO,IAAI,UAAU;GAAE,UAAU;GAAG,OAAO;GAAG,aAAa;GAAG,YAAY;GAAG,cAAc;GAAG,OAAO;GAAM,SAAS;EAAM,CAAC;EAE5H,KAAK,MAAM,QAAQ,KAAK,MAAM,SAAS,UAAU,KAAK,QAAS,QAAQ,KAAK,KAAK;EAGjF,IAAI,KAAK,MAAM,MAAM,IAAI,MAAM,GAAG,KAAK,MAAM,MAAM,IAAI,QAAQ,MAAM;EAErE,KAAK,MAAM,CAAC,IAAI,UAAU,OAAO,QAAQ,QAAQ,QAAQ,CAAC,CAAC,GAAG;GAC7D,MAAM,YAAY,KAAK,MAAM,SAAS,UAAU,EAAE;GAClD,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,gBAAgB,OAAO,SAAS,GAAG,wCAAwC;GAC3G,OAAO,IAAI,WAAW,KAAK;EAC5B;EAEA,KAAK,MAAM,SAAS,IAAI,OAAO,IAAI,MAAM;EACzC,KAAK,MAAM,MAAM,IAAI,MAAM;EAC3B,IAAI,OAAO,aAAa,KAAK,MAAM,QAAQ,aAAa,MAAM;EAC9D,OAAO,WAAW,UAAU,GAAG,KAAK,KAAK,MAAM,OAAO,KAAK,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,gBAAgB,KAAK,OAAO,YAAY,IAAI;EAChI,IAAI,CAAC,OAAO,SAAS,KAAK,MAAM,MAAM,IAAI,OAAO,IAAI,MAAM;OAG1D,KAAK,MAAM,CAAC,MAAM,YAAY,KAAK,MAAM,gBAAgB,IAAI,KAAK,MAAM,YAAY,QAAQ,IAAI,GAAG,QAAQ,IAAI,MAAM;EAGtH,KAAK,MAAM,CAAC,IAAI,UAAU,KAAK,MAAM,OAAO,KAAK,CAAC,CAAC,UAAU,KAAK,MAAM,SAAS,QAAQ,EAAE,CAAC,CAAC,QAAQ,KAAK,OAAO,QAAQ,KAAK;EAE9H,IAAI,QAAQ,MAAM,KAAK,MAAM,QAAQ,QAAQ,QAAQ,IAAI;EACzD,KAAK,MAAM,MAAM,IAAI,SAAS,MAAM;EACpC,KAAK,MAAM,OAAO,KAAK,eAAe,MAAM;EAC5C,IAAI,OAAO,IAAI,gBAAgB,GAAG,KAAK,MAAM,OAAO,KAAK,qBAAqB,MAAM;EACpF,OAAO;CACR;;;;;;CAOA,MAAM,QAAsB;EAC3B,KAAK,MAAM,QAAQ,KAAK,MAAM,SAAS,SAAS,IAAI,OAAO,IAAI,IAAI,GAAG,KAAK,QAAS,QAAQ,KAAK,KAAK;CACvG;;;;;;CAOA,KAAK,QAAsB;EAC1B,IAAI,CAAC,OAAO,SAAS;EACrB,OAAO,WAAW,KAAK;EACvB,KAAK,MAAM,MAAM,IAAI,OAAO,IAAI,MAAM;CACvC;;CAGA,MAAM,QAAgB,OAAmB;EACxC,IAAI,OAAO,aAAa,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG,GAAG,OAAO,GAAG,oCAAoC;EAC1G,OAAO,OAAO,MAAM,GAAG,MAAM,CAAC;EAC9B,IAAI,OAAO,IAAI,MAAM,KAAK,CAAC,OAAO,UAAU,CAAC,OAAO,IAAI,OAAO,CAAC,EAAE,QAAQ,KAAK,MAAM,IAAI,SAAS,OAAO,IAAI,KAAK;CACnH;;;;;CAMA,SAAS,QAAgB,OAAuB;EAC/C,IAAI,OAAO,UAAU,OAAO;EAC5B,KAAK,MAAM,OAAO,KAAK;EACvB,YAAY,KAAK,OAAO,MAAM;EAC9B,KAAK,MAAM,MAAM;EACjB,IAAI,OAAO,IAAI,QAAQ,GAAG,OAAO,OAAO,OAAO,IAAI,QAAQ,GAAI;GAAE,YAAY;GAAG,cAAc;GAAG,OAAO;EAAK,CAAC;EAC9G,KAAK,MAAM,MAAM,OAAO,MAAM;EAC9B,OAAO,YAAY,KAAK;EACxB,KAAK,MAAM,MAAM,IAAI,MAAM;EAE3B,KAAK,MAAM,QAAQ,aAAa;EAEhC,IAAI,OAAO,WAAW,CAAC,KAAK,MAAM,OAAO,KAAK,CAAC,CAAC,SAAS,KAAK,KAAK,MAAM;CAC1E;;;;;;CAOA,UAAU,QAAgB,QAAiB,IAAiB;EAC3D,IAAI,OAAO,WAAW,QAAQ;EAC9B,IAAI,OAAO,aAAa,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG,GAAG,OAAO,GAAG,gCAAgC;EACtG,MAAM,IAAI,OAAO,IAAI,MAAM;EAC3B,IAAI,QAAQ;GACX,IAAI,GAAG;IACN,KAAK,KAAK,OAAO,MAAM;IACvB,KAAK,MAAM,IAAI,YAAY,OAAO,EAAE;GACrC;GACA,KAAK,KAAK,MAAM;GAChB,OAAO,UAAU,IAAI;GACrB;EACD;EACA,OAAO,UAAU,KAAK;EAEtB,MAAM,QADM,KAAK,MAAM,OAAO,MAChB,CAAA,CAAI,aAAa,MAAM,OAAO,KAAK,CAAC,KAAK,MAAM,OAAO;EACpE,OAAO,OAAO,MAAM,GAAG,MAAM,CAAC;EAC9B,OAAO,QAAQ,IAAI,MAAM;EACzB,OAAO,QAAQ,IAAI,MAAM;EACzB,IAAI,CAAC,GAAG;EACR,KAAK,MAAM,IAAI,SAAS,OAAO,IAAI,OAAO,cAAc,QAAQ,EAAE,KAAK,CAAC;EAExE,MAAM,EAAE,UAAU;EAClB,EAAE,QAAQ;EAEV,OAAO,EAAE;EACT,EAAE,WAAW;EACb,EAAE,SAAS;EACX,SAAS,KAAK,OAAO,QAAQ,KAAK;CACnC;;CAGA,YAAY,QAAgB,SAA8B;EACzD,IAAI,YAAY,MAAM,KAAK,KAAK,MAAM;EACtC,OAAO,SAAS,OAAO;EACvB,OAAO,WAAW,WAAW;CAC9B;AACD"}

package/dist/stances.d.ts

@@ -6,8 +6,11 @@ import { type Entity } from './entity';
  * @beta
  */
 export interface StanceDef {
+    /** The stance's id, which the stance command and `UnitTypeDef.stance` name it by */
     id: string;
+    /** The stance's name shown on the HUD */
     name: string;
+    /** What the stance does, for its tooltip */
     description?: string;
     /** The key on the command card, for the HUD's buttons (`stanceButtons` of the client) */
     hotkey?: string;
@@ -22,7 +25,7 @@ export interface StanceDef {
 }
 /**
  * The four stances every RTS has: aggressive (the engine's own way, when no stance is set), defensive, hold fire and no
- * attack. A game gives `withStances` its own list in their place, or adds to these
+ * attack. A game gives `stancesPack` its own list in their place, or adds to these
  *
  * @beta
  */
@@ -57,7 +60,7 @@ export declare const stanceCommand: import("#engine/commands").DefinedCommand<"s
     stance: import("./fields").Check<string>;
 }>;
 /**
- * What a game turns stances on with (`withStances`)
+ * What a game turns stances on with (`stancesPack`)
  *
  * @beta
  */
@@ -73,4 +76,4 @@ export interface StancesOptions {
  *
  * @beta
  */
-export declare function withStances(options?: StancesOptions): GamePack;
+export declare function stancesPack(options?: StancesOptions): GamePack;

package/dist/stances.js

@@ -0,0 +1,169 @@
+import { defineComponent } from "./components.js";
+import { edgeDistance, fighting } from "./entity.js";
+import { defineHook } from "./hooks.js";
+import { rangeAgainst } from "./attacks.js";
+import { STRUCTURE_REACH } from "./engagement.js";
+import { SWING_SLACK, disengage } from "./systems/combat.js";
+import { ids, string } from "./fields.js";
+import { defineCommand } from "./commands.js";
+//#region src/stances.ts
+/**
+* The four stances every RTS has: aggressive (the engine's own way, when no stance is set), defensive, hold fire and no
+* attack. A game gives `stancesPack` its own list in their place, or adds to these
+*
+* @beta
+*/
+var STANCES = [
+	{
+		id: "aggressive",
+		name: "Aggressive",
+		description: "Attacks what comes into sight, and chases it",
+		hotkey: "G",
+		acquire: "any",
+		pursue: true,
+		fireBack: true,
+		returnTo: "post"
+	},
+	{
+		id: "defensive",
+		name: "Defensive",
+		description: "Fires at what comes within reach, and stays where it stands",
+		hotkey: "V",
+		acquire: "near",
+		pursue: false,
+		fireBack: true,
+		returnTo: "post"
+	},
+	{
+		id: "holdFire",
+		name: "Hold fire",
+		description: "Fires back at whoever hits it, and no more",
+		hotkey: "X",
+		acquire: "none",
+		pursue: false,
+		fireBack: true,
+		returnTo: "post"
+	},
+	{
+		id: "noAttack",
+		name: "No attack",
+		description: "Ignores everyone until told otherwise",
+		hotkey: "Z",
+		acquire: "none",
+		pursue: false,
+		fireBack: false,
+		returnTo: "none"
+	}
+];
+/**
+* The stance of a unit that was given none: the engine's own way
+*
+* @beta
+*/
+var DEFAULT_STANCE = "aggressive";
+/**
+* The stance a unit is in, by its id; absent for one in the default stance. Told to its owner, so that the HUD shows it
+*
+* @beta
+*/
+var stance = defineComponent({
+	id: "core.stance",
+	replicate: "owner"
+});
+/**
+* The stance of a unit, as a definition: the one its component names, else the default (the first of `stances` with
+* the default's id, else the first of them)
+*
+* @beta
+*/
+function stanceOf(entity, stances = STANCES) {
+	const id = entity.get(stance) ?? "aggressive";
+	return stances.find((def) => def.id === id) ?? stances.find((def) => def.id === "aggressive") ?? stances[0];
+}
+/**
+* Puts units of the player's in a stance (`{ entities, stance }`). Units of another's, and ids of nothing, are left
+* out. A stance the game has not got is kept as a word and behaves as the default: the hooks know the game's list
+*
+* @beta
+*/
+var stanceCommand = defineCommand("stance", {
+	entities: ids,
+	stance: string
+}, (world, player, command) => {
+	const id = command.stance;
+	for (const entity of owned(world, player, command.entities)) {
+		const was = entity.get(stance);
+		if (id === "aggressive") entity.remove(stance);
+		else entity.set(stance, id);
+		if (was !== id && entity.get(fighting)) {
+			entity.get(fighting).autoTarget = 0;
+			entity.get(fighting).lastAttacker = 0;
+			disengage(world, entity);
+		}
+	}
+});
+/** The units of the player's among the ids, alive */
+function owned(world, player, entities) {
+	const out = [];
+	for (const id of entities) {
+		const entity = world.get(id);
+		if (entity?.alive && entity.owner === player) out.push(entity);
+	}
+	return out;
+}
+/**
+* A game whose units have stances: the component, the command, and the engine's acquisition read through hooks. In
+* the default stance nothing changes. Defensive units fire at what their attack reaches and let go of what steps out
+* of it, returning to where they stood (the engine's own way home); hold fire fires back at the last to hit it; no
+* attack leaves everyone alone. A unit given an attack order fights whatever its stance
+*
+* @beta
+*/
+function stancesPack(options = {}) {
+	const stances = options.stances ?? STANCES;
+	if (!stances.length) throw new Error("stancesPack: a game needs a stance at least");
+	/** Whether a unit of its own accord may go for a target, as its stance says */
+	const canAttackHook = defineHook({
+		hook: "canAttack",
+		id: "core.stances.canAttack",
+		run(world, event) {
+			if (event.cancelled || event.ordered) return;
+			const { attacker, target } = event;
+			const def = stanceOf(attacker, stances);
+			if (def.acquire === "any" && def.pursue) return;
+			const combat = attacker.get(fighting);
+			const engaged = !!combat && (combat.autoTarget === target.id || combat.lastAttacker === target.id);
+			if (def.acquire === "none") {
+				event.cancelled = !(def.fireBack && engaged);
+				return;
+			}
+			if (def.acquire === "near" || !def.pursue && engaged) {
+				const swinging = !!combat && combat.swing > 0 && combat.swingTarget === target.id;
+				const reach = rangeAgainst(world, attacker, target) + (target.isStructure ? STRUCTURE_REACH : 0) + (swinging ? SWING_SLACK : 0);
+				if (edgeDistance(attacker, target) > reach) event.cancelled = true;
+			}
+		}
+	});
+	/** A unit that returns nowhere after a fight: it forgets where it stood as the fight ends */
+	const idleHook = defineHook({
+		hook: "idle",
+		id: "core.stances.idle",
+		run(_world, event) {
+			const { entity } = event;
+			const combat = entity.get(fighting);
+			if (!combat?.guard || combat.autoTarget) return;
+			if (stanceOf(entity, stances).returnTo === "none") combat.guard = null;
+		}
+	});
+	return {
+		id: "stances",
+		options,
+		components: [stance],
+		commands: [stanceCommand],
+		hooks: [canAttackHook, idleHook]
+	};
+}
+//#endregion
+export { DEFAULT_STANCE, STANCES, stance, stanceCommand, stanceOf, stancesPack };
+
+//# sourceMappingURL=stances.js.map

package/dist/stances.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stances.js","names":[],"sources":["../src/stances.ts"],"sourcesContent":["import { defineCommand } from './commands'\nimport type { GamePack } from './packs/pack'\nimport { defineComponent } from './components'\nimport { edgeDistance, type Entity, type PlayerId, fighting } from './entity'\nimport { ids, string } from './fields'\nimport { defineHook } from './hooks'\nimport { disengage, STRUCTURE_REACH, SWING_SLACK } from './systems/combat'\nimport { rangeAgainst } from './attacks'\nimport type { World } from './world'\n\n/*\n * Stances (master plan FI1): how a unit with nothing to do takes to the enemies around it. Aggressive attacks what\n * comes into sight and chases it; defensive fires at what comes within its reach and stays where it stands; hold fire\n * fires back and no more; no attack ignores everyone. A pack a game turns on (`stancesPack`): a component on the unit\n * (`stance`), a command the player sends (`stanceCommand`), and the engine's own acquisition read through the\n * `canAttack` and `idle` hooks, so that nothing of the engine names a stance. An attack order is the player's word:\n * it goes through whatever the stance\n */\n\n/**\n * A stance: how a unit without orders takes to the enemies around it\n *\n * @beta\n */\nexport interface StanceDef {\n\t/** The stance's id, which the stance command and `UnitTypeDef.stance` name it by */\n\tid: string\n\t/** The stance's name shown on the HUD */\n\tname: string\n\t/** What the stance does, for its tooltip */\n\tdescription?: string\n\t/** The key on the command card, for the HUD's buttons (`stanceButtons` of the client) */\n\thotkey?: string\n\t/** What it attacks of its own accord: anything in its acquisition range, only what its attack reaches, or nothing */\n\tacquire: 'any' | 'near' | 'none'\n\t/** Whether it chases what it fights past the reach of its attack */\n\tpursue: boolean\n\t/** Whether it fights back whoever hits it, for a stance that acquires nothing */\n\tfireBack: boolean\n\t/** Where it goes once a fight is over: back where it stood, or nowhere */\n\treturnTo: 'post' | 'none'\n}\n\n/**\n * The four stances every RTS has: aggressive (the engine's own way, when no stance is set), defensive, hold fire and no\n * attack. A game gives `stancesPack` its own list in their place, or adds to these\n *\n * @beta\n */\nexport const STANCES: readonly StanceDef[] = [\n\t{\n\t\tid: 'aggressive',\n\t\tname: 'Aggressive',\n\t\tdescription: 'Attacks what comes into sight, and chases it',\n\t\thotkey: 'G',\n\t\tacquire: 'any',\n\t\tpursue: true,\n\t\tfireBack: true,\n\t\treturnTo: 'post'\n\t},\n\t{\n\t\tid: 'defensive',\n\t\tname: 'Defensive',\n\t\tdescription: 'Fires at what comes within reach, and stays where it stands',\n\t\thotkey: 'V',\n\t\tacquire: 'near',\n\t\tpursue: false,\n\t\tfireBack: true,\n\t\treturnTo: 'post'\n\t},\n\t{\n\t\tid: 'holdFire',\n\t\tname: 'Hold fire',\n\t\tdescription: 'Fires back at whoever hits it, and no more',\n\t\thotkey: 'X',\n\t\tacquire: 'none',\n\t\tpursue: false,\n\t\tfireBack: true,\n\t\treturnTo: 'post'\n\t},\n\t{\n\t\tid: 'noAttack',\n\t\tname: 'No attack',\n\t\tdescription: 'Ignores everyone until told otherwise',\n\t\thotkey: 'Z',\n\t\tacquire: 'none',\n\t\tpursue: false,\n\t\tfireBack: false,\n\t\treturnTo: 'none'\n\t}\n]\n\n/**\n * The stance of a unit that was given none: the engine's own way\n *\n * @beta\n */\nexport const DEFAULT_STANCE = 'aggressive'\n\n/**\n * The stance a unit is in, by its id; absent for one in the default stance. Told to its owner, so that the HUD shows it\n *\n * @beta\n */\nexport const stance = defineComponent<string>({ id: 'core.stance', replicate: 'owner' })\n\n/**\n * The stance of a unit, as a definition: the one its component names, else the default (the first of `stances` with\n * the default's id, else the first of them)\n *\n * @beta\n */\nexport function stanceOf(entity: Entity, stances: readonly StanceDef[] = STANCES): StanceDef {\n\tconst id = entity.get(stance) ?? DEFAULT_STANCE\n\treturn stances.find((def) => def.id === id) ?? stances.find((def) => def.id === DEFAULT_STANCE) ?? stances[0]\n}\n\n/**\n * Puts units of the player's in a stance (`{ entities, stance }`). Units of another's, and ids of nothing, are left\n * out. A stance the game has not got is kept as a word and behaves as the default: the hooks know the game's list\n *\n * @beta\n */\nexport const stanceCommand = defineCommand('stance', { entities: ids, stance: string }, (world, player, command) => {\n\tconst id = command.stance\n\tfor (const entity of owned(world, player, command.entities)) {\n\t\tconst was = entity.get(stance)\n\t\tif (id === DEFAULT_STANCE) entity.remove(stance)\n\t\telse entity.set(stance, id)\n\t\t// a unit told to stand down lets go of whatever it was chasing: the hooks say whether it may go for it again\n\t\tif (was !== id && entity.get(fighting)) {\n\t\t\tentity.get(fighting)!.autoTarget = 0\n\t\t\tentity.get(fighting)!.lastAttacker = 0\n\t\t\tdisengage(world, entity)\n\t\t}\n\t}\n})\n\n/** The units of the player's among the ids, alive */\nfunction owned(world: World, player: PlayerId, entities: readonly number[]): Entity[] {\n\tconst out: Entity[] = []\n\tfor (const id of entities) {\n\t\tconst entity = world.get(id)\n\t\tif (entity?.alive && entity.owner === player) out.push(entity)\n\t}\n\treturn out\n}\n\n/**\n * What a game turns stances on with (`stancesPack`)\n *\n * @beta\n */\nexport interface StancesOptions {\n\t/** The stances of this game, in the order the HUD shows them: the usual four (`STANCES`) when left out */\n\tstances?: readonly StanceDef[]\n}\n\n/**\n * A game whose units have stances: the component, the command, and the engine's acquisition read through hooks. In\n * the default stance nothing changes. Defensive units fire at what their attack reaches and let go of what steps out\n * of it, returning to where they stood (the engine's own way home); hold fire fires back at the last to hit it; no\n * attack leaves everyone alone. A unit given an attack order fights whatever its stance\n *\n * @beta\n */\nexport function stancesPack(options: StancesOptions = {}): GamePack {\n\tconst stances = options.stances ?? STANCES\n\tif (!stances.length) throw new Error('stancesPack: a game needs a stance at least')\n\n\t/** Whether a unit of its own accord may go for a target, as its stance says */\n\tconst canAttackHook = defineHook({\n\t\thook: 'canAttack',\n\t\tid: 'core.stances.canAttack',\n\t\trun(world, event) {\n\t\t\tif (event.cancelled || event.ordered) return\n\t\t\tconst { attacker, target } = event\n\t\t\tconst def = stanceOf(attacker, stances)\n\t\t\tif (def.acquire === 'any' && def.pursue) return\n\t\t\tconst combat = attacker.get(fighting)\n\t\t\tconst engaged = !!combat && (combat.autoTarget === target.id || combat.lastAttacker === target.id)\n\t\t\tif (def.acquire === 'none') {\n\t\t\t\tevent.cancelled = !(def.fireBack && engaged)\n\t\t\t\treturn\n\t\t\t}\n\t\t\t// only what its attack reaches from where it stands: where the engine would chase, it lets go (the same reach\n\t\t\t// `engage` goes by: a structure's edge a little farther, a swing already begun a little more)\n\t\t\tif (def.acquire === 'near' || (!def.pursue && engaged)) {\n\t\t\t\tconst swinging = !!combat && combat.swing > 0 && combat.swingTarget === target.id\n\t\t\t\tconst reach = rangeAgainst(world, attacker, target) + (target.isStructure ? STRUCTURE_REACH : 0) + (swinging ? SWING_SLACK : 0)\n\t\t\t\tif (edgeDistance(attacker, target) > reach) event.cancelled = true\n\t\t\t}\n\t\t}\n\t})\n\n\t/** A unit that returns nowhere after a fight: it forgets where it stood as the fight ends */\n\tconst idleHook = defineHook({\n\t\thook: 'idle',\n\t\tid: 'core.stances.idle',\n\t\trun(_world, event) {\n\t\t\tconst { entity } = event\n\t\t\tconst combat = entity.get(fighting)\n\t\t\tif (!combat?.guard || combat.autoTarget) return\n\t\t\tif (stanceOf(entity, stances).returnTo === 'none') combat.guard = null\n\t\t}\n\t})\n\n\treturn {\n\t\tid: 'stances',\n\t\toptions,\n\t\tcomponents: [stance],\n\t\tcommands: [stanceCommand],\n\t\thooks: [canAttackHook, idleHook]\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiDA,IAAa,UAAgC;CAC5C;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,SAAS;EACT,QAAQ;EACR,UAAU;EACV,UAAU;CACX;CACA;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,SAAS;EACT,QAAQ;EACR,UAAU;EACV,UAAU;CACX;CACA;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,SAAS;EACT,QAAQ;EACR,UAAU;EACV,UAAU;CACX;CACA;EACC,IAAI;EACJ,MAAM;EACN,aAAa;EACb,QAAQ;EACR,SAAS;EACT,QAAQ;EACR,UAAU;EACV,UAAU;CACX;AACD;;;;;;AAOA,IAAa,iBAAiB;;;;;;AAO9B,IAAa,SAAS,gBAAwB;CAAE,IAAI;CAAe,WAAW;AAAQ,CAAC;;;;;;;AAQvF,SAAgB,SAAS,QAAgB,UAAgC,SAAoB;CAC5F,MAAM,KAAK,OAAO,IAAI,MAAM,KAAA;CAC5B,OAAO,QAAQ,MAAM,QAAQ,IAAI,OAAO,EAAE,KAAK,QAAQ,MAAM,QAAQ,IAAI,OAAA,YAAqB,KAAK,QAAQ;AAC5G;;;;;;;AAQA,IAAa,gBAAgB,cAAc,UAAU;CAAE,UAAU;CAAK,QAAQ;AAAO,IAAI,OAAO,QAAQ,YAAY;CACnH,MAAM,KAAK,QAAQ;CACnB,KAAK,MAAM,UAAU,MAAM,OAAO,QAAQ,QAAQ,QAAQ,GAAG;EAC5D,MAAM,MAAM,OAAO,IAAI,MAAM;EAC7B,IAAI,OAAA,cAAuB,OAAO,OAAO,MAAM;OAC1C,OAAO,IAAI,QAAQ,EAAE;EAE1B,IAAI,QAAQ,MAAM,OAAO,IAAI,QAAQ,GAAG;GACvC,OAAO,IAAI,QAAQ,CAAC,CAAE,aAAa;GACnC,OAAO,IAAI,QAAQ,CAAC,CAAE,eAAe;GACrC,UAAU,OAAO,MAAM;EACxB;CACD;AACD,CAAC;;AAGD,SAAS,MAAM,OAAc,QAAkB,UAAuC;CACrF,MAAM,MAAgB,CAAC;CACvB,KAAK,MAAM,MAAM,UAAU;EAC1B,MAAM,SAAS,MAAM,IAAI,EAAE;EAC3B,IAAI,QAAQ,SAAS,OAAO,UAAU,QAAQ,IAAI,KAAK,MAAM;CAC9D;CACA,OAAO;AACR;;;;;;;;;AAoBA,SAAgB,YAAY,UAA0B,CAAC,GAAa;CACnE,MAAM,UAAU,QAAQ,WAAW;CACnC,IAAI,CAAC,QAAQ,QAAQ,MAAM,IAAI,MAAM,6CAA6C;;CAGlF,MAAM,gBAAgB,WAAW;EAChC,MAAM;EACN,IAAI;EACJ,IAAI,OAAO,OAAO;GACjB,IAAI,MAAM,aAAa,MAAM,SAAS;GACtC,MAAM,EAAE,UAAU,WAAW;GAC7B,MAAM,MAAM,SAAS,UAAU,OAAO;GACtC,IAAI,IAAI,YAAY,SAAS,IAAI,QAAQ;GACzC,MAAM,SAAS,SAAS,IAAI,QAAQ;GACpC,MAAM,UAAU,CAAC,CAAC,WAAW,OAAO,eAAe,OAAO,MAAM,OAAO,iBAAiB,OAAO;GAC/F,IAAI,IAAI,YAAY,QAAQ;IAC3B,MAAM,YAAY,EAAE,IAAI,YAAY;IACpC;GACD;GAGA,IAAI,IAAI,YAAY,UAAW,CAAC,IAAI,UAAU,SAAU;IACvD,MAAM,WAAW,CAAC,CAAC,UAAU,OAAO,QAAQ,KAAK,OAAO,gBAAgB,OAAO;IAC/E,MAAM,QAAQ,aAAa,OAAO,UAAU,MAAM,KAAK,OAAO,cAAc,kBAAkB,MAAM,WAAW,cAAc;IAC7H,IAAI,aAAa,UAAU,MAAM,IAAI,OAAO,MAAM,YAAY;GAC/D;EACD;CACD,CAAC;;CAGD,MAAM,WAAW,WAAW;EAC3B,MAAM;EACN,IAAI;EACJ,IAAI,QAAQ,OAAO;GAClB,MAAM,EAAE,WAAW;GACnB,MAAM,SAAS,OAAO,IAAI,QAAQ;GAClC,IAAI,CAAC,QAAQ,SAAS,OAAO,YAAY;GACzC,IAAI,SAAS,QAAQ,OAAO,CAAC,CAAC,aAAa,QAAQ,OAAO,QAAQ;EACnE;CACD,CAAC;CAED,OAAO;EACN,IAAI;EACJ;EACA,YAAY,CAAC,MAAM;EACnB,UAAU,CAAC,aAAa;EACxB,OAAO,CAAC,eAAe,QAAQ;CAChC;AACD"}

package/dist/start.d.ts

@@ -6,7 +6,7 @@ import type { World } from './world';
  *
  * @beta
  */
-export interface StartCode {
+export interface StartingBaseCode {
     /** Puts down a base at the start location. Only for players the map places nothing for */
     spawn(world: World, player: PlayerId, at: Vec2): void;
 }
@@ -16,7 +16,7 @@ export interface StartCode {
  *
  * @beta
  */
-export interface StartData {
+export interface StartingBaseData {
     /** The unit type put down at the start location: a town hall */
     hall: string;
     /** The workers put down beside it, facing the closest gold mine */
@@ -41,31 +41,31 @@ export interface StartData {
 }
 /**
  * What each player gets at the beginning of a game on a map, for players the map places nothing for: as data
- * (`StartData`: a hall, workers and what else by unit type, editable in the Data panel) or as code (`StartCode`). What
+ * (`StartingBaseData`: a hall, workers and what else by unit type, editable in the Data panel) or as code (`StartingBaseCode`). What
  * they start with of each resource is in its `ResourceDef`
  *
  * @beta
  */
-export type StartDef = StartCode | StartData;
+export type StartingBase = StartingBaseCode | StartingBaseData;
 /** Whether a start is the data form */
-export declare const isStartData: (start: StartDef) => start is StartData;
+export declare const isStartingBaseData: (start: StartingBase) => start is StartingBaseData;
 /**
- * Puts down what a start as data says (`StartData`): the hall at the point, what the race builds on the closest gold
+ * Puts down what a start as data says (`StartingBaseData`): the hall at the point, what the race builds on the closest gold
  * mine (`onMine`) on it, and the workers and the other units in a row on the side of the hall that faces the mine,
  * facing it. With no mine in reach, the row faces north. A classic melee start; a race's `start` as data does this
  *
  * @beta
  */
-export declare function startingBase(world: World, player: PlayerId, at: Vec2, start: StartData): void;
+export declare function placeStartingBase(world: World, player: PlayerId, at: Vec2, start: StartingBaseData): void;
 /**
  * Puts down a player's start at a point, whichever form it is in: the code's `spawn`, or the base the data describes
  * (`startingBase`). Nothing for no start
  *
  * @beta
  */
-export declare function spawnStart(world: World, start: StartDef | undefined, player: PlayerId, at: Vec2): void;
-/** The unit type ids a start as data names, each with where it is said (`start.hall`, `start.units[1].type`); none for code */
-export declare function startIds(start: StartDef | undefined): {
+export declare function spawnStartingBase(world: World, start: StartingBase | undefined, player: PlayerId, at: Vec2): void;
+/** The unit type ids a start as data names, each with where it is said (`start.hall`, `startingBase.units[1].type`); none for code */
+export declare function startIds(start: StartingBase | undefined): {
     where: string;
     id: string;
 }[];

package/dist/start.js

@@ -0,0 +1,75 @@
+import { exactMath } from "./exactMath.js";
+import { dist } from "./math.js";
+//#region src/start.ts
+/** Whether a start is the data form */
+var isStartingBaseData = (start) => !("spawn" in start);
+/** How far the workers stand from their hall, and the angle between two of them, when the data does not say */
+var DISTANCE = 5;
+var SPREAD = .35;
+/**
+* Puts down what a start as data says (`StartingBaseData`): the hall at the point, what the race builds on the closest gold
+* mine (`onMine`) on it, and the workers and the other units in a row on the side of the hall that faces the mine,
+* facing it. With no mine in reach, the row faces north. A classic melee start; a race's `start` as data does this
+*
+* @beta
+*/
+function placeStartingBase(world, player, at, start) {
+	const hall = world.spawn(start.hall, player, at);
+	let nearest;
+	for (const entity of world.entities.values()) {
+		if (entity.def.resource?.id !== "gold") continue;
+		if (!nearest || dist(entity.pos, hall.pos) < dist(nearest.pos, hall.pos)) nearest = entity;
+	}
+	const mine = nearest && (dist(nearest.pos, hall.pos) <= 20 || start.onMine) ? nearest : void 0;
+	if (mine && start.onMine) world.spawn(start.onMine, player, mine.pos);
+	const angle = mine ? exactMath.atan2(mine.pos.x - hall.pos.x, mine.pos.z - hall.pos.z) : 0;
+	const types = [];
+	for (const { type, count } of [start.workers, ...start.units ?? []]) for (let i = 0; i < count; i++) types.push(type);
+	const distance = start.distance ?? DISTANCE;
+	const spread = start.spread ?? SPREAD;
+	types.forEach((type, i) => {
+		const side = (i - (types.length - 1) / 2) * spread;
+		world.spawn(type, player, {
+			x: hall.pos.x + exactMath.sin(angle + side) * distance,
+			z: hall.pos.z + exactMath.cos(angle + side) * distance
+		}, { facing: angle });
+	});
+}
+/**
+* Puts down a player's start at a point, whichever form it is in: the code's `spawn`, or the base the data describes
+* (`startingBase`). Nothing for no start
+*
+* @beta
+*/
+function spawnStartingBase(world, start, player, at) {
+	if (!start) return;
+	if (isStartingBaseData(start)) placeStartingBase(world, player, at, start);
+	else start.spawn(world, player, at);
+}
+/** The unit type ids a start as data names, each with where it is said (`start.hall`, `startingBase.units[1].type`); none for code */
+function startIds(start) {
+	if (!start || !isStartingBaseData(start)) return [];
+	const out = [
+		{
+			where: "startingBase.hall",
+			id: start.hall
+		},
+		{
+			where: "startingBase.workers.type",
+			id: start.workers.type
+		},
+		...(start.units ?? []).map((unit, index) => ({
+			where: `startingBase.units[${index}].type`,
+			id: unit.type
+		}))
+	];
+	if (start.onMine !== void 0) out.push({
+		where: "startingBase.onMine",
+		id: start.onMine
+	});
+	return out;
+}
+//#endregion
+export { isStartingBaseData, placeStartingBase, spawnStartingBase, startIds };
+
+//# sourceMappingURL=start.js.map

package/dist/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","names":[],"sources":["../src/start.ts"],"sourcesContent":["import type { Entity, PlayerId } from './entity'\nimport { exactMath } from './exactMath'\nimport { dist, type Vec2 } from './math'\nimport type { World } from './world'\n\n/*\n * What a player starts a map with (campaign plan RC1): a hall and workers put down at their start location, for players\n * the map places nothing for. As data (`StartingBaseData`: the hall, the workers, what else, all by unit type id, which is\n * what a race made in the editor's Data panel has, and what `checkRaces` can check), or as code (`StartingBaseCode`: a\n * function that puts down whatever it likes). `startingBase` is what the data form does, for code to call as well\n */\n\n/**\n * A start in code: puts down a base at the start location, whatever it likes\n *\n * @beta\n */\nexport interface StartingBaseCode {\n\t/** Puts down a base at the start location. Only for players the map places nothing for */\n\tspawn(world: World, player: PlayerId, at: Vec2): void\n}\n\n/**\n * A start as data: a hall at the start location and workers on the side of the closest gold mine, as in a classic melee\n * game (`startingBase` puts it down). Every id is a unit type of the game's (`checkRaces` says where one is not)\n *\n * @beta\n */\nexport interface StartingBaseData {\n\t/** The unit type put down at the start location: a town hall */\n\thall: string\n\t/** The workers put down beside it, facing the closest gold mine */\n\tworkers: { type: string; count: number }\n\t/** What else is put down with the workers, in the same row after them: a race's first fighter */\n\tunits?: { type: string; count: number }[]\n\t/**\n\t * What the race builds on the closest gold mine to gather it, put down there already standing (the undead's cursed\n\t * mine). With it, the closest mine is found at any distance; without, the workers face a mine within 20 cells\n\t */\n\tonMine?: string\n\t/** How far from the hall the workers stand: 5 cells when left out */\n\tdistance?: number\n\t/** The angle between two workers in the row, in radians: 0.35 when left out */\n\tspread?: number\n}\n\n/**\n * What each player gets at the beginning of a game on a map, for players the map places nothing for: as data\n * (`StartingBaseData`: a hall, workers and what else by unit type, editable in the Data panel) or as code (`StartingBaseCode`). What\n * they start with of each resource is in its `ResourceDef`\n *\n * @beta\n */\nexport type StartingBase = StartingBaseCode | StartingBaseData\n\n/** Whether a start is the data form */\nexport const isStartingBaseData = (start: StartingBase): start is StartingBaseData => !('spawn' in start)\n\n/** How far the workers stand from their hall, and the angle between two of them, when the data does not say */\nconst DISTANCE = 5\nconst SPREAD = 0.35\n\n/**\n * Puts down what a start as data says (`StartingBaseData`): the hall at the point, what the race builds on the closest gold\n * mine (`onMine`) on it, and the workers and the other units in a row on the side of the hall that faces the mine,\n * facing it. With no mine in reach, the row faces north. A classic melee start; a race's `start` as data does this\n *\n * @beta\n */\nexport function placeStartingBase(world: World, player: PlayerId, at: Vec2, start: StartingBaseData): void {\n\tconst hall = world.spawn(start.hall, player, at)\n\tlet nearest: Entity | undefined\n\tfor (const entity of world.entities.values()) {\n\t\tif (entity.def.resource?.id !== 'gold') continue\n\t\tif (!nearest || dist(entity.pos, hall.pos) < dist(nearest.pos, hall.pos)) nearest = entity\n\t}\n\t// the workers face a mine within 20 cells; a race that gathers at a building of its own puts that on the closest one at any distance\n\tconst mine = nearest && (dist(nearest.pos, hall.pos) <= 20 || start.onMine) ? nearest : undefined\n\tif (mine && start.onMine) world.spawn(start.onMine, player, mine.pos)\n\tconst angle = mine ? exactMath.atan2(mine.pos.x - hall.pos.x, mine.pos.z - hall.pos.z) : 0\n\tconst types: string[] = []\n\tfor (const { type, count } of [start.workers, ...(start.units ?? [])]) for (let i = 0; i < count; i++) types.push(type)\n\tconst distance = start.distance ?? DISTANCE\n\tconst spread = start.spread ?? SPREAD\n\ttypes.forEach((type, i) => {\n\t\tconst side = (i - (types.length - 1) / 2) * spread\n\t\tworld.spawn(\n\t\t\ttype,\n\t\t\tplayer,\n\t\t\t{ x: hall.pos.x + exactMath.sin(angle + side) * distance, z: hall.pos.z + exactMath.cos(angle + side) * distance },\n\t\t\t{ facing: angle }\n\t\t)\n\t})\n}\n\n/**\n * Puts down a player's start at a point, whichever form it is in: the code's `spawn`, or the base the data describes\n * (`startingBase`). Nothing for no start\n *\n * @beta\n */\nexport function spawnStartingBase(world: World, start: StartingBase | undefined, player: PlayerId, at: Vec2): void {\n\tif (!start) return\n\tif (isStartingBaseData(start)) placeStartingBase(world, player, at, start)\n\telse start.spawn(world, player, at)\n}\n\n/** The unit type ids a start as data names, each with where it is said (`start.hall`, `startingBase.units[1].type`); none for code */\nexport function startIds(start: StartingBase | undefined): { where: string; id: string }[] {\n\tif (!start || !isStartingBaseData(start)) return []\n\tconst out = [\n\t\t{ where: 'startingBase.hall', id: start.hall },\n\t\t{ where: 'startingBase.workers.type', id: start.workers.type },\n\t\t...(start.units ?? []).map((unit, index) => ({ where: `startingBase.units[${index}].type`, id: unit.type }))\n\t]\n\tif (start.onMine !== undefined) out.push({ where: 'startingBase.onMine', id: start.onMine })\n\treturn out\n}\n"],"mappings":";;;;AAwDA,IAAa,sBAAsB,UAAmD,EAAE,WAAW;;AAGnG,IAAM,WAAW;AACjB,IAAM,SAAS;;;;;;;;AASf,SAAgB,kBAAkB,OAAc,QAAkB,IAAU,OAA+B;CAC1G,MAAM,OAAO,MAAM,MAAM,MAAM,MAAM,QAAQ,EAAE;CAC/C,IAAI;CACJ,KAAK,MAAM,UAAU,MAAM,SAAS,OAAO,GAAG;EAC7C,IAAI,OAAO,IAAI,UAAU,OAAO,QAAQ;EACxC,IAAI,CAAC,WAAW,KAAK,OAAO,KAAK,KAAK,GAAG,IAAI,KAAK,QAAQ,KAAK,KAAK,GAAG,GAAG,UAAU;CACrF;CAEA,MAAM,OAAO,YAAY,KAAK,QAAQ,KAAK,KAAK,GAAG,KAAK,MAAM,MAAM,UAAU,UAAU,KAAA;CACxF,IAAI,QAAQ,MAAM,QAAQ,MAAM,MAAM,MAAM,QAAQ,QAAQ,KAAK,GAAG;CACpE,MAAM,QAAQ,OAAO,UAAU,MAAM,KAAK,IAAI,IAAI,KAAK,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI;CACzF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC,MAAM,SAAS,GAAI,MAAM,SAAS,CAAC,CAAE,GAAG,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,KAAK,MAAM,KAAK,IAAI;CACtH,MAAM,WAAW,MAAM,YAAY;CACnC,MAAM,SAAS,MAAM,UAAU;CAC/B,MAAM,SAAS,MAAM,MAAM;EAC1B,MAAM,QAAQ,KAAK,MAAM,SAAS,KAAK,KAAK;EAC5C,MAAM,MACL,MACA,QACA;GAAE,GAAG,KAAK,IAAI,IAAI,UAAU,IAAI,QAAQ,IAAI,IAAI;GAAU,GAAG,KAAK,IAAI,IAAI,UAAU,IAAI,QAAQ,IAAI,IAAI;EAAS,GACjH,EAAE,QAAQ,MAAM,CACjB;CACD,CAAC;AACF;;;;;;;AAQA,SAAgB,kBAAkB,OAAc,OAAiC,QAAkB,IAAgB;CAClH,IAAI,CAAC,OAAO;CACZ,IAAI,mBAAmB,KAAK,GAAG,kBAAkB,OAAO,QAAQ,IAAI,KAAK;MACpE,MAAM,MAAM,OAAO,QAAQ,EAAE;AACnC;;AAGA,SAAgB,SAAS,OAAkE;CAC1F,IAAI,CAAC,SAAS,CAAC,mBAAmB,KAAK,GAAG,OAAO,CAAC;CAClD,MAAM,MAAM;EACX;GAAE,OAAO;GAAqB,IAAI,MAAM;EAAK;EAC7C;GAAE,OAAO;GAA6B,IAAI,MAAM,QAAQ;EAAK;EAC7D,IAAI,MAAM,SAAS,CAAC,EAAA,CAAG,KAAK,MAAM,WAAW;GAAE,OAAO,sBAAsB,MAAM;GAAS,IAAI,KAAK;EAAK,EAAE;CAC5G;CACA,IAAI,MAAM,WAAW,KAAA,GAAW,IAAI,KAAK;EAAE,OAAO;EAAuB,IAAI,MAAM;CAAO,CAAC;CAC3F,OAAO;AACR"}