@datamoc/mw_games 0.4.0 → 0.4.2

package/dist/battle/Species.js.map

@@ -1 +1 @@
-{"version":3,"file":"Species.js","sourceRoot":"","sources":["../../src/battle/Species.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAoB,MAAM,0BAA0B,CAAC;AA4BrF,2FAA2F;AAC3F,MAAM,cAAc,GAAG,UAAU,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;IAMpB,YAAY,OAAwB;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,EAAE;YAC5E,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;SACzB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,yFAAyF;IACzF,YAAY;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnF,CAAC;IAEO,WAAW;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;IAC3G,CAAC;CACD"}
+{"version":3,"file":"Species.js","sourceRoot":"","sources":["../../src/battle/Species.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAoB,MAAM,0BAA0B,CAAC;AA4BrF,2FAA2F;AAC3F,MAAM,cAAc,GAAG,UAAU,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;AAE9C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,QAAQ;IAMpB,YAAY,OAAwB;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,EAAE;YAC5E,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;SACzB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,yFAAyF;IACzF,YAAY;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnF,CAAC;IAEO,WAAW;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;IAC3G,CAAC;CACD"}

package/dist/battle/StatStages.d.ts

@@ -7,6 +7,20 @@ import type { StatBlock } from '../actors/StatBlock.ts';
  * seam that shape needed: `mwg` supplies the clamp and the one-modifier-per-stat bookkeeping,
  * a game supplies `multiplier` - there is no "official" stage-to-multiplier curve to default
  * to without copying a specific existing game's numbers.
+ *
+ * @example
+ * ```ts
+ * import { StatStages } from '@datamoc/mw_games/battle';
+ * import { StatBlock } from '@datamoc/mw_games/actors';
+ *
+ * const stats = new StatBlock({ base: { attack: 10 } });
+ * const stages = new StatStages(stats, { max: 6, multiplier: (stage) => 1 + stage * 0.5 });
+ *
+ * stages.change('attack', 2); // two stages up
+ * console.log(stats.get('attack')); // 20
+ *
+ * stages.resetAll(); // switching out clears every stage at once
+ * ```
  */
 export interface StatStagesOptions {
     /** the furthest a stage can go, either direction (Infinity for no cap at all) */

package/dist/battle/StatStages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StatStages.d.ts","sourceRoot":"","sources":["../../src/battle/StatStages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAY,MAAM,wBAAwB,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IACjC,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAC;IAEZ,6EAA6E;IAC7E,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACtC;AAED,qBAAa,UAAU;IACtB,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,aAAa,CAA4B;IAEjD,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAA+B;IAEhD,YAAY,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAIvD;IAED,sDAAsD;IACtD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAExB;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAS1C;IAED,OAAO,CAAC,aAAa;IAcrB,0FAA0F;IAC1F,QAAQ,IAAI,IAAI,CAIf;CACD"}
+{"version":3,"file":"StatStages.d.ts","sourceRoot":"","sources":["../../src/battle/StatStages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAY,MAAM,wBAAwB,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,iBAAiB;IACjC,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAC;IAEZ,6EAA6E;IAC7E,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACtC;AAED,qBAAa,UAAU;IACtB,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,aAAa,CAA4B;IAEjD,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAA+B;IAEhD,YAAY,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAIvD;IAED,sDAAsD;IACtD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAExB;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAS1C;IAED,OAAO,CAAC,aAAa;IAcrB,0FAA0F;IAC1F,QAAQ,IAAI,IAAI,CAIf;CACD"}

package/dist/battle/StatStages.js.map

@@ -1 +1 @@
-{"version":3,"file":"StatStages.js","sourceRoot":"","sources":["../../src/battle/StatStages.ts"],"names":[],"mappings":"AAmBA,MAAM,OAAO,UAAU;IAQtB,YAAY,KAAgB,EAAE,OAA0B;QAHhD,WAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACnC,cAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;QAG/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IACzC,CAAC;IAED,sDAAsD;IACtD,GAAG,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC;QAC/B,IAAI,OAAO,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAE5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,IAAY,EAAE,KAAa;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ;YAAE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAElD,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,OAAO;QACR,CAAC;QAED,MAAM,QAAQ,GAAa,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACtF,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,0FAA0F;IAC1F,QAAQ;QACP,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YAAE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpF,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACD"}
+{"version":3,"file":"StatStages.js","sourceRoot":"","sources":["../../src/battle/StatStages.ts"],"names":[],"mappings":"AAiCA,MAAM,OAAO,UAAU;IAQtB,YAAY,KAAgB,EAAE,OAA0B;QAHhD,WAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACnC,cAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;QAG/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IACzC,CAAC;IAED,sDAAsD;IACtD,GAAG,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC;QAC/B,IAAI,OAAO,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAE5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,IAAY,EAAE,KAAa;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ;YAAE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAElD,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,OAAO;QACR,CAAC;QAED,MAAM,QAAQ,GAAa,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACtF,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,0FAA0F;IAC1F,QAAQ;QACP,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YAAE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpF,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACD"}

package/dist/battle/TypeMatrix.d.ts

@@ -2,6 +2,17 @@
  * An effectiveness matrix between arbitrary types - `mwg` supplies the matrix, not a type
  * chart. Type names are whatever strings a game defines; an unset pairing multiplies by 1,
  * so a matrix only has to name the pairings that are not neutral.
+ *
+ * @example
+ * ```ts
+ * import { TypeMatrix } from '@datamoc/mw_games/battle';
+ *
+ * const matrix = new TypeMatrix();
+ * matrix.set('fire', 'grass', 2); // super effective
+ * matrix.set('fire', 'water', 0.5); // not very effective
+ *
+ * const total = matrix.multiplierFor('fire', ['grass', 'ice']); // 2 * 1 = 2
+ * ```
  */
 export declare class TypeMatrix {
     private multipliers;

package/dist/battle/TypeMatrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TypeMatrix.d.ts","sourceRoot":"","sources":["../../src/battle/TypeMatrix.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,GAAG;IAIX,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAElE;IAED,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEhD;IAED,0FAA0F;IAC1F,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAE1E;CACD"}
+{"version":3,"file":"TypeMatrix.d.ts","sourceRoot":"","sources":["../../src/battle/TypeMatrix.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,GAAG;IAIX,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAElE;IAED,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEhD;IAED,0FAA0F;IAC1F,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAE1E;CACD"}

package/dist/battle/TypeMatrix.js

@@ -2,6 +2,17 @@
  * An effectiveness matrix between arbitrary types - `mwg` supplies the matrix, not a type
  * chart. Type names are whatever strings a game defines; an unset pairing multiplies by 1,
  * so a matrix only has to name the pairings that are not neutral.
+ *
+ * @example
+ * ```ts
+ * import { TypeMatrix } from '@datamoc/mw_games/battle';
+ *
+ * const matrix = new TypeMatrix();
+ * matrix.set('fire', 'grass', 2); // super effective
+ * matrix.set('fire', 'water', 0.5); // not very effective
+ *
+ * const total = matrix.multiplierFor('fire', ['grass', 'ice']); // 2 * 1 = 2
+ * ```
  */
 export class TypeMatrix {
     constructor() {

package/dist/battle/TypeMatrix.js.map

@@ -1 +1 @@
-{"version":3,"file":"TypeMatrix.js","sourceRoot":"","sources":["../../src/battle/TypeMatrix.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAAvB;QACS,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAkBjD,CAAC;IAhBQ,GAAG,CAAC,SAAiB,EAAE,SAAiB;QAC/C,OAAO,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;IACpC,CAAC;IAED,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,UAAkB;QAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,GAAG,CAAC,SAAiB,EAAE,SAAiB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,0FAA0F;IAC1F,aAAa,CAAC,SAAiB,EAAE,cAAiC;QACjE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC;CACD"}
+{"version":3,"file":"TypeMatrix.js","sourceRoot":"","sources":["../../src/battle/TypeMatrix.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,UAAU;IAAvB;QACS,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAkBjD,CAAC;IAhBQ,GAAG,CAAC,SAAiB,EAAE,SAAiB;QAC/C,OAAO,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;IACpC,CAAC;IAED,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,UAAkB;QAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,GAAG,CAAC,SAAiB,EAAE,SAAiB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,0FAA0F;IAC1F,aAAa,CAAC,SAAiB,EAAE,cAAiC;QACjE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC;CACD"}

package/dist/board/Army.d.ts

@@ -4,14 +4,89 @@ export interface ArmyState {
     currency: number;
     pool: UnitTemplate[];
 }
+/**
+ * Recruit/income economy layered on top of `Tactics`'s board: a currency total plus a pool of
+ * banked unit templates waiting to be recalled onto the map. See `recruit`/`bankUnit`/
+ * `recall`/`armyIncome`/`applyUpkeep` for the rest of the economy this state drives.
+ *
+ * @example
+ * ```ts
+ * import { startingArmy } from '@datamoc/mw_games/board';
+ *
+ * console.log(startingArmy(100)); // { currency: 100, pool: [] }
+ * ```
+ */
 export declare function startingArmy(currency: number): ArmyState;
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ *
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ * console.log(army.currency); // 70 - 100 minus the 30 cost
+ * ```
+ */
 export declare function recruit(army: ArmyState, board: TacticalState, unit: TacticalUnit, cost: number): boolean;
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, bankUnit, recall, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ * bankUnit(army, board, 'scout');
+ *
+ * recall(army, board, 'scout', 1, 1);
+ * console.log(board.units.some((unit) => unit.id === 'scout')); // true - fielded again, at its new position
+ * ```
+ */
 export declare function recall(army: ArmyState, board: TacticalState, unitId: string, x: number, y: number): boolean;
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, bankUnit, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ *
+ * bankUnit(army, board, 'scout');
+ * console.log(board.units.length, army.pool.length); // 0 1 - pulled off the map, into the pool
+ * ```
+ */
 export declare function bankUnit(army: ArmyState, board: TacticalState, unitId: string): boolean;
 export interface UpkeepRates {
     incomePerUnit: number;
     upkeepPerUnit: number;
 }
+/**
+ * @example
+ * ```ts
+ * import { startingTactics, addTacticalUnit, armyIncome } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * addTacticalUnit(board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 });
+ *
+ * console.log(armyIncome(board, 'blue', { incomePerUnit: 5, upkeepPerUnit: 2 })); // 3 - one unit, net of upkeep
+ * ```
+ */
 export declare function armyIncome(board: TacticalState, owner: string, rates: UpkeepRates): number;
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, startingTactics, addTacticalUnit, applyUpkeep } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * addTacticalUnit(board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 });
+ * const army = startingArmy(100);
+ *
+ * applyUpkeep(army, board, 'blue', { incomePerUnit: 5, upkeepPerUnit: 2 });
+ * console.log(army.currency); // 103 - this turn's net income applied
+ * ```
+ */
 export declare function applyUpkeep(army: ArmyState, board: TacticalState, owner: string, rates: UpkeepRates): number;
 //# sourceMappingURL=Army.d.ts.map

package/dist/board/Army.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Army.d.ts","sourceRoot":"","sources":["../../src/board/Army.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAKhE,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;AAEzD,MAAM,WAAW,SAAS;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,YAAY,EAAE,CAAC;CACrB;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAExD;AAKD,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAKxG;AAID,wBAAgB,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAM3G;AAID,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAOvF;AAED,MAAM,WAAW,WAAW;IAAG,aAAa,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;CAAE;AAK9E,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAG1F;AAGD,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAG5G"}
+{"version":3,"file":"Army.d.ts","sourceRoot":"","sources":["../../src/board/Army.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAKhE,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;AAEzD,MAAM,WAAW,SAAS;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,YAAY,EAAE,CAAC;CACrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAExD;AAKD;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAKxG;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAM3G;AAID;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAOvF;AAED,MAAM,WAAW,WAAW;IAAG,aAAa,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;CAAE;AAK9E;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAG1F;AAGD;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAG5G"}

package/dist/board/Army.js

@@ -1,10 +1,34 @@
 import { addTacticalUnit, canPlaceTacticalUnit } from './Tactics.js';
+/**
+ * Recruit/income economy layered on top of `Tactics`'s board: a currency total plus a pool of
+ * banked unit templates waiting to be recalled onto the map. See `recruit`/`bankUnit`/
+ * `recall`/`armyIncome`/`applyUpkeep` for the rest of the economy this state drives.
+ *
+ * @example
+ * ```ts
+ * import { startingArmy } from '@datamoc/mw_games/board';
+ *
+ * console.log(startingArmy(100)); // { currency: 100, pool: [] }
+ * ```
+ */
 export function startingArmy(currency) {
     return { currency, pool: [] };
 }
 //deducts cost and places a fresh unit, all-or-nothing like actors.Shop's buy/sell: touches
 //neither currency nor the board unless every check already passed - canPlaceTacticalUnit is
 //checked up front rather than letting addTacticalUnit's own throw escape a boolean contract
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ *
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ * console.log(army.currency); // 70 - 100 minus the 30 cost
+ * ```
+ */
 export function recruit(army, board, unit, cost) {
     if (army.currency < cost || !canPlaceTacticalUnit(board, unit.x, unit.y))
         return false;
@@ -14,6 +38,20 @@ export function recruit(army, board, unit, cost) {
 }
 //pulls a previously-fielded unit back onto the map instead of minting a fresh one - the
 //template stays in the pool until recalled, then leaves it the way stock leaves a shop's shelf
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, bankUnit, recall, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ * bankUnit(army, board, 'scout');
+ *
+ * recall(army, board, 'scout', 1, 1);
+ * console.log(board.units.some((unit) => unit.id === 'scout')); // true - fielded again, at its new position
+ * ```
+ */
 export function recall(army, board, unitId, x, y) {
     const index = army.pool.findIndex((template) => template.id === unitId);
     if (index === -1 || !canPlaceTacticalUnit(board, x, y))
@@ -24,6 +62,19 @@ export function recall(army, board, unitId, x, y) {
 }
 //moves a fielded unit into the recall pool instead of discarding it outright - the inverse of
 //recall, for retreating a unit off the map between engagements rather than losing it for good
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, recruit, bankUnit, startingTactics } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * const army = startingArmy(100);
+ * recruit(army, board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 }, 30);
+ *
+ * bankUnit(army, board, 'scout');
+ * console.log(board.units.length, army.pool.length); // 0 1 - pulled off the map, into the pool
+ * ```
+ */
 export function bankUnit(army, board, unitId) {
     const index = board.units.findIndex((unit) => unit.id === unitId);
     if (index === -1)
@@ -36,11 +87,35 @@ export function bankUnit(army, board, unitId) {
 //net currency delta for one turn's income minus upkeep, purely a function of how many units
 //an owner controls on the board - no formula beyond that belongs here, per this project's
 //policy against borrowing any specific game's numbers
+/**
+ * @example
+ * ```ts
+ * import { startingTactics, addTacticalUnit, armyIncome } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * addTacticalUnit(board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 });
+ *
+ * console.log(armyIncome(board, 'blue', { incomePerUnit: 5, upkeepPerUnit: 2 })); // 3 - one unit, net of upkeep
+ * ```
+ */
 export function armyIncome(board, owner, rates) {
     const controlled = board.units.filter((unit) => unit.owner === owner).length;
     return controlled * (rates.incomePerUnit - rates.upkeepPerUnit);
 }
 //applies one turn's income/upkeep tick to an army's currency and returns the new total
+/**
+ * @example
+ * ```ts
+ * import { startingArmy, startingTactics, addTacticalUnit, applyUpkeep } from '@datamoc/mw_games/board';
+ *
+ * const board = startingTactics(6, 6, 'square');
+ * addTacticalUnit(board, { id: 'scout', owner: 'blue', x: 0, y: 0, hp: 6, maxHp: 6, actions: 2 });
+ * const army = startingArmy(100);
+ *
+ * applyUpkeep(army, board, 'blue', { incomePerUnit: 5, upkeepPerUnit: 2 });
+ * console.log(army.currency); // 103 - this turn's net income applied
+ * ```
+ */
 export function applyUpkeep(army, board, owner, rates) {
     army.currency += armyIncome(board, owner, rates);
     return army.currency;

package/dist/board/Army.js.map

@@ -1 +1 @@
-{"version":3,"file":"Army.js","sourceRoot":"","sources":["../../src/board/Army.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAWrE,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC5C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAC/B,CAAC;AAED,2FAA2F;AAC3F,4FAA4F;AAC5F,4FAA4F;AAC5F,MAAM,UAAU,OAAO,CAAC,IAAe,EAAE,KAAoB,EAAE,IAAkB,EAAE,IAAY;IAC9F,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACvF,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC7B,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC;IACtB,OAAO,IAAI,CAAC;AACb,CAAC;AAED,wFAAwF;AACxF,+FAA+F;AAC/F,MAAM,UAAU,MAAM,CAAC,IAAe,EAAE,KAAoB,EAAE,MAAc,EAAE,CAAS,EAAE,CAAS;IACjG,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IACxE,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACrE,eAAe,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC;AACb,CAAC;AAED,8FAA8F;AAC9F,8FAA8F;AAC9F,MAAM,UAAU,QAAQ,CAAC,IAAe,EAAE,KAAoB,EAAE,MAAc;IAC7E,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IAClE,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACzD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC;AACb,CAAC;AAID,4FAA4F;AAC5F,0FAA0F;AAC1F,sDAAsD;AACtD,MAAM,UAAU,UAAU,CAAC,KAAoB,EAAE,KAAa,EAAE,KAAkB;IACjF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,MAAM,CAAC;IAC7E,OAAO,UAAU,GAAG,CAAC,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;AACjE,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,WAAW,CAAC,IAAe,EAAE,KAAoB,EAAE,KAAa,EAAE,KAAkB;IACnG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,OAAO,IAAI,CAAC,QAAQ,CAAC;AACtB,CAAC"}
+{"version":3,"file":"Army.js","sourceRoot":"","sources":["../../src/board/Army.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAWrE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC5C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAC/B,CAAC;AAED,2FAA2F;AAC3F,4FAA4F;AAC5F,4FAA4F;AAC5F;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CAAC,IAAe,EAAE,KAAoB,EAAE,IAAkB,EAAE,IAAY;IAC9F,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACvF,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC7B,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC;IACtB,OAAO,IAAI,CAAC;AACb,CAAC;AAED,wFAAwF;AACxF,+FAA+F;AAC/F;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,MAAM,CAAC,IAAe,EAAE,KAAoB,EAAE,MAAc,EAAE,CAAS,EAAE,CAAS;IACjG,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IACxE,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACrE,eAAe,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC;AACb,CAAC;AAED,8FAA8F;AAC9F,8FAA8F;AAC9F;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAe,EAAE,KAAoB,EAAE,MAAc;IAC7E,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IAClE,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACzD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC;AACb,CAAC;AAID,4FAA4F;AAC5F,0FAA0F;AAC1F,sDAAsD;AACtD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAC,KAAoB,EAAE,KAAa,EAAE,KAAkB;IACjF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,MAAM,CAAC;IAC7E,OAAO,UAAU,GAAG,CAAC,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;AACjE,CAAC;AAED,uFAAuF;AACvF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,IAAe,EAAE,KAAoB,EAAE,KAAa,EAAE,KAAkB;IACnG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,OAAO,IAAI,CAAC,QAAQ,CAAC;AACtB,CAAC"}