@civ-clone/base-unit-lifecycle 0.1.0 → 0.1.2

package/lib/lifecycleRules.d.ts

@@ -0,0 +1,121 @@
+import { CityRegistry } from '@civ-clone/core-city/CityRegistry';
+import { Engine } from '@civ-clone/core-engine/Engine';
+import { RuleRegistry } from '@civ-clone/core-rule/RuleRegistry';
+import { TransportRegistry } from '@civ-clone/core-unit-transport/TransportRegistry';
+import { UnitImprovementRegistry } from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+import { UnitLossRegistry } from '@civ-clone/core-unit/UnitLossRegistry';
+import { UnitPlayerActionType } from './playerAction';
+import { UnitRegistry } from '@civ-clone/core-unit/UnitRegistry';
+import { SparesStack } from './defeated';
+import Action from '@civ-clone/core-player/Rules/Action';
+import Activate from '@civ-clone/core-unit/Rules/Activate';
+import CanStow from '@civ-clone/core-unit-transport/Rules/CanStow';
+import Created from '@civ-clone/core-unit/Rules/Created';
+import Defeated from '@civ-clone/core-unit/Rules/Defeated';
+import Destroyed from '@civ-clone/core-unit/Rules/Destroyed';
+import ExpectedMovementCost from '@civ-clone/core-world-path/Rules/ExpectedMovementCost';
+import Halted from '@civ-clone/base-unit-action-goto/Rules/Halted';
+import Impassable from '@civ-clone/core-world-path/Rules/Impassable';
+import LostAtSea from '@civ-clone/core-unit-transport/Rules/LostAtSea';
+import Player from '@civ-clone/core-player/Player';
+import PlayerAction from '@civ-clone/core-player/PlayerAction';
+import Stowed from '@civ-clone/core-unit-transport/Rules/Stowed';
+import Tile from '@civ-clone/core-world/Tile';
+import Transferred from '@civ-clone/core-unit/Rules/Transferred';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovement from '@civ-clone/core-unit-improvement/UnitImprovement';
+import Unsupported from '@civ-clone/core-unit/Rules/Unsupported';
+import ValidateMove from '@civ-clone/core-unit/Rules/ValidateMove';
+export interface LifecycleDependencies {
+  cityRegistry?: CityRegistry;
+  engine?: Engine;
+  randomNumberGenerator?: () => number;
+  ruleRegistry?: RuleRegistry;
+  transportRegistry?: TransportRegistry;
+  unitImprovementRegistry?: UnitImprovementRegistry;
+  unitLossRegistry?: UnitLossRegistry;
+  unitRegistry?: UnitRegistry;
+}
+export interface LifecycleBaseOptions {
+  ActiveUnit: UnitPlayerActionType<PlayerAction>;
+  InactiveUnit: UnitPlayerActionType<PlayerAction>;
+  removedOnActivate: (typeof UnitImprovement)[];
+  stowable: (typeof Unit)[];
+  partnerOf?: (unit: Unit, tile: Tile) => Player | null;
+  sparesStack?: SparesStack;
+}
+/**
+ * How a unit short of a step's moves fares: Civ1's `shortfallFactor` (`spendShort`), or a ruleset's own `shortStep`,
+ *  which then needs no factor.
+ */
+export type LifecycleOptions = LifecycleBaseOptions &
+  (
+    | {
+        shortfallFactor: number;
+        shortStep?: undefined;
+      }
+    | {
+        shortfallFactor?: number;
+        shortStep: ShortStep;
+      }
+  );
+/**
+ * A ruleset's own short step: whether `unit`, with `remaining` of its `movement` moves, gets onto a square costing
+ *  `cost` (one draw of `randomNumberGenerator` at most), and what such a step is worth on average to route planning.
+ *  The unit's moves are spent either way.
+ */
+export interface ShortStep {
+  succeeds: (
+    unit: Unit,
+    remaining: number,
+    movement: number,
+    cost: number,
+    randomNumberGenerator: () => number
+  ) => boolean;
+  expectedCost: (movement: number, cost: number) => number;
+}
+/**
+ * A ruleset's unit lifecycle rules, by the rule type they are, in the order each type's rules run. Their ids are
+ * `<prefix>:unit/<type>/<name>` (`<prefix>:player/action/<name>` for the player actions), as civ1-unit's are, so a
+ * ruleset registers each list where it wants it and keeps the ids another package may name.
+ */
+export declare const lifecycleRules: (
+  prefix: string,
+  {
+    cityRegistry,
+    engine,
+    randomNumberGenerator,
+    ruleRegistry,
+    transportRegistry,
+    unitImprovementRegistry,
+    unitLossRegistry,
+    unitRegistry,
+  }: LifecycleDependencies,
+  {
+    ActiveUnit,
+    InactiveUnit,
+    removedOnActivate,
+    stowable,
+    partnerOf,
+    shortfallFactor,
+    shortStep,
+    sparesStack,
+  }: LifecycleOptions
+) => {
+  activate: Activate[];
+  canStow: CanStow[];
+  created: Created[];
+  defeated: Defeated[];
+  destroyed: Destroyed[];
+  expectedMovementCost: ExpectedMovementCost[];
+  halted: Halted[];
+  impassable: Impassable[];
+  lostAtSea: LostAtSea[];
+  playerAction: Action[];
+  stowed: Stowed[];
+  transferred: Transferred[];
+  unsupported: Unsupported[];
+  validateMove: ValidateMove[];
+};
+export type LifecycleRules = ReturnType<typeof lifecycleRules>;
+export default lifecycleRules;

package/lib/lifecycleRules.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lifecycleRules = void 0;
+const CityRegistry_1 = require("@civ-clone/core-city/CityRegistry");
+const Engine_1 = require("@civ-clone/core-engine/Engine");
+const RuleRegistry_1 = require("@civ-clone/core-rule/RuleRegistry");
+const TransportRegistry_1 = require("@civ-clone/core-unit-transport/TransportRegistry");
+const UnitImprovementRegistry_1 = require("@civ-clone/core-unit-improvement/UnitImprovementRegistry");
+const UnitLossRegistry_1 = require("@civ-clone/core-unit/UnitLossRegistry");
+const playerAction_1 = require("./playerAction");
+const UnitRegistry_1 = require("@civ-clone/core-unit/UnitRegistry");
+const created_1 = require("./created");
+const destroyed_1 = require("./destroyed");
+const canStow_1 = require("./canStow");
+const activate_1 = require("./activate");
+const lostAtSea_1 = require("./lostAtSea");
+const defeated_1 = require("./defeated");
+const impassable_1 = require("./impassable");
+const validateMove_1 = require("./validateMove");
+const Action_1 = require("@civ-clone/core-player/Rules/Action");
+const Activate_1 = require("@civ-clone/core-unit/Rules/Activate");
+const CanStow_1 = require("@civ-clone/core-unit-transport/Rules/CanStow");
+const Created_1 = require("@civ-clone/core-unit/Rules/Created");
+const Criterion_1 = require("@civ-clone/core-rule/Criterion");
+const Defeated_1 = require("@civ-clone/core-unit/Rules/Defeated");
+const Destroyed_1 = require("@civ-clone/core-unit/Rules/Destroyed");
+const Effect_1 = require("@civ-clone/core-rule/Effect");
+const ExpectedMovementCost_1 = require("@civ-clone/core-world-path/Rules/ExpectedMovementCost");
+const Halted_1 = require("@civ-clone/base-unit-action-goto/Rules/Halted");
+const Impassable_1 = require("@civ-clone/core-world-path/Rules/Impassable");
+const LostAtSea_1 = require("@civ-clone/core-unit-transport/Rules/LostAtSea");
+const Stowed_1 = require("@civ-clone/core-unit-transport/Rules/Stowed");
+const Transferred_1 = require("@civ-clone/core-unit/Rules/Transferred");
+const Unsupported_1 = require("@civ-clone/core-unit/Rules/Unsupported");
+const ValidateMove_1 = require("@civ-clone/core-unit/Rules/ValidateMove");
+const halted_1 = require("./halted");
+const unsupported_1 = require("./unsupported");
+const moveShortfall_1 = require("@civ-clone/base-unit-action-rules/lib/moveShortfall");
+const core_random_1 = require("@civ-clone/core-random");
+const stowed_1 = require("./stowed");
+/**
+ * A ruleset's unit lifecycle rules, by the rule type they are, in the order each type's rules run. Their ids are
+ * `<prefix>:unit/<type>/<name>` (`<prefix>:player/action/<name>` for the player actions), as civ1-unit's are, so a
+ * ruleset registers each list where it wants it and keeps the ids another package may name.
+ */
+const lifecycleRules = (prefix, { cityRegistry = CityRegistry_1.instance, engine = Engine_1.instance, randomNumberGenerator = core_random_1.instance, ruleRegistry = RuleRegistry_1.instance, transportRegistry = TransportRegistry_1.instance, unitImprovementRegistry = UnitImprovementRegistry_1.instance, unitLossRegistry = UnitLossRegistry_1.instance, unitRegistry = UnitRegistry_1.instance, }, { ActiveUnit, InactiveUnit, removedOnActivate, stowable, partnerOf, shortfallFactor, shortStep, sparesStack, }) => {
+    const id = (name) => `${prefix}:unit/${name}`;
+    return {
+        activate: [
+            new Activate_1.default(id('activate/has-moves'), new Criterion_1.default(activate_1.hasMoves), new Effect_1.default(activate_1.setActive)),
+            new Activate_1.default(id('activate/clear-busy'), new Criterion_1.default(activate_1.isBusy), new Effect_1.default(activate_1.clearBusy)),
+            ...removedOnActivate.map((UnitImprovementType) => new Activate_1.default(id(`activate/remove-improvement/${UnitImprovementType.name}`), new Criterion_1.default((0, activate_1.hasImprovement)(unitImprovementRegistry, UnitImprovementType)), new Effect_1.default((0, activate_1.removeImprovement)(unitImprovementRegistry, UnitImprovementType)))),
+        ],
+        canStow: stowable.map((StowableUnitType) => new CanStow_1.default(id(`can-stow/${StowableUnitType.name}`), new Criterion_1.default((0, canStow_1.carriesDomain)(StowableUnitType)), new Effect_1.default((0, canStow_1.carriesUnit)(StowableUnitType)))),
+        created: [
+            new Created_1.default(id('created/register'), new Effect_1.default((0, created_1.registerUnit)(unitRegistry))),
+            new Created_1.default(id('created/apply-visibility'), new Effect_1.default(created_1.applyVisibility)),
+            new Created_1.default(id('created/set-moves'), new Effect_1.default(created_1.setMoves)),
+            new Created_1.default(id('created/emit'), new Effect_1.default((0, created_1.emitCreated)(engine))),
+        ],
+        defeated: [
+            new Defeated_1.default(id('defeated/emit-and-destroy'), new Effect_1.default((0, defeated_1.emitAndDestroy)(engine, ruleRegistry))),
+            new Defeated_1.default(
+            // `Attack` processes `Defeated` for a losing attacker too; only a defeated defender takes its stack with it.
+            id('defeated/destroy-stack'), new Criterion_1.default(defeated_1.defended), new Criterion_1.default((0, defeated_1.notInCity)(cityRegistry)), ...(sparesStack === undefined
+                ? []
+                : [new Criterion_1.default((0, defeated_1.notSpared)(sparesStack))]), new Criterion_1.default((0, defeated_1.hasStack)(unitRegistry)), new Effect_1.default((0, defeated_1.destroyStack)(unitRegistry, ruleRegistry))),
+        ],
+        destroyed: [
+            new Destroyed_1.default(id('destroyed/emit'), new Effect_1.default((0, destroyed_1.emitDestroyed)(engine))),
+            new Destroyed_1.default(
+            // A loss, once, for a unit another player destroyed.
+            id('destroyed/count-loss'), new Criterion_1.default(destroyed_1.destroyedByAnother), new Criterion_1.default(destroyed_1.notYetDestroyed), new Effect_1.default((0, destroyed_1.countLoss)(unitLossRegistry))),
+            new Destroyed_1.default(id('destroyed/deactivate'), new Effect_1.default(destroyed_1.deactivate)),
+            new Destroyed_1.default(id('destroyed/remove-improvements'), new Effect_1.default((0, destroyed_1.removeImprovements)(unitImprovementRegistry))),
+            new Destroyed_1.default(id('destroyed/lose-cargo'), new Criterion_1.default((0, destroyed_1.carriesCargo)(transportRegistry)), new Effect_1.default((0, destroyed_1.loseCargo)(transportRegistry))),
+            new Destroyed_1.default(id('destroyed/leave-transport'), new Criterion_1.default((0, destroyed_1.isAboard)(transportRegistry)), new Effect_1.default((0, destroyed_1.leaveOwnTransport)(transportRegistry))),
+        ],
+        expectedMovementCost: [
+            new ExpectedMovementCost_1.default(
+            // A step costing more than the unit's full moves is worth `max(m, c × shortfallFactor)` on average.
+            id('expected-movement-cost/shortfall'), new Criterion_1.default((unit, movementCost, movement) => movement > 0), new Effect_1.default((unit, movementCost, movement) => shortStep === undefined
+                ? (0, moveShortfall_1.expectedCost)(movement, movementCost, shortfallFactor)
+                : shortStep.expectedCost(movement, movementCost))),
+        ],
+        halted: [new Halted_1.default(id('halted/emit'), new Effect_1.default((0, halted_1.emitHalted)(engine)))],
+        impassable: partnerOf === undefined
+            ? []
+            : [
+                new Impassable_1.default(
+                // Routes go round a treaty partner's land, so following one never breaks a treaty by accident.
+                id('impassable/treaty-partners-land'), new Criterion_1.default(impassable_1.fromLand), new Criterion_1.default((0, impassable_1.toPartnersLand)(partnerOf)), new Effect_1.default(impassable_1.impassable)),
+            ],
+        lostAtSea: [
+            new LostAtSea_1.default(id('lost-at-sea/emit'), new Effect_1.default((0, lostAtSea_1.emitLostAtSea)(engine))),
+            new LostAtSea_1.default(
+            // Before `destroy`, while the manifests still say what's aboard.
+            id('lost-at-sea/count-loss'), new Effect_1.default((0, lostAtSea_1.countLosses)(unitLossRegistry, transportRegistry))),
+            new LostAtSea_1.default(id('lost-at-sea/destroy'), new Effect_1.default(lostAtSea_1.sink)),
+        ],
+        playerAction: [
+            new Action_1.default(`${prefix}:player/action/active-units`, new Criterion_1.default((0, playerAction_1.hasActiveUnits)(unitRegistry)), new Effect_1.default((0, playerAction_1.activeUnits)(unitRegistry, ActiveUnit))),
+            new Action_1.default(`${prefix}:player/action/inactive-units`, new Criterion_1.default((0, playerAction_1.hasInactiveUnits)(unitRegistry)), new Effect_1.default((0, playerAction_1.inactiveUnits)(unitRegistry, InactiveUnit))),
+        ],
+        stowed: [new Stowed_1.default(id('stowed/sleep'), new Effect_1.default(stowed_1.sleepAboard))],
+        transferred: [
+            new Transferred_1.default(id('transferred/emit'), new Effect_1.default((unit, player, previousPlayer) => {
+                engine.emit('unit:transferred', unit, player, previousPlayer);
+            })),
+        ],
+        unsupported: [
+            new Unsupported_1.default(id('unsupported/emit'), new Effect_1.default((0, unsupported_1.emitUnsupported)(engine))),
+        ],
+        validateMove: [
+            new ValidateMove_1.default(id('validate-move/enough-moves'), new Criterion_1.default(validateMove_1.hasMovesFor), new Effect_1.default(validateMove_1.spendMoves)),
+            new ValidateMove_1.default(id('validate-move/not-enough-moves'), new Criterion_1.default(validateMove_1.shortOfMovesFor), new Effect_1.default(shortStep === undefined
+                ? (0, validateMove_1.spendShort)(shortfallFactor, randomNumberGenerator)
+                : (unit, movementCost) => {
+                    const remaining = unit.moves().value(), movement = unit.movement().value();
+                    unit.moves().set(0);
+                    return shortStep.succeeds(unit, remaining, movement, movementCost, randomNumberGenerator);
+                })),
+        ],
+    };
+};
+exports.lifecycleRules = lifecycleRules;
+exports.default = exports.lifecycleRules;
+//# sourceMappingURL=lifecycleRules.js.map

package/lib/lifecycleRules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycleRules.js","sourceRoot":"","sources":["lifecycleRules.ts"],"names":[],"mappings":";;;AAAA,oEAG2C;AAC3C,0DAGuC;AACvC,oEAG2C;AAC3C,wFAG0D;AAC1D,sGAGkE;AAClE,4EAG+C;AAC/C,iDAMwB;AACxB,oEAG2C;AAC3C,uCAKmB;AACnB,2CAWqB;AACrB,uCAAuD;AACvD,yCAOoB;AACpB,2CAA+D;AAC/D,yCAQoB;AACpB,6CAAoE;AACpE,iDAKwB;AACxB,gEAAyD;AACzD,kEAA2D;AAC3D,0EAAmE;AACnE,gEAAyD;AACzD,8DAAuD;AACvD,kEAA2D;AAC3D,oEAA6D;AAC7D,wDAAiD;AACjD,gGAAyF;AACzF,0EAAmE;AACnE,4EAAqE;AACrE,8EAAuE;AAGvE,wEAAiE;AAEjE,wEAAiE;AAGjE,wEAAiE;AACjE,0EAAmE;AACnE,qCAAsC;AACtC,+CAAgD;AAChD,uFAAmF;AACnF,wDAAiE;AACjE,qCAAuC;AAqDvC;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAC5B,MAAc,EACd,EACE,YAAY,GAAG,uBAAoB,EACnC,MAAM,GAAG,iBAAc,EACvB,qBAAqB,GAAG,sBAAW,EACnC,YAAY,GAAG,uBAAoB,EACnC,iBAAiB,GAAG,4BAAyB,EAC7C,uBAAuB,GAAG,kCAA+B,EACzD,gBAAgB,GAAG,2BAAwB,EAC3C,YAAY,GAAG,uBAAoB,GACb,EACxB,EACE,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,QAAQ,EACR,SAAS,EACT,eAAe,EACf,SAAS,EACT,WAAW,GACM,EACnB,EAAE;IACF,MAAM,EAAE,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,GAAG,MAAM,SAAS,IAAI,EAAE,CAAC;IAE9D,OAAO;QACL,QAAQ,EAAE;YACR,IAAI,kBAAQ,CACV,EAAE,CAAC,oBAAoB,CAAC,EACxB,IAAI,mBAAS,CAAC,mBAAQ,CAAC,EACvB,IAAI,gBAAM,CAAC,oBAAS,CAAC,CACtB;YACD,IAAI,kBAAQ,CACV,EAAE,CAAC,qBAAqB,CAAC,EACzB,IAAI,mBAAS,CAAC,iBAAM,CAAC,EACrB,IAAI,gBAAM,CAAC,oBAAS,CAAC,CACtB;YACD,GAAG,iBAAiB,CAAC,GAAG,CACtB,CAAC,mBAA2C,EAAY,EAAE,CACxD,IAAI,kBAAQ,CACV,EAAE,CAAC,+BAA+B,mBAAmB,CAAC,IAAI,EAAE,CAAC,EAC7D,IAAI,mBAAS,CACX,IAAA,yBAAc,EAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAC7D,EACD,IAAI,gBAAM,CACR,IAAA,4BAAiB,EAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAChE,CACF,CACJ;SACF;QAED,OAAO,EAAE,QAAQ,CAAC,GAAG,CACnB,CAAC,gBAA6B,EAAW,EAAE,CACzC,IAAI,iBAAO,CACT,EAAE,CAAC,YAAY,gBAAgB,CAAC,IAAI,EAAE,CAAC,EACvC,IAAI,mBAAS,CAAC,IAAA,uBAAa,EAAC,gBAAgB,CAAC,CAAC,EAC9C,IAAI,gBAAM,CAAC,IAAA,qBAAW,EAAC,gBAAgB,CAAC,CAAC,CAC1C,CACJ;QAED,OAAO,EAAE;YACP,IAAI,iBAAO,CACT,EAAE,CAAC,kBAAkB,CAAC,EACtB,IAAI,gBAAM,CAAC,IAAA,sBAAY,EAAC,YAAY,CAAC,CAAC,CACvC;YACD,IAAI,iBAAO,CAAC,EAAE,CAAC,0BAA0B,CAAC,EAAE,IAAI,gBAAM,CAAC,yBAAe,CAAC,CAAC;YACxE,IAAI,iBAAO,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,IAAI,gBAAM,CAAC,kBAAQ,CAAC,CAAC;YAC1D,IAAI,iBAAO,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,IAAI,gBAAM,CAAC,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC,CAAC;SACjE;QAED,QAAQ,EAAE;YACR,IAAI,kBAAQ,CACV,EAAE,CAAC,2BAA2B,CAAC,EAC/B,IAAI,gBAAM,CAAC,IAAA,yBAAc,EAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CACjD;YACD,IAAI,kBAAQ;YACV,6GAA6G;YAC7G,EAAE,CAAC,wBAAwB,CAAC,EAC5B,IAAI,mBAAS,CAAC,mBAAQ,CAAC,EACvB,IAAI,mBAAS,CAAC,IAAA,oBAAS,EAAC,YAAY,CAAC,CAAC,EACtC,GAAG,CAAC,WAAW,KAAK,SAAS;gBAC3B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,IAAI,mBAAS,CAAC,IAAA,oBAAS,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAC5C,IAAI,mBAAS,CAAC,IAAA,mBAAQ,EAAC,YAAY,CAAC,CAAC,EACrC,IAAI,gBAAM,CAAC,IAAA,uBAAY,EAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CACrD;SACF;QAED,SAAS,EAAE;YACT,IAAI,mBAAS,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,IAAI,gBAAM,CAAC,IAAA,yBAAa,EAAC,MAAM,CAAC,CAAC,CAAC;YACtE,IAAI,mBAAS;YACX,qDAAqD;YACrD,EAAE,CAAC,sBAAsB,CAAC,EAC1B,IAAI,mBAAS,CAAC,8BAAkB,CAAC,EACjC,IAAI,mBAAS,CAAC,2BAAe,CAAC,EAC9B,IAAI,gBAAM,CAAC,IAAA,qBAAS,EAAC,gBAAgB,CAAC,CAAC,CACxC;YACD,IAAI,mBAAS,CAAC,EAAE,CAAC,sBAAsB,CAAC,EAAE,IAAI,gBAAM,CAAC,sBAAU,CAAC,CAAC;YACjE,IAAI,mBAAS,CACX,EAAE,CAAC,+BAA+B,CAAC,EACnC,IAAI,gBAAM,CAAC,IAAA,8BAAkB,EAAC,uBAAuB,CAAC,CAAC,CACxD;YACD,IAAI,mBAAS,CACX,EAAE,CAAC,sBAAsB,CAAC,EAC1B,IAAI,mBAAS,CAAC,IAAA,wBAAY,EAAC,iBAAiB,CAAC,CAAC,EAC9C,IAAI,gBAAM,CAAC,IAAA,qBAAS,EAAC,iBAAiB,CAAC,CAAC,CACzC;YACD,IAAI,mBAAS,CACX,EAAE,CAAC,2BAA2B,CAAC,EAC/B,IAAI,mBAAS,CAAC,IAAA,oBAAQ,EAAC,iBAAiB,CAAC,CAAC,EAC1C,IAAI,gBAAM,CAAC,IAAA,6BAAiB,EAAC,iBAAiB,CAAC,CAAC,CACjD;SACF;QAED,oBAAoB,EAAE;YACpB,IAAI,8BAAoB;YACtB,oGAAoG;YACpG,EAAE,CAAC,kCAAkC,CAAC,EACtC,IAAI,mBAAS,CACX,CAAC,IAAU,EAAE,YAAoB,EAAE,QAAgB,EAAW,EAAE,CAC9D,QAAQ,GAAG,CAAC,CACf,EACD,IAAI,gBAAM,CACR,CAAC,IAAU,EAAE,YAAoB,EAAE,QAAgB,EAAU,EAAE,CAC7D,SAAS,KAAK,SAAS;gBACrB,CAAC,CAAC,IAAA,4BAAY,EAAC,QAAQ,EAAE,YAAY,EAAE,eAAyB,CAAC;gBACjE,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,CACrD,CACF;SACF;QAED,MAAM,EAAE,CAAC,IAAI,gBAAM,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,IAAI,gBAAM,CAAC,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEvE,UAAU,EACR,SAAS,KAAK,SAAS;YACrB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,IAAI,oBAAU;gBACZ,+FAA+F;gBAC/F,EAAE,CAAC,iCAAiC,CAAC,EACrC,IAAI,mBAAS,CAAC,qBAAQ,CAAC,EACvB,IAAI,mBAAS,CAAC,IAAA,2BAAc,EAAC,SAAS,CAAC,CAAC,EACxC,IAAI,gBAAM,CAAC,uBAAU,CAAC,CACvB;aACF;QAEP,SAAS,EAAE;YACT,IAAI,mBAAS,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,IAAI,gBAAM,CAAC,IAAA,yBAAa,EAAC,MAAM,CAAC,CAAC,CAAC;YACxE,IAAI,mBAAS;YACX,iEAAiE;YACjE,EAAE,CAAC,wBAAwB,CAAC,EAC5B,IAAI,gBAAM,CAAC,IAAA,uBAAW,EAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAC7D;YACD,IAAI,mBAAS,CAAC,EAAE,CAAC,qBAAqB,CAAC,EAAE,IAAI,gBAAM,CAAC,gBAAI,CAAC,CAAC;SAC3D;QAED,YAAY,EAAE;YACZ,IAAI,gBAAM,CACR,GAAG,MAAM,6BAA6B,EACtC,IAAI,mBAAS,CAAC,IAAA,6BAAc,EAAC,YAAY,CAAC,CAAC,EAC3C,IAAI,gBAAM,CAAC,IAAA,0BAAW,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAClD;YACD,IAAI,gBAAM,CACR,GAAG,MAAM,+BAA+B,EACxC,IAAI,mBAAS,CAAC,IAAA,+BAAgB,EAAC,YAAY,CAAC,CAAC,EAC7C,IAAI,gBAAM,CAAC,IAAA,4BAAa,EAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CACtD;SACF;QAED,MAAM,EAAE,CAAC,IAAI,gBAAM,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,IAAI,gBAAM,CAAC,oBAAW,CAAC,CAAC,CAAC;QAEjE,WAAW,EAAE;YACX,IAAI,qBAAW,CACb,EAAE,CAAC,kBAAkB,CAAC,EACtB,IAAI,gBAAM,CACR,CAAC,IAAU,EAAE,MAAc,EAAE,cAAsB,EAAQ,EAAE;gBAC3D,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;YAChE,CAAC,CACF,CACF;SACF;QAED,WAAW,EAAE;YACX,IAAI,qBAAW,CACb,EAAE,CAAC,kBAAkB,CAAC,EACtB,IAAI,gBAAM,CAAC,IAAA,6BAAe,EAAC,MAAM,CAAC,CAAC,CACpC;SACF;QAED,YAAY,EAAE;YACZ,IAAI,sBAAY,CACd,EAAE,CAAC,4BAA4B,CAAC,EAChC,IAAI,mBAAS,CAAC,0BAAW,CAAC,EAC1B,IAAI,gBAAM,CAAC,yBAAU,CAAC,CACvB;YACD,IAAI,sBAAY,CACd,EAAE,CAAC,gCAAgC,CAAC,EACpC,IAAI,mBAAS,CAAC,8BAAe,CAAC,EAC9B,IAAI,gBAAM,CACR,SAAS,KAAK,SAAS;gBACrB,CAAC,CAAC,IAAA,yBAAU,EAAC,eAAyB,EAAE,qBAAqB,CAAC;gBAC9D,CAAC,CAAC,CAAC,IAAU,EAAE,YAAoB,EAAW,EAAE;oBAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EACpC,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC;oBAErC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBAEpB,OAAO,SAAS,CAAC,QAAQ,CACvB,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,qBAAqB,CACtB,CAAC;gBACJ,CAAC,CACN,CACF;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AA3NW,QAAA,cAAc,kBA2NzB;AAIF,kBAAe,sBAAc,CAAC"}

package/lib/lifecycleRules.ts

@@ -0,0 +1,386 @@
+import {
+  CityRegistry,
+  instance as cityRegistryInstance,
+} from '@civ-clone/core-city/CityRegistry';
+import {
+  Engine,
+  instance as engineInstance,
+} from '@civ-clone/core-engine/Engine';
+import {
+  RuleRegistry,
+  instance as ruleRegistryInstance,
+} from '@civ-clone/core-rule/RuleRegistry';
+import {
+  TransportRegistry,
+  instance as transportRegistryInstance,
+} from '@civ-clone/core-unit-transport/TransportRegistry';
+import {
+  UnitImprovementRegistry,
+  instance as unitImprovementRegistryInstance,
+} from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+import {
+  UnitLossRegistry,
+  instance as unitLossRegistryInstance,
+} from '@civ-clone/core-unit/UnitLossRegistry';
+import {
+  UnitPlayerActionType,
+  activeUnits,
+  hasActiveUnits,
+  hasInactiveUnits,
+  inactiveUnits,
+} from './playerAction';
+import {
+  UnitRegistry,
+  instance as unitRegistryInstance,
+} from '@civ-clone/core-unit/UnitRegistry';
+import {
+  applyVisibility,
+  emitCreated,
+  registerUnit,
+  setMoves,
+} from './created';
+import {
+  carriesCargo,
+  countLoss,
+  deactivate,
+  destroyedByAnother,
+  emitDestroyed,
+  isAboard,
+  leaveOwnTransport,
+  loseCargo,
+  notYetDestroyed,
+  removeImprovements,
+} from './destroyed';
+import { carriesDomain, carriesUnit } from './canStow';
+import {
+  clearBusy,
+  hasImprovement,
+  hasMoves,
+  isBusy,
+  removeImprovement,
+  setActive,
+} from './activate';
+import { countLosses, emitLostAtSea, sink } from './lostAtSea';
+import {
+  SparesStack,
+  defended,
+  destroyStack,
+  emitAndDestroy,
+  hasStack,
+  notInCity,
+  notSpared,
+} from './defeated';
+import { fromLand, impassable, toPartnersLand } from './impassable';
+import {
+  hasMovesFor,
+  shortOfMovesFor,
+  spendMoves,
+  spendShort,
+} from './validateMove';
+import Action from '@civ-clone/core-player/Rules/Action';
+import Activate from '@civ-clone/core-unit/Rules/Activate';
+import CanStow from '@civ-clone/core-unit-transport/Rules/CanStow';
+import Created from '@civ-clone/core-unit/Rules/Created';
+import Criterion from '@civ-clone/core-rule/Criterion';
+import Defeated from '@civ-clone/core-unit/Rules/Defeated';
+import Destroyed from '@civ-clone/core-unit/Rules/Destroyed';
+import Effect from '@civ-clone/core-rule/Effect';
+import ExpectedMovementCost from '@civ-clone/core-world-path/Rules/ExpectedMovementCost';
+import Halted from '@civ-clone/base-unit-action-goto/Rules/Halted';
+import Impassable from '@civ-clone/core-world-path/Rules/Impassable';
+import LostAtSea from '@civ-clone/core-unit-transport/Rules/LostAtSea';
+import Player from '@civ-clone/core-player/Player';
+import PlayerAction from '@civ-clone/core-player/PlayerAction';
+import Stowed from '@civ-clone/core-unit-transport/Rules/Stowed';
+import Tile from '@civ-clone/core-world/Tile';
+import Transferred from '@civ-clone/core-unit/Rules/Transferred';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovement from '@civ-clone/core-unit-improvement/UnitImprovement';
+import Unsupported from '@civ-clone/core-unit/Rules/Unsupported';
+import ValidateMove from '@civ-clone/core-unit/Rules/ValidateMove';
+import { emitHalted } from './halted';
+import { emitUnsupported } from './unsupported';
+import { expectedCost } from '@civ-clone/base-unit-action-rules/lib/moveShortfall';
+import { instance as rngInstance } from '@civ-clone/core-random';
+import { sleepAboard } from './stowed';
+
+export interface LifecycleDependencies {
+  cityRegistry?: CityRegistry;
+  engine?: Engine;
+  randomNumberGenerator?: () => number;
+  ruleRegistry?: RuleRegistry;
+  transportRegistry?: TransportRegistry;
+  unitImprovementRegistry?: UnitImprovementRegistry;
+  unitLossRegistry?: UnitLossRegistry;
+  unitRegistry?: UnitRegistry;
+}
+
+export interface LifecycleBaseOptions {
+  // The player actions a unit that can take orders, and one that can't, is offered as.
+  ActiveUnit: UnitPlayerActionType<PlayerAction>;
+  InactiveUnit: UnitPlayerActionType<PlayerAction>;
+  // The unit improvements activating a unit takes off it (a Fortified state), each with a rule of its own.
+  removedOnActivate: (typeof UnitImprovement)[];
+  // The domains a transport may carry, each with a `CanStow` rule of its own (`Carries` traits).
+  stowable: (typeof Unit)[];
+  // Whose land `tile` is among `unit`'s treaty partners, or `null`: routes go round it. Without it, no rule is made.
+  partnerOf?: (unit: Unit, tile: Tile) => Player | null;
+  // Squares where a defeated defender's stack survives it, besides a city. Without it, only a city spares the stack.
+  sparesStack?: SparesStack;
+}
+
+/**
+ * How a unit short of a step's moves fares: Civ1's `shortfallFactor` (`spendShort`), or a ruleset's own `shortStep`,
+ *  which then needs no factor.
+ */
+export type LifecycleOptions = LifecycleBaseOptions &
+  (
+    | { shortfallFactor: number; shortStep?: undefined }
+    | { shortfallFactor?: number; shortStep: ShortStep }
+  );
+
+/**
+ * A ruleset's own short step: whether `unit`, with `remaining` of its `movement` moves, gets onto a square costing
+ *  `cost` (one draw of `randomNumberGenerator` at most), and what such a step is worth on average to route planning.
+ *  The unit's moves are spent either way.
+ */
+export interface ShortStep {
+  succeeds: (
+    unit: Unit,
+    remaining: number,
+    movement: number,
+    cost: number,
+    randomNumberGenerator: () => number
+  ) => boolean;
+  expectedCost: (movement: number, cost: number) => number;
+}
+
+/**
+ * A ruleset's unit lifecycle rules, by the rule type they are, in the order each type's rules run. Their ids are
+ * `<prefix>:unit/<type>/<name>` (`<prefix>:player/action/<name>` for the player actions), as civ1-unit's are, so a
+ * ruleset registers each list where it wants it and keeps the ids another package may name.
+ */
+export const lifecycleRules = (
+  prefix: string,
+  {
+    cityRegistry = cityRegistryInstance,
+    engine = engineInstance,
+    randomNumberGenerator = rngInstance,
+    ruleRegistry = ruleRegistryInstance,
+    transportRegistry = transportRegistryInstance,
+    unitImprovementRegistry = unitImprovementRegistryInstance,
+    unitLossRegistry = unitLossRegistryInstance,
+    unitRegistry = unitRegistryInstance,
+  }: LifecycleDependencies,
+  {
+    ActiveUnit,
+    InactiveUnit,
+    removedOnActivate,
+    stowable,
+    partnerOf,
+    shortfallFactor,
+    shortStep,
+    sparesStack,
+  }: LifecycleOptions
+) => {
+  const id = (name: string): string => `${prefix}:unit/${name}`;
+
+  return {
+    activate: [
+      new Activate(
+        id('activate/has-moves'),
+        new Criterion(hasMoves),
+        new Effect(setActive)
+      ),
+      new Activate(
+        id('activate/clear-busy'),
+        new Criterion(isBusy),
+        new Effect(clearBusy)
+      ),
+      ...removedOnActivate.map(
+        (UnitImprovementType: typeof UnitImprovement): Activate =>
+          new Activate(
+            id(`activate/remove-improvement/${UnitImprovementType.name}`),
+            new Criterion(
+              hasImprovement(unitImprovementRegistry, UnitImprovementType)
+            ),
+            new Effect(
+              removeImprovement(unitImprovementRegistry, UnitImprovementType)
+            )
+          )
+      ),
+    ],
+
+    canStow: stowable.map(
+      (StowableUnitType: typeof Unit): CanStow =>
+        new CanStow(
+          id(`can-stow/${StowableUnitType.name}`),
+          new Criterion(carriesDomain(StowableUnitType)),
+          new Effect(carriesUnit(StowableUnitType))
+        )
+    ),
+
+    created: [
+      new Created(
+        id('created/register'),
+        new Effect(registerUnit(unitRegistry))
+      ),
+      new Created(id('created/apply-visibility'), new Effect(applyVisibility)),
+      new Created(id('created/set-moves'), new Effect(setMoves)),
+      new Created(id('created/emit'), new Effect(emitCreated(engine))),
+    ],
+
+    defeated: [
+      new Defeated(
+        id('defeated/emit-and-destroy'),
+        new Effect(emitAndDestroy(engine, ruleRegistry))
+      ),
+      new Defeated(
+        // `Attack` processes `Defeated` for a losing attacker too; only a defeated defender takes its stack with it.
+        id('defeated/destroy-stack'),
+        new Criterion(defended),
+        new Criterion(notInCity(cityRegistry)),
+        ...(sparesStack === undefined
+          ? []
+          : [new Criterion(notSpared(sparesStack))]),
+        new Criterion(hasStack(unitRegistry)),
+        new Effect(destroyStack(unitRegistry, ruleRegistry))
+      ),
+    ],
+
+    destroyed: [
+      new Destroyed(id('destroyed/emit'), new Effect(emitDestroyed(engine))),
+      new Destroyed(
+        // A loss, once, for a unit another player destroyed.
+        id('destroyed/count-loss'),
+        new Criterion(destroyedByAnother),
+        new Criterion(notYetDestroyed),
+        new Effect(countLoss(unitLossRegistry))
+      ),
+      new Destroyed(id('destroyed/deactivate'), new Effect(deactivate)),
+      new Destroyed(
+        id('destroyed/remove-improvements'),
+        new Effect(removeImprovements(unitImprovementRegistry))
+      ),
+      new Destroyed(
+        id('destroyed/lose-cargo'),
+        new Criterion(carriesCargo(transportRegistry)),
+        new Effect(loseCargo(transportRegistry))
+      ),
+      new Destroyed(
+        id('destroyed/leave-transport'),
+        new Criterion(isAboard(transportRegistry)),
+        new Effect(leaveOwnTransport(transportRegistry))
+      ),
+    ],
+
+    expectedMovementCost: [
+      new ExpectedMovementCost(
+        // A step costing more than the unit's full moves is worth `max(m, c × shortfallFactor)` on average.
+        id('expected-movement-cost/shortfall'),
+        new Criterion(
+          (unit: Unit, movementCost: number, movement: number): boolean =>
+            movement > 0
+        ),
+        new Effect(
+          (unit: Unit, movementCost: number, movement: number): number =>
+            shortStep === undefined
+              ? expectedCost(movement, movementCost, shortfallFactor as number)
+              : shortStep.expectedCost(movement, movementCost)
+        )
+      ),
+    ],
+
+    halted: [new Halted(id('halted/emit'), new Effect(emitHalted(engine)))],
+
+    impassable:
+      partnerOf === undefined
+        ? []
+        : [
+            new Impassable(
+              // Routes go round a treaty partner's land, so following one never breaks a treaty by accident.
+              id('impassable/treaty-partners-land'),
+              new Criterion(fromLand),
+              new Criterion(toPartnersLand(partnerOf)),
+              new Effect(impassable)
+            ),
+          ],
+
+    lostAtSea: [
+      new LostAtSea(id('lost-at-sea/emit'), new Effect(emitLostAtSea(engine))),
+      new LostAtSea(
+        // Before `destroy`, while the manifests still say what's aboard.
+        id('lost-at-sea/count-loss'),
+        new Effect(countLosses(unitLossRegistry, transportRegistry))
+      ),
+      new LostAtSea(id('lost-at-sea/destroy'), new Effect(sink)),
+    ],
+
+    playerAction: [
+      new Action(
+        `${prefix}:player/action/active-units`,
+        new Criterion(hasActiveUnits(unitRegistry)),
+        new Effect(activeUnits(unitRegistry, ActiveUnit))
+      ),
+      new Action(
+        `${prefix}:player/action/inactive-units`,
+        new Criterion(hasInactiveUnits(unitRegistry)),
+        new Effect(inactiveUnits(unitRegistry, InactiveUnit))
+      ),
+    ],
+
+    stowed: [new Stowed(id('stowed/sleep'), new Effect(sleepAboard))],
+
+    transferred: [
+      new Transferred(
+        id('transferred/emit'),
+        new Effect(
+          (unit: Unit, player: Player, previousPlayer: Player): void => {
+            engine.emit('unit:transferred', unit, player, previousPlayer);
+          }
+        )
+      ),
+    ],
+
+    unsupported: [
+      new Unsupported(
+        id('unsupported/emit'),
+        new Effect(emitUnsupported(engine))
+      ),
+    ],
+
+    validateMove: [
+      new ValidateMove(
+        id('validate-move/enough-moves'),
+        new Criterion(hasMovesFor),
+        new Effect(spendMoves)
+      ),
+      new ValidateMove(
+        id('validate-move/not-enough-moves'),
+        new Criterion(shortOfMovesFor),
+        new Effect(
+          shortStep === undefined
+            ? spendShort(shortfallFactor as number, randomNumberGenerator)
+            : (unit: Unit, movementCost: number): boolean => {
+                const remaining = unit.moves().value(),
+                  movement = unit.movement().value();
+
+                unit.moves().set(0);
+
+                return shortStep.succeeds(
+                  unit,
+                  remaining,
+                  movement,
+                  movementCost,
+                  randomNumberGenerator
+                );
+              }
+        )
+      ),
+    ],
+  };
+};
+
+export type LifecycleRules = ReturnType<typeof lifecycleRules>;
+
+export default lifecycleRules;