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

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,63 @@
 {
   "name": "@civ-clone/base-unit-lifecycle",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "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-establish-embassy": "^0.1.0",
+    "@civ-clone/base-unit-action-goto": "^0.1.9",
+    "@civ-clone/base-unit-action-investigate-city": "^0.1.0",
+    "@civ-clone/base-unit-action-meet-with-leader": "^0.1.0",
+    "@civ-clone/base-unit-action-nuclear-attack": "^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-attack-ends-turn": "^0.1.0",
+    "@civ-clone/base-unit-trait-carries": "^0.1.0",
+    "@civ-clone/base-unit-trait-coast-bound": "^0.1.0",
+    "@civ-clone/base-unit-trait-non-combatant": "^0.1.0",
+    "@civ-clone/base-unit-type-air": "^0.1.0",
+    "@civ-clone/base-unit-type-land": "^0.1.0",
+    "@civ-clone/base-unit-type-naval-transport": "^0.1.3",
+    "@civ-clone/core-city": "^0.1.19",
+    "@civ-clone/core-city-growth": "^0.1.6",
+    "@civ-clone/core-diplomacy": "^0.1.8",
+    "@civ-clone/core-engine": "^0.1.0",
+    "@civ-clone/core-player": "^0.1.0",
+    "@civ-clone/core-random": "^0.1.2",
+    "@civ-clone/core-rule": "^0.1.9",
+    "@civ-clone/core-terrain": "^0.1.0",
+    "@civ-clone/core-tile-improvement": "^0.1.6",
+    "@civ-clone/core-turn-based-game": "^0.1.10",
+    "@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",
+    "@civ-clone/core-world-path": "^0.1.3",
+    "@civ-clone/library-diplomacy": "^0.1.4"
+  }
+}

package/tests/fixtures/civ1-unit-rules.json

@@ -0,0 +1,89 @@
+{
+  "Rules/Unit/activate": [
+    ["civ1-unit:unit/activate/has-moves", "Activate", 2000, 1],
+    ["civ1-unit:unit/activate/clear-busy", "Activate", 2000, 1],
+    ["civ1-unit:unit/activate/remove-improvement/Fortified", "Activate", 2000, 1]
+  ],
+  "Rules/Unit/canStow": [
+    ["civ1-unit:unit/can-stow/Land", "CanStow", 2000, 1],
+    ["civ1-unit:unit/can-stow/Air", "CanStow", 2000, 1]
+  ],
+  "Rules/Unit/created": [
+    ["civ1-unit:unit/created/register", "Created", 2000, 0],
+    ["civ1-unit:unit/created/apply-visibility", "Created", 2000, 0],
+    ["civ1-unit:unit/created/set-moves", "Created", 2000, 0],
+    ["civ1-unit:unit/created/emit", "Created", 2000, 0]
+  ],
+  "Rules/Unit/defeated": [
+    ["civ1-unit:unit/defeated/emit-and-destroy", "Defeated", 2000, 0],
+    ["civ1-unit:unit/defeated/destroy-stack", "Defeated", 2000, 3]
+  ],
+  "Rules/Unit/destroyed": [
+    ["civ1-unit:unit/destroyed/emit", "Destroyed", 2000, 0],
+    ["civ1-unit:unit/destroyed/count-loss", "Destroyed", 2000, 2],
+    ["civ1-unit:unit/destroyed/deactivate", "Destroyed", 2000, 0],
+    ["civ1-unit:unit/destroyed/remove-improvements", "Destroyed", 2000, 0],
+    ["civ1-unit:unit/destroyed/lose-cargo", "Destroyed", 2000, 1],
+    ["civ1-unit:unit/destroyed/leave-transport", "Destroyed", 2000, 1]
+  ],
+  "Rules/Unit/expectedMovementCost": [
+    ["civ1-unit:unit/expected-movement-cost/shortfall", "ExpectedMovementCost", 2000, 1]
+  ],
+  "Rules/Unit/halted": [
+    ["civ1-unit:unit/halted/emit", "Halted", 2000, 0]
+  ],
+  "Rules/Unit/impassable": [
+    ["civ1-unit:unit/impassable/treaty-partners-land", "Impassable", 2000, 2]
+  ],
+  "Rules/Unit/lostAtSea": [
+    ["civ1-unit:unit/lost-at-sea/emit", "LostAtSea", 2000, 0],
+    ["civ1-unit:unit/lost-at-sea/count-loss", "LostAtSea", 2000, 0],
+    ["civ1-unit:unit/lost-at-sea/destroy", "LostAtSea", 2000, 0]
+  ],
+  "Rules/Player/action": [
+    ["civ1-unit:player/action/active-units", "Action", 2000, 1],
+    ["civ1-unit:player/action/inactive-units", "Action", 2000, 1]
+  ],
+  "Rules/Unit/stowed": [
+    ["civ1-unit:unit/stowed/sleep", "Stowed", 2000, 0]
+  ],
+  "Rules/Unit/transferred": [
+    ["civ1-unit:unit/transferred/start-afresh", "Transferred", 2000, 0],
+    ["civ1-unit:unit/transferred/emit", "Transferred", 2000, 0]
+  ],
+  "Rules/Unit/unsupported": [
+    ["civ1-unit:unit/unsupported/emit", "Unsupported", 2000, 0]
+  ],
+  "Rules/Unit/validateMove": [
+    ["civ1-unit:unit/validate-move/enough-moves", "ValidateMove", 2000, 1],
+    ["civ1-unit:unit/validate-move/not-enough-moves", "ValidateMove", 2000, 1]
+  ],
+  "Rules/Unit/moved": [
+    ["civ1-unit:unit/moved/emit", "Moved", 2000, 0],
+    ["civ1-unit:unit/moved/apply-visibility", "Moved", 2000, 0],
+    ["civ1-unit:unit/moved/end-moves-when-exhausted", "Moved", 2000, 1],
+    ["civ1-unit:unit/moved/move-cargo", "Moved", 2000, 3],
+    ["civ1-unit:unit/moved/collect-aircraft", "Moved", 2000, 4],
+    ["civ1-unit:unit/moved/collect-sleeping", "Moved", 2000, 4],
+    ["civ1-unit:unit/moved/disembark", "Moved", 2000, 1],
+    ["civ1-unit:unit/moved/take-off", "Moved", 2000, 4],
+    ["civ1-unit:unit/moved/trireme-lost-at-sea", "Moved", 2000, 4],
+    ["civ1-unit:unit/moved/bomber/end-turn-after-attack", "Moved", 1000, 2],
+    ["civ1-unit:unit/moved/break-peace-treaty", "Moved", 2000, 1]
+  ],
+  "Rules/Unit/detonated": [
+    ["civ1-unit:unit/detonated/emit", "Detonated", 1000, 0],
+    ["civ1-unit:unit/detonated/destroy-units", "Detonated", 2000, 0],
+    ["civ1-unit:unit/detonated/halve-cities", "Detonated", 2500, 0],
+    ["civ1-unit:unit/detonated/fallout", "Detonated", 3000, 0]
+  ],
+  "Rules/Unit/diplomat": [
+    ["civ1-unit:unit/embassy-established/register", "EmbassyEstablished", 2000, 0],
+    ["civ1-unit:unit/city-investigated/emit", "CityInvestigated", 2000, 0],
+    ["civ1-unit:unit/leader-met/meet", "LeaderMet", 2000, 0],
+    ["civ1-unit:unit/technology-stolen/steal", "TechnologyStolen", 2000, 0],
+    ["civ1-unit:unit/city-sabotaged/sabotage", "CitySabotaged", 2000, 0],
+    ["civ1-unit:unit/revolt-incited/capture", "RevoltIncited", 2000, 0],
+    ["civ1-unit:unit/unit-bribed/transfer", "UnitBribed", 2000, 0]
+  ]
+}