@gamepark/rules-api 6.24.1 → 6.24.3

package/dist/material/moves/items/SelectItem.d.ts

@@ -1,11 +1,31 @@
 import { MaterialMove } from '../MaterialMove';
 import { MaterialMoveCommon } from './ItemMove';
 import { ItemMoveType } from './ItemMoveType';
+/**
+ * Move object that will select one {@link MaterialItem} (or a part of its quantity), when played.
+ * Use {@link Material} utility to build the move easily.
+ * The same object is used to unselect an item.
+ *
+ * @property itemIndex index of the item to move
+ * @property quantity if provided, move the specified quantity from the item (split in two items). Otherwise, move all the item.
+ * @property selected False to unselect
+ */
 export type SelectItem<MaterialType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.Select;
     itemIndex: number;
     quantity?: number;
     selected?: boolean;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link SelectItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link SelectItem}
+ */
 export declare function isSelectItem<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is SelectItem<M>;
+/**
+ * Function to get a type guard for a {@link SelectItem} move for specific item types.
+ * @param type Item type to test
+ * @param index Optional itemIndex to test along the item type
+ * @returns a type guard similar as {@link isSelectItem} but that also verify the item type.
+ */
 export declare function isSelectItemType<P extends number, M extends number, L extends number>(type: M, index?: number): (move: MaterialMove<P, M, L>) => move is SelectItem<M>;

package/dist/material/moves/items/SelectItem.js

@@ -3,10 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isSelectItemType = exports.isSelectItem = void 0;
 var MoveKind_1 = require("../MoveKind");
 var ItemMoveType_1 = require("./ItemMoveType");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link SelectItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link SelectItem}
+ */
 function isSelectItem(move) {
     return move.kind === MoveKind_1.MoveKind.ItemMove && move.type === ItemMoveType_1.ItemMoveType.Select;
 }
 exports.isSelectItem = isSelectItem;
+/**
+ * Function to get a type guard for a {@link SelectItem} move for specific item types.
+ * @param type Item type to test
+ * @param index Optional itemIndex to test along the item type
+ * @returns a type guard similar as {@link isSelectItem} but that also verify the item type.
+ */
 function isSelectItemType(type, index) {
     return function (move) {
         return isSelectItem(move) && move.itemType === type && (index === undefined || move.itemIndex === index);

package/dist/material/moves/items/SelectItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"SelectItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/SelectItem.ts"],"names":[],"mappings":";;;AACA,wCAAsC;AAEtC,+CAA6C;AAuB7C,SAAgB,YAAY,CAAuD,IAA2B;IAC5G,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,MAAM,CAAA;AAC7E,CAAC;AAFD,oCAEC;AAQD,SAAgB,gBAAgB,CAC9B,IAAO,EAAE,KAAc;IAEvB,OAAO,UAAC,IAA2B;QACjC,OAAA,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;IAAjG,CAAiG,CAAA;AACrG,CAAC;AALD,4CAKC"}
+{"version":3,"file":"SelectItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/SelectItem.ts"],"names":[],"mappings":";;;AACA,wCAAsC;AAEtC,+CAA6C;AAkB7C;;;;GAIG;AACH,SAAgB,YAAY,CAAuD,IAA2B;IAC5G,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,MAAM,CAAA;AAC7E,CAAC;AAFD,oCAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,IAAO,EAAE,KAAc;IAEvB,OAAO,UAAC,IAA2B;QACjC,OAAA,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;IAAjG,CAAiG,CAAA;AACrG,CAAC;AALD,4CAKC"}

package/dist/material/moves/items/Shuffle.d.ts

@@ -1,13 +1,39 @@
 import { ItemMoveType } from './ItemMoveType';
 import { MaterialMoveCommon } from './ItemMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object that will shuffle a list of {@link MaterialItem}, when played.
+ * Use {@link Material} utility to build the move easily.
+ * When items are shuffled, they swap their indexes randomly so that players can never "track" one item in the list.
+ *
+ * @property indexes indexes of the items to shuffle
+ */
 export type Shuffle<MaterialType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.Shuffle;
     indexes: number[];
 };
+/**
+ * Data structure when a {@link Shuffle} move has been randomized.
+ * @property newIndexes The new random indexes
+ */
 export type ShuffleRandomized<MaterialType extends number = number> = Shuffle<MaterialType> & {
     newIndexes: number[];
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link Shuffle} move
+ * @param move Move to test
+ * @returns true if move is a {@link Shuffle}
+ */
 export declare function isShuffle<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is Shuffle<M>;
+/**
+ * Function to get a type guard for a {@link Shuffle} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isShuffle} but that also verify the item type.
+ */
 export declare function isShuffleItemType<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is Shuffle<M>;
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link ShuffleRandomized} move
+ * @param move Move to test
+ * @returns true if move is a {@link ShuffleRandomized}
+ */
 export declare function isShuffleRandomized<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is ShuffleRandomized<M>;

package/dist/material/moves/items/Shuffle.js

@@ -3,16 +3,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isShuffleRandomized = exports.isShuffleItemType = exports.isShuffle = void 0;
 var ItemMoveType_1 = require("./ItemMoveType");
 var MoveKind_1 = require("../MoveKind");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link Shuffle} move
+ * @param move Move to test
+ * @returns true if move is a {@link Shuffle}
+ */
 function isShuffle(move) {
     return move.kind === MoveKind_1.MoveKind.ItemMove && move.type === ItemMoveType_1.ItemMoveType.Shuffle;
 }
 exports.isShuffle = isShuffle;
+/**
+ * Function to get a type guard for a {@link Shuffle} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isShuffle} but that also verify the item type.
+ */
 function isShuffleItemType(type) {
     return function (move) {
         return isShuffle(move) && move.itemType === type;
     };
 }
 exports.isShuffleItemType = isShuffleItemType;
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link ShuffleRandomized} move
+ * @param move Move to test
+ * @returns true if move is a {@link ShuffleRandomized}
+ */
 function isShuffleRandomized(move) {
     return isShuffle(move) && Array.isArray(move.newIndexes);
 }

package/dist/material/moves/items/Shuffle.js.map

@@ -1 +1 @@
-{"version":3,"file":"Shuffle.js","sourceRoot":"","sources":["../../../../src/material/moves/items/Shuffle.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAG7C,wCAAsC;AA2BtC,SAAgB,SAAS,CAAuD,IAA2B;IACzG,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,OAAO,CAAA;AAC9E,CAAC;AAFD,8BAEC;AAOD,SAAgB,iBAAiB,CAC/B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAzC,CAAyC,CAAA;AAC7C,CAAC;AALD,8CAKC;AAOD,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAE,IAA6B,CAAC,UAAU,CAAC,CAAA;AACpF,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"Shuffle.js","sourceRoot":"","sources":["../../../../src/material/moves/items/Shuffle.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAG7C,wCAAsC;AAsBtC;;;;GAIG;AACH,SAAgB,SAAS,CAAuD,IAA2B;IACzG,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,OAAO,CAAA;AAC9E,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAC/B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAzC,CAAyC,CAAA;AAC7C,CAAC;AALD,8CAKC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAE,IAA6B,CAAC,UAAU,CAAC,CAAA;AACpF,CAAC;AAFD,kDAEC"}

package/dist/material/moves/local/CloseTutorialPopup.d.ts

@@ -1,8 +1,16 @@
 import { MoveKind } from '../MoveKind';
 import { LocalMoveType } from './LocalMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object to close the popup during a tutorial
+ */
 export type CloseTutorialPopup = {
     kind: MoveKind.LocalMove;
     type: LocalMoveType.CloseTutorialPopup;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link CloseTutorialPopup} move
+ * @param move Move to test
+ * @returns true if move is a {@link CloseTutorialPopup}
+ */
 export declare function isCloseTutorialPopup(move: MaterialMove): move is CloseTutorialPopup;

package/dist/material/moves/local/CloseTutorialPopup.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCloseTutorialPopup = void 0;
 var MoveKind_1 = require("../MoveKind");
 var LocalMove_1 = require("./LocalMove");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link CloseTutorialPopup} move
+ * @param move Move to test
+ * @returns true if move is a {@link CloseTutorialPopup}
+ */
 function isCloseTutorialPopup(move) {
     return move.kind === MoveKind_1.MoveKind.LocalMove && move.type === LocalMove_1.LocalMoveType.CloseTutorialPopup;
 }

package/dist/material/moves/local/CloseTutorialPopup.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloseTutorialPopup.js","sourceRoot":"","sources":["../../../../src/material/moves/local/CloseTutorialPopup.ts"],"names":[],"mappings":";;;AAAA,wCAAsC;AACtC,yCAA2C;AAgB3C,SAAgB,oBAAoB,CAAC,IAAkB;IACrD,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAa,CAAC,kBAAkB,CAAA;AAC3F,CAAC;AAFD,oDAEC"}
+{"version":3,"file":"CloseTutorialPopup.js","sourceRoot":"","sources":["../../../../src/material/moves/local/CloseTutorialPopup.ts"],"names":[],"mappings":";;;AAAA,wCAAsC;AACtC,yCAA2C;AAW3C;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,IAAkB;IACrD,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAa,CAAC,kBAAkB,CAAA;AAC3F,CAAC;AAFD,oDAEC"}

package/dist/material/moves/local/DisplayHelp.d.ts

@@ -2,12 +2,21 @@ import { MaterialItem } from '../../items';
 import { Location } from '../../location';
 import { MoveKind } from '../MoveKind';
 import { LocalMoveType } from './LocalMove';
+/**
+ * Common type for the moves that display a help dialog
+ */
 export type HelpDisplay<P extends number = number, M extends number = number, L extends number = number, RuleId extends number = number> = MaterialHelpDisplay<P, M, L> | LocationHelpDisplay<P, L> | RulesHelpDisplay<RuleId>;
+/**
+ * Type of help dialogs that can be opened
+ */
 export declare enum HelpDisplayType {
     Material = 1,
     Location = 2,
     Rules = 3
 }
+/**
+ * Data structure describing a help dialog about a {@link MaterialItem}
+ */
 export type MaterialHelpDisplay<P extends number = number, M extends number = number, L extends number = number> = {
     type: typeof HelpDisplayType.Material;
     itemType: M;
@@ -15,14 +24,23 @@ export type MaterialHelpDisplay<P extends number = number, M extends number = nu
     displayIndex?: number;
     item: Partial<MaterialItem<P, L>>;
 };
+/**
+ * Data structure describing a help dialog about a {@link Location}
+ */
 export type LocationHelpDisplay<P extends number = number, L extends number = number> = {
     type: typeof HelpDisplayType.Location;
     location: Location<P, L>;
 };
+/**
+ * Data structure describing a help dialog about a point in the rules of a game
+ */
 export type RulesHelpDisplay<RuleId extends number = number> = {
     type: typeof HelpDisplayType.Rules;
     ruleId: RuleId;
 };
+/**
+ * Move object to display a help dialog
+ */
 export type DisplayHelp<P extends number = number, M extends number = number, L extends number = number> = {
     kind: MoveKind.LocalMove;
     type: typeof LocalMoveType.DisplayHelp;

package/dist/material/moves/local/DisplayHelp.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HelpDisplayType = void 0;
+/**
+ * Type of help dialogs that can be opened
+ */
 var HelpDisplayType;
 (function (HelpDisplayType) {
     HelpDisplayType[HelpDisplayType["Material"] = 1] = "Material";

package/dist/material/moves/local/DisplayHelp.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayHelp.js","sourceRoot":"","sources":["../../../../src/material/moves/local/DisplayHelp.ts"],"names":[],"mappings":";;;AAgBA,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,6DAAY,CAAA;IAAE,6DAAQ,CAAA;IAAE,uDAAK,CAAA;AAC/B,CAAC,EAFW,eAAe,+BAAf,eAAe,QAE1B"}
+{"version":3,"file":"DisplayHelp.js","sourceRoot":"","sources":["../../../../src/material/moves/local/DisplayHelp.ts"],"names":[],"mappings":";;;AAaA;;GAEG;AACH,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,6DAAY,CAAA;IAAE,6DAAQ,CAAA;IAAE,uDAAK,CAAA;AAC/B,CAAC,EAFW,eAAe,+BAAf,eAAe,QAE1B"}

package/dist/material/moves/local/DropItem.d.ts

@@ -1,10 +1,19 @@
 import { MoveKind } from '../MoveKind';
 import { LocalMoveType } from './LocalMove';
+/**
+ * Move object to remind when a player has dropped an item
+ */
 export type DropItem<M extends number = number> = {
     kind: MoveKind.LocalMove;
     type: typeof LocalMoveType.DropItem;
     item: DisplayedItem<M>;
 };
+/**
+ * Data structure of an item displayed on screen
+ * @property type the type of item
+ * @property index index of the item
+ * @property displayIndex when the item has a quantity, the index of the specific item inside the quantity (otherwise 0)
+ */
 export type DisplayedItem<M extends number = number> = {
     type: M;
     index: number;

package/dist/material/moves/local/LocalMove.d.ts

@@ -2,7 +2,13 @@ import { CloseTutorialPopup } from './CloseTutorialPopup';
 import { DisplayHelp } from './DisplayHelp';
 import { DropItem } from './DropItem';
 import { SetTutorialStep } from './SetTutorialStep';
+/**
+ * Common type for all the moves designed to be local (not sent to the server)
+ */
 export type LocalMove<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> = DisplayHelp<Player, MaterialType, LocationType> | DropItem<MaterialType> | SetTutorialStep | CloseTutorialPopup;
+/**
+ * Types of local moves
+ */
 export declare enum LocalMoveType {
     DisplayHelp = 1,
     DropItem = 2,

package/dist/material/moves/local/LocalMove.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalMoveType = void 0;
+/**
+ * Types of local moves
+ */
 var LocalMoveType;
 (function (LocalMoveType) {
     LocalMoveType[LocalMoveType["DisplayHelp"] = 1] = "DisplayHelp";

package/dist/material/moves/local/LocalMove.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalMove.js","sourceRoot":"","sources":["../../../../src/material/moves/local/LocalMove.ts"],"names":[],"mappings":";;;AAiBA,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,+DAAe,CAAA;IAAE,yDAAQ,CAAA;IAAE,uEAAe,CAAA;IAAE,6EAAkB,CAAA;AAChE,CAAC,EAFW,aAAa,6BAAb,aAAa,QAExB"}
+{"version":3,"file":"LocalMove.js","sourceRoot":"","sources":["../../../../src/material/moves/local/LocalMove.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,+DAAe,CAAA;IAAE,yDAAQ,CAAA;IAAE,uEAAe,CAAA;IAAE,6EAAkB,CAAA;AAChE,CAAC,EAFW,aAAa,6BAAb,aAAa,QAExB"}

package/dist/material/moves/local/SetTutorialStep.d.ts

@@ -1,9 +1,17 @@
 import { MoveKind } from '../MoveKind';
 import { LocalMoveType } from './LocalMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object to set a tutorial to a specific step
+ */
 export type SetTutorialStep = {
     kind: MoveKind.LocalMove;
     type: LocalMoveType.SetTutorialStep;
     step: number;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link SetTutorialStep} move
+ * @param move Move to test
+ * @returns true if move is a {@link SetTutorialStep}
+ */
 export declare function isSetTutorialStep(move: MaterialMove): move is SetTutorialStep;

package/dist/material/moves/local/SetTutorialStep.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isSetTutorialStep = void 0;
 var MoveKind_1 = require("../MoveKind");
 var LocalMove_1 = require("./LocalMove");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link SetTutorialStep} move
+ * @param move Move to test
+ * @returns true if move is a {@link SetTutorialStep}
+ */
 function isSetTutorialStep(move) {
     return move.kind === MoveKind_1.MoveKind.LocalMove && move.type === LocalMove_1.LocalMoveType.SetTutorialStep;
 }

package/dist/material/moves/local/SetTutorialStep.js.map

@@ -1 +1 @@
-{"version":3,"file":"SetTutorialStep.js","sourceRoot":"","sources":["../../../../src/material/moves/local/SetTutorialStep.ts"],"names":[],"mappings":";;;AAAA,wCAAsC;AACtC,yCAA2C;AAiB3C,SAAgB,iBAAiB,CAAC,IAAkB;IAClD,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAa,CAAC,eAAe,CAAA;AACxF,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"SetTutorialStep.js","sourceRoot":"","sources":["../../../../src/material/moves/local/SetTutorialStep.ts"],"names":[],"mappings":";;;AAAA,wCAAsC;AACtC,yCAA2C;AAY3C;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAkB;IAClD,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAa,CAAC,eAAe,CAAA;AACxF,CAAC;AAFD,8CAEC"}

package/dist/material/rules/MaterialRulesPart.d.ts

@@ -4,24 +4,100 @@ import { MaterialGame } from '../MaterialGame';
 import { GameMemory, PlayerMemory } from '../memory';
 import { CustomMove, ItemMove, MaterialMove, MaterialMoveBuilder, RuleMove } from '../moves';
 import { RuleStep } from './RuleStep';
+/**
+ * When you implement the rules of a game using {@link MaterialRules}, the rules are split into small parts.
+ * This is the base class to implement one part of the rules.
+ * The constructor cannot be changed as the class is instantiated by {@link MaterialRules}.
+ */
 export declare abstract class MaterialRulesPart<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> {
+    /**
+     * Helper function to get a {@link Material} instance to work on some item type in the game.
+     * @param type Type of material
+     * @returns {Material} the material instance
+     */
     material(type: MaterialType): Material<Player, MaterialType, LocationType>;
+    /**
+     * This function is called immediately before an {@link ItemMove} is played.
+     * @param _move The move which is going to be played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     beforeItemMove(_move: ItemMove<Player, MaterialType, LocationType>, _context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * This function is called immediately after an {@link ItemMove} is played.
+     * @param _move The move which has just been played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     afterItemMove(_move: ItemMove<Player, MaterialType, LocationType>, _context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * This function is called immediately after the {@link RuleMove} that started this rules step was played
+     * @param _move The move which has just been played
+     * @param _previousRule The step of the rules immediately before this one started
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     onRuleStart<RuleId extends number>(_move: RuleMove<Player, RuleId>, _previousRule?: RuleStep, _context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * This function is called just before a {@link RuleMove} that leave this rules step is played.
+     *
+     * BEWARE: any consequences returned here will happen inside the next rule step. Usually we only clean the memory here.
+     *
+     * @param _move The move which is going to be played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     onRuleEnd<RuleId extends number>(_move: RuleMove<Player, RuleId>, _context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * This function is called when a {@link CustomMove} is played.
+     * @param _move The move
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     onCustomMove(_move: CustomMove, _context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * @deprecated replace this.rules().[the function] with: this.[the function]
+     */
     rules(): typeof MaterialMoveBuilder;
     startPlayerTurn: <P extends number = number, R extends number = number>(id: R, player: P) => import("../moves").StartPlayerTurn<P, R>;
     startSimultaneousRule: <P extends number = number, R extends number = number>(id: R, players?: P[] | undefined) => import("../moves").StartSimultaneousRule<P, R>;
     startRule: <R extends number = number>(id: R) => import("../moves").StartRule<R>;
     customMove: <Type extends number = number>(type: Type, data?: any) => CustomMove;
     endGame: () => import("../moves").EndGame;
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     protected getMemory(player?: Player): GameMemory<Player> | PlayerMemory<Player>;
+    /**
+     * Save a new value inside the memory.
+     * @param key The key to index the memorized value.
+     * @param value Any JSON serializable value to store, or a function that takes previous stored value and returns the new value to store.
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     memorize<T = any>(key: keyof any, value: T | ((lastValue: T) => T), player?: Player): void;
+    /**
+     * Retrieve the value memorized under a given key.
+     * Shortcut for this.game.memory[key] or this.game.memory[key][player]
+     *
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     remind<T = any>(key: keyof any, player?: Player): T;
+    /**
+     * Delete a value from the memory
+     * @param key Key of the value to delete
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     forget(key: keyof any, player?: Player): void;
 }
+/**
+ * Creator interface for a class that extends {@link MaterialRulesPart} with the same constructor.
+ */
 export interface MaterialRulesPartCreator<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> {
     new (game: MaterialGame<Player, MaterialType, LocationType>): MaterialRulesPart<Player, MaterialType, LocationType>;
 }

package/dist/material/rules/MaterialRulesPart.js

@@ -20,7 +20,12 @@ var Rules_1 = require("../../Rules");
 var items_1 = require("../items");
 var memory_1 = require("../memory");
 var moves_1 = require("../moves");
-var MaterialRulesPart = (function (_super) {
+/**
+ * When you implement the rules of a game using {@link MaterialRules}, the rules are split into small parts.
+ * This is the base class to implement one part of the rules.
+ * The constructor cannot be changed as the class is instantiated by {@link MaterialRules}.
+ */
+var MaterialRulesPart = /** @class */ (function (_super) {
     __extends(MaterialRulesPart, _super);
     function MaterialRulesPart() {
         var _this = _super !== null && _super.apply(this, arguments) || this;
@@ -31,37 +36,105 @@ var MaterialRulesPart = (function (_super) {
         _this.endGame = moves_1.MaterialMoveBuilder.endGame;
         return _this;
     }
+    /**
+     * Helper function to get a {@link Material} instance to work on some item type in the game.
+     * @param type Type of material
+     * @returns {Material} the material instance
+     */
     MaterialRulesPart.prototype.material = function (type) {
         var _a;
         return new items_1.Material(type, Array.from(((_a = this.game.items[type]) !== null && _a !== void 0 ? _a : []).entries()).filter(function (entry) { return entry[1].quantity !== 0; }));
     };
+    /**
+     * This function is called immediately before an {@link ItemMove} is played.
+     * @param _move The move which is going to be played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     MaterialRulesPart.prototype.beforeItemMove = function (_move, _context) {
         return [];
     };
+    /**
+     * This function is called immediately after an {@link ItemMove} is played.
+     * @param _move The move which has just been played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     MaterialRulesPart.prototype.afterItemMove = function (_move, _context) {
         return [];
     };
+    /**
+     * This function is called immediately after the {@link RuleMove} that started this rules step was played
+     * @param _move The move which has just been played
+     * @param _previousRule The step of the rules immediately before this one started
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     MaterialRulesPart.prototype.onRuleStart = function (_move, _previousRule, _context) {
         return [];
     };
+    /**
+     * This function is called just before a {@link RuleMove} that leave this rules step is played.
+     *
+     * BEWARE: any consequences returned here will happen inside the next rule step. Usually we only clean the memory here.
+     *
+     * @param _move The move which is going to be played
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     MaterialRulesPart.prototype.onRuleEnd = function (_move, _context) {
         return [];
     };
+    /**
+     * This function is called when a {@link CustomMove} is played.
+     * @param _move The move
+     * @param _context Context of execution
+     * @returns {MaterialMove[]} Any consequences that should automatically be played after the move
+     */
     MaterialRulesPart.prototype.onCustomMove = function (_move, _context) {
         return [];
     };
+    /**
+     * @deprecated replace this.rules().[the function] with: this.[the function]
+     */
     MaterialRulesPart.prototype.rules = function () {
         return moves_1.MaterialMoveBuilder;
     };
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     MaterialRulesPart.prototype.getMemory = function (player) {
         return player === undefined ? new memory_1.GameMemory(this.game) : new memory_1.PlayerMemory(this.game, player);
     };
+    /**
+     * Save a new value inside the memory.
+     * @param key The key to index the memorized value.
+     * @param value Any JSON serializable value to store, or a function that takes previous stored value and returns the new value to store.
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialRulesPart.prototype.memorize = function (key, value, player) {
         this.getMemory(player).memorize(key, value);
     };
+    /**
+     * Retrieve the value memorized under a given key.
+     * Shortcut for this.game.memory[key] or this.game.memory[key][player]
+     *
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialRulesPart.prototype.remind = function (key, player) {
         return this.getMemory(player).remind(key);
     };
+    /**
+     * Delete a value from the memory
+     * @param key Key of the value to delete
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialRulesPart.prototype.forget = function (key, player) {
         this.getMemory(player).forget(key);
     };

package/dist/material/rules/MaterialRulesPart.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialRulesPart.js","sourceRoot":"","sources":["../../../src/material/rules/MaterialRulesPart.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AACpD,kCAAmC;AAEnC,oCAAoD;AACpD,kCAA4F;AAQ5F;IACU,qCAAiH;IAD3H;;QAyEE,qBAAe,GAAG,2BAAmB,CAAC,eAAe,CAAA;QACrD,2BAAqB,GAAG,2BAAmB,CAAC,qBAAqB,CAAA;QACjE,eAAS,GAAG,2BAAmB,CAAC,SAAS,CAAA;QACzC,gBAAU,GAAG,2BAAmB,CAAC,UAAU,CAAA;QAC3C,aAAO,GAAG,2BAAmB,CAAC,OAAO,CAAA;;IA2CvC,CAAC;IAhHC,oCAAQ,GAAR,UAAS,IAAkB;;QACzB,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,CAAC,CAAA;IACzH,CAAC;IAQD,0CAAc,GAAd,UAAe,KAAmD,EAAE,QAA0B;QAC5F,OAAO,EAAE,CAAA;IACX,CAAC;IAQD,yCAAa,GAAb,UAAc,KAAmD,EAAE,QAA0B;QAC3F,OAAO,EAAE,CAAA;IACX,CAAC;IASD,uCAAW,GAAX,UAAmC,KAA+B,EAAE,aAAwB,EAAE,QAA0B;QACtH,OAAO,EAAE,CAAA;IACX,CAAC;IAWD,qCAAS,GAAT,UAAiC,KAA+B,EAAE,QAA0B;QAC1F,OAAO,EAAE,CAAA;IACX,CAAC;IAQD,wCAAY,GAAZ,UAAa,KAAiB,EAAE,QAA0B;QACxD,OAAO,EAAE,CAAA;IACX,CAAC;IAKD,iCAAK,GAAL;QACE,OAAO,2BAAmB,CAAA;IAC5B,CAAC;IAgBS,qCAAS,GAAnB,UAAoB,MAAe;QACjC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAQD,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAe;QACjF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IASD,kCAAM,GAAN,UAAgB,GAAc,EAAE,MAAe;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC;IAOD,kCAAM,GAAN,UAAO,GAAc,EAAE,MAAe;QACpC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACpC,CAAC;IACH,wBAAC;AAAD,CAAC,AAxHD,CACU,aAAK,GAuHd;AAxHqB,8CAAiB"}
+{"version":3,"file":"MaterialRulesPart.js","sourceRoot":"","sources":["../../../src/material/rules/MaterialRulesPart.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AACpD,kCAAmC;AAEnC,oCAAoD;AACpD,kCAA4F;AAG5F;;;;GAIG;AACH;IACU,qCAAiH;IAD3H;;QAyEE,qBAAe,GAAG,2BAAmB,CAAC,eAAe,CAAA;QACrD,2BAAqB,GAAG,2BAAmB,CAAC,qBAAqB,CAAA;QACjE,eAAS,GAAG,2BAAmB,CAAC,SAAS,CAAA;QACzC,gBAAU,GAAG,2BAAmB,CAAC,UAAU,CAAA;QAC3C,aAAO,GAAG,2BAAmB,CAAC,OAAO,CAAA;;IA2CvC,CAAC;IArHC;;;;OAIG;IACH,oCAAQ,GAAR,UAAS,IAAkB;;QACzB,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,CAAC,CAAA;IACzH,CAAC;IAED;;;;;OAKG;IACH,0CAAc,GAAd,UAAe,KAAmD,EAAE,QAA0B;QAC5F,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACH,yCAAa,GAAb,UAAc,KAAmD,EAAE,QAA0B;QAC3F,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;OAMG;IACH,uCAAW,GAAX,UAAmC,KAA+B,EAAE,aAAwB,EAAE,QAA0B;QACtH,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;;;OAQG;IACH,qCAAS,GAAT,UAAiC,KAA+B,EAAE,QAA0B;QAC1F,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACH,wCAAY,GAAZ,UAAa,KAAiB,EAAE,QAA0B;QACxD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH,iCAAK,GAAL;QACE,OAAO,2BAAmB,CAAA;IAC5B,CAAC;IAQD;;;;;;;OAOG;IACO,qCAAS,GAAnB,UAAoB,MAAe;QACjC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAED;;;;;OAKG;IACH,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAe;QACjF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,kCAAM,GAAN,UAAgB,GAAc,EAAE,MAAe;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC;IAED;;;;OAIG;IACH,kCAAM,GAAN,UAAO,GAAc,EAAE,MAAe;QACpC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACpC,CAAC;IACH,wBAAC;AAAD,CAAC,AAxHD,CACU,aAAK,GAuHd;AAxHqB,8CAAiB"}

package/dist/material/rules/PlayerTurnRule.d.ts

@@ -1,9 +1,28 @@
 import { MaterialMove } from '../moves';
 import { MaterialRulesPart } from './MaterialRulesPart';
+/**
+ * Base class for any part of the rules where only one player has to do something.
+ */
 export declare abstract class PlayerTurnRule<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends MaterialRulesPart<Player, MaterialType, LocationType> {
+    /**
+     * Shortcut to get the awaited player (this.game.rule.player)
+     */
     get player(): Player;
+    /**
+     * Utility function to get the id of the next player in the table order
+     */
     get nextPlayer(): Player;
+    /**
+     * See {@link Rules.getActivePlayer}
+     */
     getActivePlayer(): Player;
+    /**
+     * See {@link Rules.getLegalMoves}
+     */
     getLegalMoves(player: Player): MaterialMove<Player, MaterialType, LocationType>[];
+    /**
+     * Implement this to expose all the legal moves of the active player.
+     * @returns All the {@link MaterialMove} that current active player can play
+     */
     getPlayerMoves(): MaterialMove<Player, MaterialType, LocationType>[];
 }

package/dist/material/rules/PlayerTurnRule.js

@@ -17,12 +17,18 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlayerTurnRule = void 0;
 var MaterialRulesPart_1 = require("./MaterialRulesPart");
-var PlayerTurnRule = (function (_super) {
+/**
+ * Base class for any part of the rules where only one player has to do something.
+ */
+var PlayerTurnRule = /** @class */ (function (_super) {
     __extends(PlayerTurnRule, _super);
     function PlayerTurnRule() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     Object.defineProperty(PlayerTurnRule.prototype, "player", {
+        /**
+         * Shortcut to get the awaited player (this.game.rule.player)
+         */
         get: function () {
             return this.game.rule.player;
         },
@@ -30,20 +36,33 @@ var PlayerTurnRule = (function (_super) {
         configurable: true
     });
     Object.defineProperty(PlayerTurnRule.prototype, "nextPlayer", {
+        /**
+         * Utility function to get the id of the next player in the table order
+         */
         get: function () {
             return this.game.players[(this.game.players.indexOf(this.player) + 1) % this.game.players.length];
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * See {@link Rules.getActivePlayer}
+     */
     PlayerTurnRule.prototype.getActivePlayer = function () {
         return this.player;
     };
+    /**
+     * See {@link Rules.getLegalMoves}
+     */
     PlayerTurnRule.prototype.getLegalMoves = function (player) {
         if (player !== this.getActivePlayer())
             return [];
         return this.getPlayerMoves();
     };
+    /**
+     * Implement this to expose all the legal moves of the active player.
+     * @returns All the {@link MaterialMove} that current active player can play
+     */
     PlayerTurnRule.prototype.getPlayerMoves = function () {
         return [];
     };