@civ-clone/base-unit-lifecycle 0.0.0-stage → 0.1.0

package/lib/destroyed.ts

@@ -0,0 +1,106 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import { ITransport } from '@civ-clone/core-unit-transport/Transport';
+import Player from '@civ-clone/core-player/Player';
+import Stowed from '@civ-clone/base-unit-action-embark/Busy/Stowed';
+import TransportManifest from '@civ-clone/core-unit-transport/TransportManifest';
+import TransportRegistry from '@civ-clone/core-unit-transport/TransportRegistry';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovementRegistry from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+import UnitLossRegistry from '@civ-clone/core-unit/UnitLossRegistry';
+import { Water } from '@civ-clone/core-terrain/Types';
+
+// What a ruleset's `Destroyed` rules ask and do when `unit` is destroyed. `player` destroyed it, or is `null` when no
+//  one did (disbanding, founding or joining a city, a spent unit...).
+
+// Emits `unit:destroyed` with the unit and the player who destroyed it.
+export const emitDestroyed =
+  (engine: Engine) =>
+  (unit: Unit, player: Player | null): void => {
+    engine.emit('unit:destroyed', unit, player);
+  };
+
+// Another player destroyed the unit.
+export const destroyedByAnother = (
+  unit: Unit,
+  player: Player | null
+): boolean => player !== null && player !== unit.player();
+
+// The unit isn't marked destroyed yet: a rule that should act once per unit asks it before `deactivate` runs.
+export const notYetDestroyed = (unit: Unit): boolean => !unit.destroyed();
+
+// Records the unit's type as a loss of its player's in `unitLossRegistry`.
+export const countLoss =
+  (unitLossRegistry: UnitLossRegistry) =>
+  (unit: Unit): void => {
+    unitLossRegistry.record(unit.player(), unit.sourceClass() as typeof Unit);
+  };
+
+// Makes the unit inactive and marks it destroyed.
+export const deactivate = (unit: Unit): void => {
+  unit.setActive(false);
+  unit.setDestroyed();
+};
+
+// Removes the unit's improvements (veteran status, fortification...).
+export const removeImprovements =
+  (unitImprovementRegistry: UnitImprovementRegistry) =>
+  (unit: Unit): void =>
+    unitImprovementRegistry
+      .getByUnit(unit)
+      .forEach((unitImprovement) =>
+        unitImprovementRegistry.unregister(unitImprovement)
+      );
+
+// Takes a unit off its transport. Nothing clears `Stowed` on its own (its criterion is `() => false`), so a unit taken
+//  off a transport, destroyed or not, would otherwise stay stowed aboard nothing.
+export const leaveTransport =
+  (transportRegistry: TransportRegistry) =>
+  (manifest: TransportManifest): void => {
+    const cargo = manifest.unit();
+
+    transportRegistry.unregister(manifest);
+
+    if (cargo.busy() instanceof Stowed) {
+      cargo.setBusy();
+    }
+  };
+
+// The unit is a transport with something aboard.
+export const carriesCargo =
+  (transportRegistry: TransportRegistry) =>
+  (unit: Unit): boolean =>
+    transportRegistry.getByTransport(unit as unknown as ITransport).length > 0;
+
+// Takes everything off the transport (`leaveTransport`). At sea (on `Water`) the cargo goes down with it, destroyed by
+//  `player`; in a city it stays in the city.
+export const loseCargo = (transportRegistry: TransportRegistry) => {
+  const leave = leaveTransport(transportRegistry);
+
+  return (unit: Unit, player: Player | null): void =>
+    transportRegistry
+      .getByTransport(unit as unknown as ITransport)
+      // A copy: unregistering changes the list.
+      .slice()
+      .forEach((manifest: TransportManifest): void => {
+        const cargo = manifest.unit();
+
+        leave(manifest);
+
+        if (unit.tile().terrain() instanceof Water && !cargo.destroyed()) {
+          cargo.destroy(player);
+        }
+      });
+};
+
+// The unit is aboard a transport.
+export const isAboard =
+  (transportRegistry: TransportRegistry) =>
+  (unit: Unit): boolean =>
+    transportRegistry.hasUnit(unit);
+
+// Takes the unit off the transport it's aboard (`leaveTransport`).
+export const leaveOwnTransport = (transportRegistry: TransportRegistry) => {
+  const leave = leaveTransport(transportRegistry);
+
+  return (unit: Unit): void => leave(transportRegistry.getByUnit(unit));
+};

package/lib/halted.d.ts

@@ -0,0 +1,6 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const emitHalted: (
+  engine: Engine
+) => (unit: Unit, target: Tile) => void;

package/lib/halted.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitHalted = void 0;
+// Emits `unit:halted` with the unit and its destination: a GoTo stopped next to it, for the player to choose what to
+//  do there.
+const emitHalted = (engine) => (unit, target) => {
+    engine.emit('unit:halted', unit, target);
+};
+exports.emitHalted = emitHalted;
+//# sourceMappingURL=halted.js.map

package/lib/halted.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"halted.js","sourceRoot":"","sources":["halted.ts"],"names":[],"mappings":";;;AAIA,qHAAqH;AACrH,aAAa;AACN,MAAM,UAAU,GACrB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAU,EAAE,MAAY,EAAQ,EAAE;IACjC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC,CAAC;AAJS,QAAA,UAAU,cAInB"}

package/lib/halted.ts

@@ -0,0 +1,11 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+
+// Emits `unit:halted` with the unit and its destination: a GoTo stopped next to it, for the player to choose what to
+//  do there.
+export const emitHalted =
+  (engine: Engine) =>
+  (unit: Unit, target: Tile): void => {
+    engine.emit('unit:halted', unit, target);
+  };

package/lib/impassable.d.ts

@@ -0,0 +1,8 @@
+import { PartnerOf } from '@civ-clone/base-unit-action-rules/lib/criteria/partners';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const fromLand: (unit: Unit, to: Tile, from: Tile) => boolean;
+export declare const toPartnersLand: (
+  partnerOf: PartnerOf
+) => (unit: Unit, to: Tile) => boolean;
+export declare const impassable: () => boolean;

package/lib/impassable.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.impassable = exports.toPartnersLand = exports.fromLand = void 0;
+// What a ruleset's `Impassable` rules ask, so that routes (a GoTo, a computer player's route) go round a treaty
+//  partner's land and following one never breaks a treaty by accident.
+// The step starts on land.
+const fromLand = (unit, to, from) => from.isLand();
+exports.fromLand = fromLand;
+// `to` is a treaty partner's land: `partnerOf` is the ruleset's territory model.
+const toPartnersLand = (partnerOf) => (unit, to) => partnerOf(unit, to) !== null;
+exports.toPartnersLand = toPartnersLand;
+// The tile is impassable.
+const impassable = () => true;
+exports.impassable = impassable;
+//# sourceMappingURL=impassable.js.map

package/lib/impassable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"impassable.js","sourceRoot":"","sources":["impassable.ts"],"names":[],"mappings":";;;AAIA,gHAAgH;AAChH,uEAAuE;AAEvE,2BAA2B;AACpB,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAE,EAAQ,EAAE,IAAU,EAAW,EAAE,CACpE,IAAI,CAAC,MAAM,EAAE,CAAC;AADH,QAAA,QAAQ,YACL;AAEhB,iFAAiF;AAC1E,MAAM,cAAc,GACzB,CAAC,SAAoB,EAAE,EAAE,CACzB,CAAC,IAAU,EAAE,EAAQ,EAAW,EAAE,CAChC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC;AAHpB,QAAA,cAAc,kBAGM;AAEjC,0BAA0B;AACnB,MAAM,UAAU,GAAG,GAAY,EAAE,CAAC,IAAI,CAAC;AAAjC,QAAA,UAAU,cAAuB"}

package/lib/impassable.ts

@@ -0,0 +1,19 @@
+import { PartnerOf } from '@civ-clone/base-unit-action-rules/lib/criteria/partners';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+
+// What a ruleset's `Impassable` rules ask, so that routes (a GoTo, a computer player's route) go round a treaty
+//  partner's land and following one never breaks a treaty by accident.
+
+// The step starts on land.
+export const fromLand = (unit: Unit, to: Tile, from: Tile): boolean =>
+  from.isLand();
+
+// `to` is a treaty partner's land: `partnerOf` is the ruleset's territory model.
+export const toPartnersLand =
+  (partnerOf: PartnerOf) =>
+  (unit: Unit, to: Tile): boolean =>
+    partnerOf(unit, to) !== null;
+
+// The tile is impassable.
+export const impassable = (): boolean => true;

package/lib/lostAtSea.d.ts

@@ -0,0 +1,12 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import { ITransport } from '@civ-clone/core-unit-transport/Transport';
+import TransportRegistry from '@civ-clone/core-unit-transport/TransportRegistry';
+import UnitLossRegistry from '@civ-clone/core-unit/UnitLossRegistry';
+export declare const emitLostAtSea: (
+  engine: Engine
+) => (unit: ITransport) => void;
+export declare const countLosses: (
+  unitLossRegistry: UnitLossRegistry,
+  transportRegistry: TransportRegistry
+) => (transport: ITransport) => void;
+export declare const sink: (unit: ITransport) => void;

package/lib/lostAtSea.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sink = exports.countLosses = exports.emitLostAtSea = void 0;
+// What a ruleset's `LostAtSea` rules do when a transport is lost at sea.
+// Emits `unit:lost-at-sea` with the transport.
+const emitLostAtSea = (engine) => (unit) => {
+    engine.emit('unit:lost-at-sea', unit);
+};
+exports.emitLostAtSea = emitLostAtSea;
+// Records the transport and everything aboard that isn't destroyed yet as losses of their players, though no one
+//  destroyed them. Run it before `sink`, while the manifests still say what's aboard.
+const countLosses = (unitLossRegistry, transportRegistry) => (transport) => [
+    transport,
+    ...transportRegistry
+        .getByTransport(transport)
+        .map((manifest) => manifest.unit()),
+]
+    .filter((unit) => !unit.destroyed())
+    .forEach((unit) => {
+    unitLossRegistry.record(unit.player(), unit.sourceClass());
+});
+exports.countLosses = countLosses;
+// Destroys the transport, by no one.
+const sink = (unit) => unit.destroy(null);
+exports.sink = sink;
+//# sourceMappingURL=lostAtSea.js.map

package/lib/lostAtSea.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lostAtSea.js","sourceRoot":"","sources":["lostAtSea.ts"],"names":[],"mappings":";;;AAOA,yEAAyE;AAEzE,+CAA+C;AACxC,MAAM,aAAa,GACxB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAgB,EAAQ,EAAE;IACzB,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC,CAAC;AAJS,QAAA,aAAa,iBAItB;AAEJ,iHAAiH;AACjH,sFAAsF;AAC/E,MAAM,WAAW,GACtB,CAAC,gBAAkC,EAAE,iBAAoC,EAAE,EAAE,CAC7E,CAAC,SAAqB,EAAQ,EAAE,CAC9B;IACE,SAA4B;IAC5B,GAAG,iBAAiB;SACjB,cAAc,CAAC,SAAS,CAAC;SACzB,GAAG,CAAC,CAAC,QAA2B,EAAQ,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;CAC/D;KACE,MAAM,CAAC,CAAC,IAAU,EAAW,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;KAClD,OAAO,CAAC,CAAC,IAAU,EAAQ,EAAE;IAC5B,gBAAgB,CAAC,MAAM,CACrB,IAAI,CAAC,MAAM,EAAE,EACb,IAAI,CAAC,WAAW,EAAiB,CAClC,CAAC;AACJ,CAAC,CAAC,CAAC;AAfI,QAAA,WAAW,eAef;AAET,qCAAqC;AAC9B,MAAM,IAAI,GAAG,CAAC,IAAgB,EAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAAtD,QAAA,IAAI,QAAkD"}

package/lib/lostAtSea.ts

@@ -0,0 +1,37 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import { ITransport } from '@civ-clone/core-unit-transport/Transport';
+import TransportManifest from '@civ-clone/core-unit-transport/TransportManifest';
+import TransportRegistry from '@civ-clone/core-unit-transport/TransportRegistry';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitLossRegistry from '@civ-clone/core-unit/UnitLossRegistry';
+
+// What a ruleset's `LostAtSea` rules do when a transport is lost at sea.
+
+// Emits `unit:lost-at-sea` with the transport.
+export const emitLostAtSea =
+  (engine: Engine) =>
+  (unit: ITransport): void => {
+    engine.emit('unit:lost-at-sea', unit);
+  };
+
+// Records the transport and everything aboard that isn't destroyed yet as losses of their players, though no one
+//  destroyed them. Run it before `sink`, while the manifests still say what's aboard.
+export const countLosses =
+  (unitLossRegistry: UnitLossRegistry, transportRegistry: TransportRegistry) =>
+  (transport: ITransport): void =>
+    [
+      transport as unknown as Unit,
+      ...transportRegistry
+        .getByTransport(transport)
+        .map((manifest: TransportManifest): Unit => manifest.unit()),
+    ]
+      .filter((unit: Unit): boolean => !unit.destroyed())
+      .forEach((unit: Unit): void => {
+        unitLossRegistry.record(
+          unit.player(),
+          unit.sourceClass() as typeof Unit
+        );
+      });
+
+// Destroys the transport, by no one.
+export const sink = (unit: ITransport): void => unit.destroy(null);

package/lib/playerAction.d.ts

@@ -0,0 +1,22 @@
+import Player from '@civ-clone/core-player/Player';
+import PlayerAction from '@civ-clone/core-player/PlayerAction';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+export type UnitPlayerActionType<T extends PlayerAction> = new (
+  player: Player,
+  unit: Unit
+) => T;
+export declare const hasActiveUnits: (
+  unitRegistry: UnitRegistry
+) => (player: Player) => boolean;
+export declare const activeUnits: <T extends PlayerAction<any>>(
+  unitRegistry: UnitRegistry,
+  PlayerActionType: UnitPlayerActionType<T>
+) => (player: Player) => T[];
+export declare const hasInactiveUnits: (
+  unitRegistry: UnitRegistry
+) => (player: Player) => boolean;
+export declare const inactiveUnits: <T extends PlayerAction<any>>(
+  unitRegistry: UnitRegistry,
+  PlayerActionType: UnitPlayerActionType<T>
+) => (player: Player) => T[];

package/lib/playerAction.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inactiveUnits = exports.hasInactiveUnits = exports.activeUnits = exports.hasActiveUnits = void 0;
+// The player has an active unit with moves left.
+const hasActiveUnits = (unitRegistry) => (player) => unitRegistry
+    .getByPlayer(player)
+    .some((unit) => unit.active() && unit.moves().value());
+exports.hasActiveUnits = hasActiveUnits;
+// The player's active units with moves left, as `PlayerActionType`s.
+const activeUnits = (unitRegistry, PlayerActionType) => (player) => unitRegistry
+    .getByPlayer(player)
+    .filter((unit) => unit.active() && unit.moves().value() > 0)
+    .sort((a, b) => (a.waiting() ? 1 : 0) - (b.waiting() ? 1 : 0))
+    .map((unit) => new PlayerActionType(player, unit));
+exports.activeUnits = activeUnits;
+// The player has a unit that is inactive or has no moves left.
+const hasInactiveUnits = (unitRegistry) => (player) => unitRegistry
+    .getByPlayer(player)
+    .some((unit) => !unit.active() || !unit.moves().value());
+exports.hasInactiveUnits = hasInactiveUnits;
+// The player's units that are inactive or have no moves left, as `PlayerActionType`s.
+const inactiveUnits = (unitRegistry, PlayerActionType) => (player) => unitRegistry
+    .getByPlayer(player)
+    .filter((unit) => !unit.active() || unit.moves().value() === 0)
+    .sort((a, b) => (a.waiting() ? 1 : 0) - (b.waiting() ? 1 : 0))
+    .map((unit) => new PlayerActionType(player, unit));
+exports.inactiveUnits = inactiveUnits;
+//# sourceMappingURL=playerAction.js.map

package/lib/playerAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playerAction.js","sourceRoot":"","sources":["playerAction.ts"],"names":[],"mappings":";;;AAeA,iDAAiD;AAC1C,MAAM,cAAc,GACzB,CAAC,YAA0B,EAAE,EAAE,CAC/B,CAAC,MAAc,EAAW,EAAE,CAC1B,YAAY;KACT,WAAW,CAAC,MAAM,CAAC;KACnB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;AALhD,QAAA,cAAc,kBAKkC;AAE7D,qEAAqE;AAC9D,MAAM,WAAW,GACtB,CACE,YAA0B,EAC1B,gBAAyC,EACzC,EAAE,CACJ,CAAC,MAAc,EAAO,EAAE,CACtB,YAAY;KACT,WAAW,CAAC,MAAM,CAAC;KACnB,MAAM,CACL,CAAC,IAAU,EAAW,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CACnE;KACA,IAAI,CACH,CAAC,CAAO,EAAE,CAAO,EAAU,EAAE,CAC3B,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAChD;KACA,GAAG,CAAC,CAAC,IAAU,EAAK,EAAE,CAAC,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAfrD,QAAA,WAAW,eAe0C;AAElE,+DAA+D;AACxD,MAAM,gBAAgB,GAC3B,CAAC,YAA0B,EAAE,EAAE,CAC/B,CAAC,MAAc,EAAW,EAAE,CAC1B,YAAY;KACT,WAAW,CAAC,MAAM,CAAC;KACnB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;AALlD,QAAA,gBAAgB,oBAKkC;AAE/D,sFAAsF;AAC/E,MAAM,aAAa,GACxB,CACE,YAA0B,EAC1B,gBAAyC,EACzC,EAAE,CACJ,CAAC,MAAc,EAAO,EAAE,CACtB,YAAY;KACT,WAAW,CAAC,MAAM,CAAC;KACnB,MAAM,CAAC,CAAC,IAAU,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;KACpE,IAAI,CACH,CAAC,CAAO,EAAE,CAAO,EAAU,EAAE,CAC3B,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAChD;KACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAb5C,QAAA,aAAa,iBAa+B"}

package/lib/playerAction.ts

@@ -0,0 +1,64 @@
+import Player from '@civ-clone/core-player/Player';
+import PlayerAction from '@civ-clone/core-player/PlayerAction';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+
+// What a ruleset's player `Action` rules ask and offer: the player's units that can take orders this turn, and those
+//  that can't. Each list puts waiting units last and otherwise keeps the registry's order. `PlayerActionType` is the
+//  player action each unit is offered as (an active unit, an inactive one).
+
+// The constructor of a player action for one unit.
+export type UnitPlayerActionType<T extends PlayerAction> = new (
+  player: Player,
+  unit: Unit
+) => T;
+
+// The player has an active unit with moves left.
+export const hasActiveUnits =
+  (unitRegistry: UnitRegistry) =>
+  (player: Player): boolean =>
+    unitRegistry
+      .getByPlayer(player)
+      .some((unit) => unit.active() && unit.moves().value());
+
+// The player's active units with moves left, as `PlayerActionType`s.
+export const activeUnits =
+  <T extends PlayerAction>(
+    unitRegistry: UnitRegistry,
+    PlayerActionType: UnitPlayerActionType<T>
+  ) =>
+  (player: Player): T[] =>
+    unitRegistry
+      .getByPlayer(player)
+      .filter(
+        (unit: Unit): boolean => unit.active() && unit.moves().value() > 0
+      )
+      .sort(
+        (a: Unit, b: Unit): number =>
+          (a.waiting() ? 1 : 0) - (b.waiting() ? 1 : 0)
+      )
+      .map((unit: Unit): T => new PlayerActionType(player, unit));
+
+// The player has a unit that is inactive or has no moves left.
+export const hasInactiveUnits =
+  (unitRegistry: UnitRegistry) =>
+  (player: Player): boolean =>
+    unitRegistry
+      .getByPlayer(player)
+      .some((unit) => !unit.active() || !unit.moves().value());
+
+// The player's units that are inactive or have no moves left, as `PlayerActionType`s.
+export const inactiveUnits =
+  <T extends PlayerAction>(
+    unitRegistry: UnitRegistry,
+    PlayerActionType: UnitPlayerActionType<T>
+  ) =>
+  (player: Player): T[] =>
+    unitRegistry
+      .getByPlayer(player)
+      .filter((unit: Unit) => !unit.active() || unit.moves().value() === 0)
+      .sort(
+        (a: Unit, b: Unit): number =>
+          (a.waiting() ? 1 : 0) - (b.waiting() ? 1 : 0)
+      )
+      .map((unit) => new PlayerActionType(player, unit));

package/lib/stowed.d.ts

@@ -0,0 +1,2 @@
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const sleepAboard: (unit: Unit) => void;

package/lib/stowed.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleepAboard = void 0;
+const Sleep_1 = require("@civ-clone/base-unit-action-sleep/Sleep");
+// A unit that has just boarded a transport sleeps aboard it. Returns what `unit.action` returns.
+const sleepAboard = (unit) => unit.action(new Sleep_1.default(unit.tile(), unit.tile(), unit));
+exports.sleepAboard = sleepAboard;
+//# sourceMappingURL=stowed.js.map

package/lib/stowed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stowed.js","sourceRoot":"","sources":["stowed.ts"],"names":[],"mappings":";;;AAAA,mEAA4D;AAG5D,iGAAiG;AAC1F,MAAM,WAAW,GAAG,CAAC,IAAU,EAAE,EAAE,CACxC,IAAI,CAAC,MAAM,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;AAD5C,QAAA,WAAW,eACiC"}

package/lib/stowed.ts

@@ -0,0 +1,6 @@
+import Sleep from '@civ-clone/base-unit-action-sleep/Sleep';
+import Unit from '@civ-clone/core-unit/Unit';
+
+// A unit that has just boarded a transport sleeps aboard it. Returns what `unit.action` returns.
+export const sleepAboard = (unit: Unit) =>
+  unit.action(new Sleep(unit.tile(), unit.tile(), unit));

package/lib/unsupported.d.ts

@@ -0,0 +1,6 @@
+import City from '@civ-clone/core-city/City';
+import Engine from '@civ-clone/core-engine/Engine';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const emitUnsupported: (
+  engine: Engine
+) => (city: City, unit: Unit) => void;

package/lib/unsupported.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitUnsupported = void 0;
+// Emits `unit:unsupported` with the city that could no longer support the unit, and the unit.
+const emitUnsupported = (engine) => (city, unit) => {
+    engine.emit('unit:unsupported', city, unit);
+};
+exports.emitUnsupported = emitUnsupported;
+//# sourceMappingURL=unsupported.js.map

package/lib/unsupported.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported.js","sourceRoot":"","sources":["unsupported.ts"],"names":[],"mappings":";;;AAIA,8FAA8F;AACvF,MAAM,eAAe,GAC1B,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAU,EAAE,IAAU,EAAQ,EAAE;IAC/B,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC,CAAC;AAJS,QAAA,eAAe,mBAIxB"}

package/lib/unsupported.ts

@@ -0,0 +1,10 @@
+import City from '@civ-clone/core-city/City';
+import Engine from '@civ-clone/core-engine/Engine';
+import Unit from '@civ-clone/core-unit/Unit';
+
+// Emits `unit:unsupported` with the city that could no longer support the unit, and the unit.
+export const emitUnsupported =
+  (engine: Engine) =>
+  (city: City, unit: Unit): void => {
+    engine.emit('unit:unsupported', city, unit);
+  };

package/lib/validateMove.d.ts

@@ -0,0 +1,11 @@
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const hasMovesFor: (unit: Unit, movementCost: number) => boolean;
+export declare const spendMoves: (unit: Unit, movementCost: number) => boolean;
+export declare const shortOfMovesFor: (
+  unit: Unit,
+  movementCost: number
+) => boolean;
+export declare const spendShort: (
+  shortfallFactor: number,
+  randomNumberGenerator: () => number
+) => (unit: Unit, movementCost: number) => boolean;

package/lib/validateMove.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spendShort = exports.shortOfMovesFor = exports.spendMoves = exports.hasMovesFor = void 0;
+const moveShortfall_1 = require("@civ-clone/base-unit-action-rules/lib/moveShortfall");
+// What a ruleset's `ValidateMove` rules ask and do when `unit` makes a step costing `movementCost` moves.
+// The unit has the moves the step costs.
+const hasMovesFor = (unit, movementCost) => unit.moves().value() >= movementCost;
+exports.hasMovesFor = hasMovesFor;
+// Spends the moves the step costs. The step succeeds.
+const spendMoves = (unit, movementCost) => {
+    unit.moves().subtract(movementCost);
+    return true;
+};
+exports.spendMoves = spendMoves;
+// The unit is short of the moves the step costs.
+const shortOfMovesFor = (unit, movementCost) => unit.moves().value() < movementCost;
+exports.shortOfMovesFor = shortOfMovesFor;
+// Spends all the unit's remaining moves on a step it is short of moves for, and says whether it gets there
+//  (`succeedsShort`, with `shortfallFactor` and a draw of `randomNumberGenerator`).
+const spendShort = (shortfallFactor, randomNumberGenerator) => (unit, movementCost) => {
+    const remainingMoves = unit.moves().value();
+    unit.moves().set(0);
+    return (0, moveShortfall_1.succeedsShort)(remainingMoves, movementCost, shortfallFactor, randomNumberGenerator);
+};
+exports.spendShort = spendShort;
+//# sourceMappingURL=validateMove.js.map

package/lib/validateMove.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateMove.js","sourceRoot":"","sources":["validateMove.ts"],"names":[],"mappings":";;;AACA,uFAAoF;AAEpF,0GAA0G;AAE1G,yCAAyC;AAClC,MAAM,WAAW,GAAG,CAAC,IAAU,EAAE,YAAoB,EAAW,EAAE,CACvE,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,IAAI,YAAY,CAAC;AAD1B,QAAA,WAAW,eACe;AAEvC,sDAAsD;AAC/C,MAAM,UAAU,GAAG,CAAC,IAAU,EAAE,YAAoB,EAAW,EAAE;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEpC,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAJW,QAAA,UAAU,cAIrB;AAEF,iDAAiD;AAC1C,MAAM,eAAe,GAAG,CAAC,IAAU,EAAE,YAAoB,EAAW,EAAE,CAC3E,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC;AADzB,QAAA,eAAe,mBACU;AAEtC,2GAA2G;AAC3G,oFAAoF;AAC7E,MAAM,UAAU,GACrB,CAAC,eAAuB,EAAE,qBAAmC,EAAE,EAAE,CACjE,CAAC,IAAU,EAAE,YAAoB,EAAW,EAAE;IAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IAE5C,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEpB,OAAO,IAAA,6BAAa,EAClB,cAAc,EACd,YAAY,EACZ,eAAe,EACf,qBAAqB,CACtB,CAAC;AACJ,CAAC,CAAC;AAbS,QAAA,UAAU,cAanB"}

package/lib/validateMove.ts

@@ -0,0 +1,36 @@
+import Unit from '@civ-clone/core-unit/Unit';
+import { succeedsShort } from '@civ-clone/base-unit-action-rules/lib/moveShortfall';
+
+// What a ruleset's `ValidateMove` rules ask and do when `unit` makes a step costing `movementCost` moves.
+
+// The unit has the moves the step costs.
+export const hasMovesFor = (unit: Unit, movementCost: number): boolean =>
+  unit.moves().value() >= movementCost;
+
+// Spends the moves the step costs. The step succeeds.
+export const spendMoves = (unit: Unit, movementCost: number): boolean => {
+  unit.moves().subtract(movementCost);
+
+  return true;
+};
+
+// The unit is short of the moves the step costs.
+export const shortOfMovesFor = (unit: Unit, movementCost: number): boolean =>
+  unit.moves().value() < movementCost;
+
+// Spends all the unit's remaining moves on a step it is short of moves for, and says whether it gets there
+//  (`succeedsShort`, with `shortfallFactor` and a draw of `randomNumberGenerator`).
+export const spendShort =
+  (shortfallFactor: number, randomNumberGenerator: () => number) =>
+  (unit: Unit, movementCost: number): boolean => {
+    const remainingMoves = unit.moves().value();
+
+    unit.moves().set(0);
+
+    return succeedsShort(
+      remainingMoves,
+      movementCost,
+      shortfallFactor,
+      randomNumberGenerator
+    );
+  };

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@civ-clone/base-unit-lifecycle",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Building blocks for a ruleset's unit lifecycle rules: what happens when a unit is created, activated, moved, stowed aboard a transport, halted, defeated, destroyed, lost at sea or left unsupported, and which of a player's units can take orders. The ruleset keeps its own rules, ids and order, and builds their criteria and effects from these.",
+  "repository": "git@github.com:civ-clone/base-unit-lifecycle.git",
+  "keywords": [
+    "typescript",
+    "civilization"
+  ],
+  "author": "dom111 <dom111@users.noreply.github.com>",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "npm run ts:compile && npm run prettier:format",
+    "prettier:check": "prettier --config .prettierrc --check '**/*.ts'",
+    "prettier:format": "prettier --config .prettierrc '**/*.ts' --write",
+    "test": "ts-mocha ./tests/*.test.ts",
+    "ts:compile": "tsc --build tsconfig.json"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.0.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^16.0.0",
+    "chai": "^4.0.0",
+    "mocha": "^10.0.0",
+    "prettier": "^2.8.8",
+    "ts-mocha": "^10.0.0",
+    "typescript": "^4.0.0"
+  },
+  "dependencies": {
+    "@civ-clone/base-unit-action-embark": "^0.1.0",
+    "@civ-clone/base-unit-action-rules": "^0.1.5",
+    "@civ-clone/base-unit-action-sleep": "^0.1.0",
+    "@civ-clone/base-unit-trait-carries": "^0.1.0",
+    "@civ-clone/core-city": "^0.1.19",
+    "@civ-clone/core-engine": "^0.1.0",
+    "@civ-clone/core-player": "^0.1.0",
+    "@civ-clone/core-rule": "^0.1.9",
+    "@civ-clone/core-terrain": "^0.1.0",
+    "@civ-clone/core-unit": "^0.1.31",
+    "@civ-clone/core-unit-improvement": "^0.1.0",
+    "@civ-clone/core-unit-transport": "^0.1.8",
+    "@civ-clone/core-world": "^0.1.0"
+  }
+}