@gamepark/rules-api 6.24.2 → 6.24.3

package/dist/material/moves/MaterialMoveBuilder.d.ts

@@ -1,16 +1,52 @@
 import { MaterialItem } from '../items';
 import { Location } from '../location';
 import { CustomMove, DisplayHelp, DropItem, EndGame, EndPlayerTurn, HelpDisplay, StartPlayerTurn, StartRule, StartSimultaneousRule } from './index';
+/**
+ * Common namespaces for all the helper function that creates the different types of {@link MaterialMove} objects.
+ */
 export declare namespace MaterialMoveBuilder {
+    /**
+     * Creates a {@link StartPlayerTurn} object
+     */
     const startPlayerTurn: <P extends number = number, R extends number = number>(id: R, player: P) => StartPlayerTurn<P, R>;
+    /**
+     * Creates a {@link StartSimultaneousRule} object
+     */
     const startSimultaneousRule: <P extends number = number, R extends number = number>(id: R, players?: P[]) => StartSimultaneousRule<P, R>;
+    /**
+     * Creates a {@link EndPlayerTurn} object
+     */
     const endPlayerTurn: <P extends number = number>(player: P) => EndPlayerTurn<P>;
+    /**
+     * Creates a {@link StartRule} object
+     */
     const startRule: <R extends number = number>(id: R) => StartRule<R>;
+    /**
+     * Creates a {@link CustomMove} object
+     */
     const customMove: <Type extends number = number>(type: Type, data?: any) => CustomMove;
+    /**
+     * Creates a {@link EndGame} object
+     */
     const endGame: () => EndGame;
+    /**
+     * Creates a {@link DisplayHelp} object
+     */
     const displayHelp: <P extends number = number, M extends number = number, L extends number = number>(helpDisplay: HelpDisplay<P, M, L>) => DisplayHelp<P, M, L>;
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link MaterialHelpDisplay}
+     */
     const displayMaterialHelp: <P extends number = number, M extends number = number, L extends number = number>(itemType: M, item?: Partial<MaterialItem<P, L>>, itemIndex?: number, displayIndex?: number) => DisplayHelp<P, M, L>;
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link LocationHelpDisplay}
+     */
     const displayLocationHelp: <P extends number = number, M extends number = number, L extends number = number>(location: Location<P, L>) => DisplayHelp<P, M, L>;
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link RulesHelpDisplay}
+     */
     const displayRulesHelp: <P extends number = number, M extends number = number, L extends number = number, RuleId extends number = number>(ruleId: RuleId) => DisplayHelp<P, M, L>;
+    /**
+     * Creates a {@link DropItem} object
+     */
     function dropItemMove<M extends number = number>(type: M, index: number, displayIndex: number): DropItem<M>;
 }

package/dist/material/moves/MaterialMoveBuilder.js

@@ -2,41 +2,77 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaterialMoveBuilder = void 0;
 var index_1 = require("./index");
+/**
+ * Common namespaces for all the helper function that creates the different types of {@link MaterialMove} objects.
+ */
 var MaterialMoveBuilder;
 (function (MaterialMoveBuilder) {
+    /**
+     * Creates a {@link StartPlayerTurn} object
+     */
     MaterialMoveBuilder.startPlayerTurn = function (id, player) {
         return ({ kind: index_1.MoveKind.RulesMove, type: index_1.RuleMoveType.StartPlayerTurn, id: id, player: player });
     };
+    /**
+     * Creates a {@link StartSimultaneousRule} object
+     */
     MaterialMoveBuilder.startSimultaneousRule = function (id, players) {
         var move = { kind: index_1.MoveKind.RulesMove, type: index_1.RuleMoveType.StartSimultaneousRule, id: id };
         if (players)
             move.players = players;
         return move;
     };
+    /**
+     * Creates a {@link EndPlayerTurn} object
+     */
     MaterialMoveBuilder.endPlayerTurn = function (player) {
         return ({ kind: index_1.MoveKind.RulesMove, type: index_1.RuleMoveType.EndPlayerTurn, player: player });
     };
+    /**
+     * Creates a {@link StartRule} object
+     */
     MaterialMoveBuilder.startRule = function (id) { return ({ kind: index_1.MoveKind.RulesMove, type: index_1.RuleMoveType.StartRule, id: id }); };
+    /**
+     * Creates a {@link CustomMove} object
+     */
     MaterialMoveBuilder.customMove = function (type, data) {
         var move = { kind: index_1.MoveKind.CustomMove, type: type };
         if (data !== undefined)
             move.data = data;
         return move;
     };
+    /**
+     * Creates a {@link EndGame} object
+     */
     MaterialMoveBuilder.endGame = function () { return ({ kind: index_1.MoveKind.RulesMove, type: index_1.RuleMoveType.EndGame }); };
+    /**
+     * Creates a {@link DisplayHelp} object
+     */
     MaterialMoveBuilder.displayHelp = function (helpDisplay) {
         return ({ kind: index_1.MoveKind.LocalMove, type: index_1.LocalMoveType.DisplayHelp, helpDisplay: helpDisplay });
     };
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link MaterialHelpDisplay}
+     */
     MaterialMoveBuilder.displayMaterialHelp = function (itemType, item, itemIndex, displayIndex) {
         if (item === void 0) { item = {}; }
         return MaterialMoveBuilder.displayHelp({ type: index_1.HelpDisplayType.Material, itemType: itemType, itemIndex: itemIndex, displayIndex: displayIndex, item: item });
     };
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link LocationHelpDisplay}
+     */
     MaterialMoveBuilder.displayLocationHelp = function (location) {
         return MaterialMoveBuilder.displayHelp({ type: index_1.HelpDisplayType.Location, location: location });
     };
+    /**
+     * Creates a {@link DisplayHelp} object holding a {@link RulesHelpDisplay}
+     */
     MaterialMoveBuilder.displayRulesHelp = function (ruleId) {
         return MaterialMoveBuilder.displayHelp({ type: index_1.HelpDisplayType.Rules, ruleId: ruleId });
     };
+    /**
+     * Creates a {@link DropItem} object
+     */
     function dropItemMove(type, index, displayIndex) {
         return { kind: index_1.MoveKind.LocalMove, type: index_1.LocalMoveType.DropItem, item: { type: type, index: index, displayIndex: displayIndex } };
     }

package/dist/material/moves/MaterialMoveBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialMoveBuilder.js","sourceRoot":"","sources":["../../../src/material/moves/MaterialMoveBuilder.ts"],"names":[],"mappings":";;;AAEA,iCAWgB;AAKhB,IAAiB,mBAAmB,CA4EnC;AA5ED,WAAiB,mBAAmB;IAKrB,mCAAe,GAAG,UAAuD,EAAK,EAAE,MAAS;QACpG,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,eAAe,EAAE,EAAE,IAAA,EAAE,MAAM,QAAA,EAAE,CAAC;IAA9E,CAA8E,CAAA;IAKnE,yCAAqB,GAAG,UAAuD,EAAK,EAAE,OAAa;QAC9G,IAAM,IAAI,GAAgC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,qBAAqB,EAAE,EAAE,IAAA,EAAE,CAAA;QACpH,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACnC,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAKY,iCAAa,GAAG,UAA4B,MAAS;QAChE,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,aAAa,EAAE,MAAM,QAAA,EAAE,CAAC;IAAxE,CAAwE,CAAA;IAK7D,6BAAS,GAAG,UAA4B,EAAK,IAAmB,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,SAAS,EAAE,EAAE,IAAA,EAAE,CAAC,EAAhE,CAAgE,CAAA;IAKhI,8BAAU,GAAG,UAA+B,IAAU,EAAE,IAAU;QAC7E,IAAM,IAAI,GAAe,EAAE,IAAI,EAAE,gBAAQ,CAAC,UAAU,EAAE,IAAI,MAAA,EAAE,CAAA;QAC5D,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAKY,2BAAO,GAAG,cAAe,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,OAAO,EAAE,CAAC,EAA1D,CAA0D,CAAA;IAKnF,+BAAW,GAAG,UAC1B,WAAiC;QAChC,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,qBAAa,CAAC,WAAW,EAAE,WAAW,aAAA,EAAE,CAAC;IAA5E,CAA4E,CAAA;IAKjE,uCAAmB,GAAG,UAClC,QAAW,EAAE,IAAsC,EAAE,SAAkB,EAAE,YAAqB;QAAjF,qBAAA,EAAA,SAAsC;QAClD,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,QAAQ,EAAE,QAAQ,UAAA,EAAE,SAAS,WAAA,EAAE,YAAY,cAAA,EAAE,IAAI,MAAA,EAAE,CAAC;IAAxF,CAAwF,CAAA;IAK7E,uCAAmB,GAAG,UAClC,QAAwB;QACvB,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,QAAQ,EAAE,QAAQ,UAAA,EAAE,CAAC;IAAzD,CAAyD,CAAA;IAK9C,oCAAgB,GAAG,UAC/B,MAAc;QACb,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,KAAK,EAAE,MAAM,QAAA,EAAE,CAAC;IAApD,CAAoD,CAAA;IAKtD,SAAgB,YAAY,CAA4B,IAAO,EAAE,KAAa,EAAE,YAAoB;QAClG,OAAO,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,qBAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,IAAI,MAAA,EAAE,KAAK,OAAA,EAAE,YAAY,cAAA,EAAE,EAAE,CAAA;IACxG,CAAC;IAFe,gCAAY,eAE3B,CAAA;AACH,CAAC,EA5EgB,mBAAmB,mCAAnB,mBAAmB,QA4EnC"}
+{"version":3,"file":"MaterialMoveBuilder.js","sourceRoot":"","sources":["../../../src/material/moves/MaterialMoveBuilder.ts"],"names":[],"mappings":";;;AAEA,iCAWgB;AAEhB;;GAEG;AACH,IAAiB,mBAAmB,CA4EnC;AA5ED,WAAiB,mBAAmB;IAElC;;OAEG;IACU,mCAAe,GAAG,UAAuD,EAAK,EAAE,MAAS;QACpG,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,eAAe,EAAE,EAAE,IAAA,EAAE,MAAM,QAAA,EAAE,CAAC;IAA9E,CAA8E,CAAA;IAEhF;;OAEG;IACU,yCAAqB,GAAG,UAAuD,EAAK,EAAE,OAAa;QAC9G,IAAM,IAAI,GAAgC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,qBAAqB,EAAE,EAAE,IAAA,EAAE,CAAA;QACpH,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACnC,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED;;OAEG;IACU,iCAAa,GAAG,UAA4B,MAAS;QAChE,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,aAAa,EAAE,MAAM,QAAA,EAAE,CAAC;IAAxE,CAAwE,CAAA;IAE1E;;OAEG;IACU,6BAAS,GAAG,UAA4B,EAAK,IAAmB,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,SAAS,EAAE,EAAE,IAAA,EAAE,CAAC,EAAhE,CAAgE,CAAA;IAE7I;;OAEG;IACU,8BAAU,GAAG,UAA+B,IAAU,EAAE,IAAU;QAC7E,IAAM,IAAI,GAAe,EAAE,IAAI,EAAE,gBAAQ,CAAC,UAAU,EAAE,IAAI,MAAA,EAAE,CAAA;QAC5D,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED;;OAEG;IACU,2BAAO,GAAG,cAAe,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAY,CAAC,OAAO,EAAE,CAAC,EAA1D,CAA0D,CAAA;IAEhG;;OAEG;IACU,+BAAW,GAAG,UAC1B,WAAiC;QAChC,OAAA,CAAC,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,qBAAa,CAAC,WAAW,EAAE,WAAW,aAAA,EAAE,CAAC;IAA5E,CAA4E,CAAA;IAE9E;;OAEG;IACU,uCAAmB,GAAG,UAClC,QAAW,EAAE,IAAsC,EAAE,SAAkB,EAAE,YAAqB;QAAjF,qBAAA,EAAA,SAAsC;QAClD,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,QAAQ,EAAE,QAAQ,UAAA,EAAE,SAAS,WAAA,EAAE,YAAY,cAAA,EAAE,IAAI,MAAA,EAAE,CAAC;IAAxF,CAAwF,CAAA;IAE1F;;OAEG;IACU,uCAAmB,GAAG,UAClC,QAAwB;QACvB,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,QAAQ,EAAE,QAAQ,UAAA,EAAE,CAAC;IAAzD,CAAyD,CAAA;IAE3D;;OAEG;IACU,oCAAgB,GAAG,UAC/B,MAAc;QACb,OAAA,oBAAA,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAe,CAAC,KAAK,EAAE,MAAM,QAAA,EAAE,CAAC;IAApD,CAAoD,CAAA;IAEtD;;OAEG;IACH,SAAgB,YAAY,CAA4B,IAAO,EAAE,KAAa,EAAE,YAAoB;QAClG,OAAO,EAAE,IAAI,EAAE,gBAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,qBAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,IAAI,MAAA,EAAE,KAAK,OAAA,EAAE,YAAY,cAAA,EAAE,EAAE,CAAA;IACxG,CAAC;IAFe,gCAAY,eAE3B,CAAA;AACH,CAAC,EA5EgB,mBAAmB,mCAAnB,mBAAmB,QA4EnC"}

package/dist/material/moves/MoveKind.d.ts

@@ -1,3 +1,6 @@
+/**
+ * The different kind of moves that exists in a game implemented with {@link MaterialRules}.
+ */
 export declare enum MoveKind {
     ItemMove = 1,
     RulesMove = 2,

package/dist/material/moves/MoveKind.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MoveKind = void 0;
+/**
+ * The different kind of moves that exists in a game implemented with {@link MaterialRules}.
+ */
 var MoveKind;
 (function (MoveKind) {
     MoveKind[MoveKind["ItemMove"] = 1] = "ItemMove";

package/dist/material/moves/MoveKind.js.map

@@ -1 +1 @@
-{"version":3,"file":"MoveKind.js","sourceRoot":"","sources":["../../../src/material/moves/MoveKind.ts"],"names":[],"mappings":";;;AAGA,IAAY,QAEX;AAFD,WAAY,QAAQ;IAClB,+CAAY,CAAA;IAAE,iDAAa,CAAA;IAAE,mDAAc,CAAA;IAAE,iDAAa,CAAA;AAC5D,CAAC,EAFW,QAAQ,wBAAR,QAAQ,QAEnB"}
+{"version":3,"file":"MoveKind.js","sourceRoot":"","sources":["../../../src/material/moves/MoveKind.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,QAEX;AAFD,WAAY,QAAQ;IAClB,+CAAY,CAAA;IAAE,iDAAa,CAAA;IAAE,mDAAc,CAAA;IAAE,iDAAa,CAAA;AAC5D,CAAC,EAFW,QAAQ,wBAAR,QAAQ,QAEnB"}

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

@@ -2,9 +2,22 @@ import { MaterialItem } from '../../items';
 import { ItemMoveType } from './ItemMoveType';
 import { MaterialMoveCommon } from './ItemMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object that will create one {@link MaterialItem} when played
+ */
 export type CreateItem<P extends number = number, M extends number = number, L extends number = number> = MaterialMoveCommon<M> & {
     type: typeof ItemMoveType.Create;
     item: MaterialItem<P, L>;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link CreateItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link CreateItem}
+ */
 export declare function isCreateItem<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is CreateItem<P, M, L>;
+/**
+ * Function to get a type guard for a {@link CreateItem} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isCreateItem} but that also verify the item type.
+ */
 export declare function isCreateItemType<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is CreateItem<P, M, L>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"CreateItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/CreateItem.ts"],"names":[],"mappings":";;;AACA,+CAA6C;AAG7C,wCAAsC;AAetC,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;AAOD,SAAgB,gBAAgB,CAC9B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAA5C,CAA4C,CAAA;AAChD,CAAC;AALD,4CAKC"}
+{"version":3,"file":"CreateItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/CreateItem.ts"],"names":[],"mappings":";;;AACA,+CAA6C;AAG7C,wCAAsC;AAUtC;;;;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;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAA5C,CAA4C,CAAA;AAChD,CAAC;AALD,4CAKC"}

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

@@ -2,9 +2,23 @@ import { MaterialItem } from '../../items';
 import { ItemMoveType } from './ItemMoveType';
 import { MaterialMoveCommon } from './ItemMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object that will create multiple {@link MaterialItem} when played.
+ * Use it when you create a lot of items at once and do not need to animate them, to reduce the data payload.
+ */
 export type CreateItemsAtOnce<P extends number = number, M extends number = number, L extends number = number> = MaterialMoveCommon<M> & {
     type: typeof ItemMoveType.CreateAtOnce;
     items: MaterialItem<P, L>[];
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link CreateItemsAtOnce} move
+ * @param move Move to test
+ * @returns true if move is a {@link CreateItemsAtOnce}
+ */
 export declare function isCreateItemsAtOnce<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is CreateItemsAtOnce<P, M, L>;
+/**
+ * Function to get a type guard for a {@link CreateItemsAtOnce} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isCreateItemsAtOnce} but that also verify the item type.
+ */
 export declare function isCreateItemTypeAtOnce<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is CreateItemsAtOnce<P, M, L>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"CreateItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/CreateItemsAtOnce.ts"],"names":[],"mappings":";;;AACA,+CAA6C;AAG7C,wCAAsC;AAgBtC,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,YAAY,CAAA;AACnF,CAAC;AAFD,kDAEC;AAOD,SAAgB,sBAAsB,CACpC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAnD,CAAmD,CAAA;AACvD,CAAC;AALD,wDAKC"}
+{"version":3,"file":"CreateItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/CreateItemsAtOnce.ts"],"names":[],"mappings":";;;AACA,+CAA6C;AAG7C,wCAAsC;AAWtC;;;;GAIG;AACH,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,YAAY,CAAA;AACnF,CAAC;AAFD,kDAEC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAnD,CAAmD,CAAA;AACvD,CAAC;AALD,wDAKC"}

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

@@ -1,10 +1,28 @@
 import { ItemMoveType } from './ItemMoveType';
 import { MaterialMoveCommon } from './ItemMove';
 import { MaterialMove } from '../MaterialMove';
+/**
+ * Move object that will delete one {@link MaterialItem}, or a part of its quantity, when played
+ * Use {@link Material} utility to build the move easily
+ *
+ * @property itemIndex index of the item to delete
+ * @property quantity if provided, removes the specified quantity from the item. Otherwise, remove all the item.
+ */
 export type DeleteItem<MaterialType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.Delete;
     itemIndex: number;
     quantity?: number;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link DeleteItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link DeleteItem}
+ */
 export declare function isDeleteItem<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is DeleteItem<M>;
+/**
+ * Function to get a type guard for a {@link DeleteItem} 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 isDeleteItem} but that also verify the item type.
+ */
 export declare function isDeleteItemType<P extends number, M extends number, L extends number>(type: M, index?: number): (move: MaterialMove<P, M, L>) => move is DeleteItem<M>;

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

@@ -3,10 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isDeleteItemType = exports.isDeleteItem = void 0;
 var ItemMoveType_1 = require("./ItemMoveType");
 var MoveKind_1 = require("../MoveKind");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link DeleteItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link DeleteItem}
+ */
 function isDeleteItem(move) {
     return move.kind === MoveKind_1.MoveKind.ItemMove && move.type === ItemMoveType_1.ItemMoveType.Delete;
 }
 exports.isDeleteItem = isDeleteItem;
+/**
+ * Function to get a type guard for a {@link DeleteItem} 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 isDeleteItem} but that also verify the item type.
+ */
 function isDeleteItemType(type, index) {
     return function (move) {
         return isDeleteItem(move) && move.itemType === type && (index === undefined || move.itemIndex === index);

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

@@ -1 +1 @@
-{"version":3,"file":"DeleteItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/DeleteItem.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAG7C,wCAAsC;AAoBtC,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":"DeleteItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/DeleteItem.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAG7C,wCAAsC;AAetC;;;;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/DeleteItemsAtOnce.d.ts

@@ -1,9 +1,26 @@
 import { MaterialMove } from '../MaterialMove';
 import { MaterialMoveCommon } from './ItemMove';
 import { ItemMoveType } from './ItemMoveType';
+/**
+ * Move object that will delete multiple {@link MaterialItem} when played.
+ * Use {@link Material} utility to build the move easily.
+ * Use this when you need to delete a lot of items without animating it one by one, to reduce the data payload.
+ *
+ * @property indexes indexes of the items to delete
+ */
 export type DeleteItemsAtOnce<MaterialType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.DeleteAtOnce;
     indexes: number[];
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link DeleteItemsAtOnce} move
+ * @param move Move to test
+ * @returns true if move is a {@link DeleteItemsAtOnce}
+ */
 export declare function isDeleteItemsAtOnce<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is DeleteItemsAtOnce<M>;
+/**
+ * Function to get a type guard for a {@link DeleteItemsAtOnce} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isDeleteItemsAtOnce} but that also verify the item type.
+ */
 export declare function isDeleteItemTypeAtOnce<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is DeleteItemsAtOnce<M>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"DeleteItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/DeleteItemsAtOnce.ts"],"names":[],"mappings":";;;AACA,wCAAsC;AAEtC,+CAA6C;AAmB7C,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,YAAY,CAAA;AACnF,CAAC;AAFD,kDAEC;AAOD,SAAgB,sBAAsB,CACpC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAnD,CAAmD,CAAA;AACvD,CAAC;AALD,wDAKC"}
+{"version":3,"file":"DeleteItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/DeleteItemsAtOnce.ts"],"names":[],"mappings":";;;AACA,wCAAsC;AAEtC,+CAA6C;AAc7C;;;;GAIG;AACH,SAAgB,mBAAmB,CAAuD,IAA2B;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,YAAY,CAAA;AACnF,CAAC;AAFD,kDAEC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAnD,CAAmD,CAAA;AACvD,CAAC;AALD,wDAKC"}

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

@@ -8,10 +8,22 @@ import { MoveItem } from './MoveItem';
 import { RollItem } from './RollItem';
 import { SelectItem } from './SelectItem';
 import { Shuffle, ShuffleRandomized } from './Shuffle';
+/**
+ * Common type for all the moves that have an impact on the game material items
+ */
 export type ItemMove<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> = CreateItem<Player, MaterialType, LocationType> | CreateItemsAtOnce<Player, MaterialType, LocationType> | DeleteItem<MaterialType> | DeleteItemsAtOnce<MaterialType> | MoveItem<Player, MaterialType, LocationType> | MoveItemsAtOnce<Player, MaterialType, LocationType> | Shuffle<MaterialType> | RollItem<Player, MaterialType, LocationType> | SelectItem<MaterialType>;
+/**
+ * Common properties for all the types of {@link ItemMove}
+ */
 export type MaterialMoveCommon<MaterialType extends number = number> = {
     kind: typeof MoveKind.ItemMove;
     itemType: MaterialType;
 };
+/**
+ * An {@link ItemMove} but after if has been randomized (see {@link RandomMove})
+ */
 export type ItemMoveRandomized<P extends number = number, M extends number = number, L extends number = number> = Exclude<ItemMove<P, M, L>, Shuffle<M>> | ShuffleRandomized<M>;
+/**
+ * An {@link ItemMove} but after if has been transformed into what a player or a spectator can view (see {@link HiddenInformation})
+ */
 export type ItemMoveView<P extends number = number, M extends number = number, L extends number = number> = Exclude<ItemMoveRandomized<P, M, L>, ShuffleRandomized<M>> | Shuffle<M>;

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

@@ -1,3 +1,6 @@
+/**
+ * The different types of {@link ItemMove}
+ */
 export declare enum ItemMoveType {
     Create = 0,
     Move = 1,

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

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ItemMoveType = void 0;
+/**
+ * The different types of {@link ItemMove}
+ */
 var ItemMoveType;
 (function (ItemMoveType) {
     ItemMoveType[ItemMoveType["Create"] = 0] = "Create";

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

@@ -1 +1 @@
-{"version":3,"file":"ItemMoveType.js","sourceRoot":"","sources":["../../../../src/material/moves/items/ItemMoveType.ts"],"names":[],"mappings":";;;AAGA,IAAY,YAEX;AAFD,WAAY,YAAY;IACtB,mDAAM,CAAA;IAAE,+CAAI,CAAA;IAAE,qDAAO,CAAA;IAAE,mDAAM,CAAA;IAAE,+CAAI,CAAA;IAAE,mDAAM,CAAA;IAAE,2DAAU,CAAA;IAAE,+DAAY,CAAA;IAAE,+DAAY,CAAA;AACrF,CAAC,EAFW,YAAY,4BAAZ,YAAY,QAEvB"}
+{"version":3,"file":"ItemMoveType.js","sourceRoot":"","sources":["../../../../src/material/moves/items/ItemMoveType.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,YAEX;AAFD,WAAY,YAAY;IACtB,mDAAM,CAAA;IAAE,+CAAI,CAAA;IAAE,qDAAO,CAAA;IAAE,mDAAM,CAAA;IAAE,+CAAI,CAAA;IAAE,mDAAM,CAAA;IAAE,2DAAU,CAAA;IAAE,+DAAY,CAAA;IAAE,+DAAY,CAAA;AACrF,CAAC,EAFW,YAAY,4BAAZ,YAAY,QAEvB"}

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

@@ -3,6 +3,15 @@ import { Location } from '../../location';
 import { MaterialMove } from '../MaterialMove';
 import { MaterialMoveCommon } from './ItemMove';
 import { ItemMoveType } from './ItemMoveType';
+/**
+ * Move object that will move one existing {@link MaterialItem} (or a part of its quantity) to a new location, when played
+ * Use {@link Material} utility to build the move easily
+ *
+ * @property itemIndex index of the item to move
+ * @property location the new location
+ * @property quantity if provided, move the specified quantity from the item (split in two items). Otherwise, move all the item.
+ * @property reveal this property automatically set inside {@link HiddenMaterialRules} to provides any extra information about the item revealed by the move
+ */
 export type MoveItem<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.Move;
     itemIndex: number;
@@ -10,5 +19,16 @@ export type MoveItem<Player extends number = number, MaterialType extends number
     quantity?: number;
     reveal?: Omit<MaterialItem<Player, LocationType>, 'location'>;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link MoveItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link MoveItem}
+ */
 export declare function isMoveItem<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is MoveItem<P, M, L>;
+/**
+ * Function to get a type guard for a {@link MoveItem} 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 isMoveItem} but that also verify the item type.
+ */
 export declare function isMoveItemType<P extends number, M extends number, L extends number>(type: M, index?: number): (move: MaterialMove<P, M, L>) => move is MoveItem<P, M, L>;

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

@@ -3,10 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isMoveItemType = exports.isMoveItem = void 0;
 var MoveKind_1 = require("../MoveKind");
 var ItemMoveType_1 = require("./ItemMoveType");
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link MoveItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link MoveItem}
+ */
 function isMoveItem(move) {
     return move.kind === MoveKind_1.MoveKind.ItemMove && move.type === ItemMoveType_1.ItemMoveType.Move;
 }
 exports.isMoveItem = isMoveItem;
+/**
+ * Function to get a type guard for a {@link MoveItem} 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 isMoveItem} but that also verify the item type.
+ */
 function isMoveItemType(type, index) {
     return function (move) {
         return isMoveItem(move) && move.itemType === type && (index === undefined || move.itemIndex === index);

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

@@ -1 +1 @@
-{"version":3,"file":"MoveItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/MoveItem.ts"],"names":[],"mappings":";;;AAGA,wCAAsC;AAEtC,+CAA6C;AAyB7C,SAAgB,UAAU,CAAuD,IAA2B;IAC1G,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,IAAI,CAAA;AAC3E,CAAC;AAFD,gCAEC;AAQD,SAAgB,cAAc,CAC5B,IAAO,EAAE,KAAc;IAEvB,OAAO,UAAC,IAA2B;QACjC,OAAA,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;IAA/F,CAA+F,CAAA;AACnG,CAAC;AALD,wCAKC"}
+{"version":3,"file":"MoveItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/MoveItem.ts"],"names":[],"mappings":";;;AAGA,wCAAsC;AAEtC,+CAA6C;AAoB7C;;;;GAIG;AACH,SAAgB,UAAU,CAAuD,IAA2B;IAC1G,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,IAAI,CAAA;AAC3E,CAAC;AAFD,gCAEC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,IAAO,EAAE,KAAc;IAEvB,OAAO,UAAC,IAA2B;QACjC,OAAA,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;IAA/F,CAA+F,CAAA;AACnG,CAAC;AALD,wCAKC"}

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

@@ -3,11 +3,31 @@ import { Location } from '../../location';
 import { MaterialMove } from '../MaterialMove';
 import { MaterialMoveCommon } from './ItemMove';
 import { ItemMoveType } from './ItemMoveType';
+/**
+ * Move object that will move multiple {@link MaterialItem} to the same new location when played.
+ * Any {@link LocationStrategy} will be applied to each item individually.
+ * Use {@link Material} utility to build the move easily.
+ * Use this when you need to move around a lot of items at once without animating it one by one, to reduce the data payload.
+ *
+ * @property indexes indexes of the items to delete
+ * @property location the new location for the items
+ * @property reveal this property automatically set inside {@link HiddenMaterialRules} to provides any extra information about the items revealed by the move
+ */
 export type MoveItemsAtOnce<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> = MaterialMoveCommon<MaterialType> & {
     type: typeof ItemMoveType.MoveAtOnce;
     indexes: number[];
     location: Partial<Location<Player, LocationType>>;
     reveal?: Record<number, Omit<MaterialItem<Player, LocationType>, 'location'>>;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link MoveItemsAtOnce} move
+ * @param move Move to test
+ * @returns true if move is a {@link MoveItemsAtOnce}
+ */
 export declare function isMoveItemsAtOnce<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is MoveItemsAtOnce<P, M, L>;
+/**
+ * Function to get a type guard for a {@link MoveItemsAtOnce} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isMoveItemsAtOnce} but that also verify the item type.
+ */
 export declare function isMoveItemTypeAtOnce<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is MoveItemsAtOnce<P, M, L>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"MoveItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/MoveItemsAtOnce.ts"],"names":[],"mappings":";;;AAGA,wCAAsC;AAEtC,+CAA6C;AAyB7C,SAAgB,iBAAiB,CAAuD,IAA2B;IACjH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,UAAU,CAAA;AACjF,CAAC;AAFD,8CAEC;AAOD,SAAgB,oBAAoB,CAClC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAjD,CAAiD,CAAA;AACrD,CAAC;AALD,oDAKC"}
+{"version":3,"file":"MoveItemsAtOnce.js","sourceRoot":"","sources":["../../../../src/material/moves/items/MoveItemsAtOnce.ts"],"names":[],"mappings":";;;AAGA,wCAAsC;AAEtC,+CAA6C;AAoB7C;;;;GAIG;AACH,SAAgB,iBAAiB,CAAuD,IAA2B;IACjH,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,UAAU,CAAA;AACjF,CAAC;AAFD,8CAEC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAjD,CAAiD,CAAA;AACrD,CAAC;AALD,oDAKC"}

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

@@ -2,10 +2,29 @@ import { Location } from '../../location';
 import { MaterialMove } from '../MaterialMove';
 import { MaterialMoveCommon } from './ItemMove';
 import { ItemMoveType } from './ItemMoveType';
+/**
+ * Move object that will "roll" one existing {@link MaterialItem} to a new location, when played.
+ * Use {@link Material} utility to build the move easily.
+ * Use this to roll dices or flip coins, for instance.
+ * Override "roll" function in {@link MaterialRules} to provide a custom and random "location.rotation" value when the server randomizes the move
+ *
+ * @property itemIndex index of the item to roll
+ * @property location the new location (without the rotation when the move is built, then with the randomized location after {@link RandomMove} is applied
+ */
 export type RollItem<P extends number = number, M extends number = number, L extends number = number> = MaterialMoveCommon<M> & {
     type: typeof ItemMoveType.Roll;
     itemIndex: number;
     location: Location<P, L>;
 };
+/**
+ * Type guard to test if a {@link MaterialMove} is a {@link RollItem} move
+ * @param move Move to test
+ * @returns true if move is a {@link RollItem}
+ */
 export declare function isRoll<P extends number, M extends number, L extends number>(move: MaterialMove<P, M, L>): move is RollItem<P, M, L>;
+/**
+ * Function to get a type guard for a {@link RollItem} move for specific item types.
+ * @param type Item type to test
+ * @returns a type guard similar as {@link isRoll} but that also verify the item type.
+ */
 export declare function isRollItemType<P extends number, M extends number, L extends number>(type: M): (move: MaterialMove<P, M, L>) => move is RollItem<P, M, L>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"RollItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/RollItem.ts"],"names":[],"mappings":";;;AAEA,wCAAsC;AAEtC,+CAA6C;AAsB7C,SAAgB,MAAM,CAAuD,IAA2B;IACtG,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,IAAI,CAAA;AAC3E,CAAC;AAFD,wBAEC;AAOD,SAAgB,cAAc,CAC5B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAtC,CAAsC,CAAA;AAC1C,CAAC;AALD,wCAKC"}
+{"version":3,"file":"RollItem.js","sourceRoot":"","sources":["../../../../src/material/moves/items/RollItem.ts"],"names":[],"mappings":";;;AAEA,wCAAsC;AAEtC,+CAA6C;AAiB7C;;;;GAIG;AACH,SAAgB,MAAM,CAAuD,IAA2B;IACtG,OAAO,IAAI,CAAC,IAAI,KAAK,mBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,2BAAY,CAAC,IAAI,CAAA;AAC3E,CAAC;AAFD,wBAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAC5B,IAAO;IAEP,OAAO,UAAC,IAA2B;QACjC,OAAA,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;IAAtC,CAAsC,CAAA;AAC1C,CAAC;AALD,wCAKC"}