@gamepark/react-game 6.24.2 → 6.24.3

package/dist/locators/HandLocator.d.ts

@@ -1,24 +1,96 @@
 import { Coordinates, Location, MaterialItem } from '@gamepark/rules-api';
 import { LocationDescription } from '../components';
 import { ItemContext, Locator, MaterialContext } from './Locator';
+/**
+ * This Locator places items fan-shaped to mimic the ways we hold cards in our hands.
+ */
 export declare class HandLocator<P extends number = number, M extends number = number, L extends number = number> extends Locator<P, M, L> {
     constructor(clone?: Partial<HandLocator>);
+    /**
+     * Items are place around the circle of an arc. This is the radius of the arc. Override {@link getRadius} to provide a dynamic radius.
+     */
     radius: number;
+    /**
+     * Provide the radius of the circle. Defaults to {@link radius} property.
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the radius of the circle in cm
+     */
     getRadius(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * The default angle of the hand items. For instance, 180 will display the hand oriented towards the bottom of the screen.
+     */
     baseAngle: number;
+    /**
+     * Function to override to provide a {@link baseAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the default angle of the items
+     */
     getBaseAngle(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * The maximum angle that is allowed between the first and the last items displayed.
+     */
     maxAngle: number;
+    /**
+     * Function to override to provide a {@link maxAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the maximum angle between the first and the last items
+     */
     getMaxAngle(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * The maximum angle between two consecutive items in the hand
+     */
     gapMaxAngle: number;
+    /**
+     * Function to override to provide a {@link gapMaxAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The maximum angle between two consecutive items in the hand
+     */
     getGapMaxAngle(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * The direction of the items displayed, for the first to the last index. Default is true.
+     */
     clockwise: boolean;
+    /**
+     * Function to override to provide a {@link clockwise} info that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns true if items should be displayed clockwise around the arc of circle. Default is true.
+     */
     isClockwise(_location: Location<P, L>, _context: MaterialContext<P, M, L>): boolean;
+    /**
+     * The Z-axis position difference between 2 consecutive items in the hand. Default is 0.05cm.
+     */
     deltaZ: number;
+    /**
+     * Function to override to provide a {@link deltaZ} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The Z-axis position difference between 2 consecutive items in the hand. Default is 0.05cm.
+     */
     getDeltaZ(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * See {@link Locator.getLocationCoordinates}.
+     * @param location Location to position
+     * @param context Context of the game
+     * @param index Index of the item (or location) to place
+     */
     getLocationCoordinates(location: Location<P, L>, context: MaterialContext<P, M, L>, index?: number | undefined): Coordinates;
     getItemCoordinates(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): Coordinates;
+    /**
+     * See {@link Locator.getRotateZ}.
+     * @param location Location to position
+     * @param context Context of the game
+     * @param index Index of the item (or location) to place
+     */
     getRotateZ(location: Location<P, L>, context: MaterialContext<P, M, L>, index?: number | undefined): number;
     getItemRotateZ(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): number;
     protected generateLocationDescriptionFromDraggedItem(_location: Location<P, L>, context: ItemContext<P, M, L>): LocationDescription<P, M, L>;
+    /**
+     * See {@link Locator.getHoverTransform}. By default, display the item on top of others, straight, and twice as big.
+     */
     getHoverTransform(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): string[];
 }

package/dist/locators/HandLocator.js

@@ -18,37 +18,100 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HandLocator = void 0;
 var components_1 = require("../components");
 var Locator_1 = require("./Locator");
-var HandLocator = (function (_super) {
+/**
+ * This Locator places items fan-shaped to mimic the ways we hold cards in our hands.
+ */
+var HandLocator = /** @class */ (function (_super) {
     __extends(HandLocator, _super);
     function HandLocator(clone) {
         var _this = _super.call(this) || this;
+        /**
+         * Items are place around the circle of an arc. This is the radius of the arc. Override {@link getRadius} to provide a dynamic radius.
+         */
         _this.radius = 100;
+        /**
+         * The default angle of the hand items. For instance, 180 will display the hand oriented towards the bottom of the screen.
+         */
         _this.baseAngle = 0;
+        /**
+         * The maximum angle that is allowed between the first and the last items displayed.
+         */
         _this.maxAngle = 15;
+        /**
+         * The maximum angle between two consecutive items in the hand
+         */
         _this.gapMaxAngle = 3;
+        /**
+         * The direction of the items displayed, for the first to the last index. Default is true.
+         */
         _this.clockwise = true;
+        /**
+         * The Z-axis position difference between 2 consecutive items in the hand. Default is 0.05cm.
+         */
         _this.deltaZ = 0.05;
         Object.assign(_this, clone);
         return _this;
     }
+    /**
+     * Provide the radius of the circle. Defaults to {@link radius} property.
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the radius of the circle in cm
+     */
     HandLocator.prototype.getRadius = function (_location, _context) {
         return this.radius;
     };
+    /**
+     * Function to override to provide a {@link baseAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the default angle of the items
+     */
     HandLocator.prototype.getBaseAngle = function (_location, _context) {
         return this.baseAngle;
     };
+    /**
+     * Function to override to provide a {@link maxAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the maximum angle between the first and the last items
+     */
     HandLocator.prototype.getMaxAngle = function (_location, _context) {
         return this.maxAngle;
     };
+    /**
+     * Function to override to provide a {@link gapMaxAngle} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The maximum angle between two consecutive items in the hand
+     */
     HandLocator.prototype.getGapMaxAngle = function (_location, _context) {
         return this.gapMaxAngle;
     };
+    /**
+     * Function to override to provide a {@link clockwise} info that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns true if items should be displayed clockwise around the arc of circle. Default is true.
+     */
     HandLocator.prototype.isClockwise = function (_location, _context) {
         return this.clockwise;
     };
+    /**
+     * Function to override to provide a {@link deltaZ} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The Z-axis position difference between 2 consecutive items in the hand. Default is 0.05cm.
+     */
     HandLocator.prototype.getDeltaZ = function (_location, _context) {
         return this.deltaZ;
     };
+    /**
+     * See {@link Locator.getLocationCoordinates}.
+     * @param location Location to position
+     * @param context Context of the game
+     * @param index Index of the item (or location) to place
+     */
     HandLocator.prototype.getLocationCoordinates = function (location, context, index) {
         if (index === void 0) { index = this.getLocationIndex(location, context); }
         var _a = this.getCoordinates(location, context), _b = _a.x, x = _b === void 0 ? 0 : _b, _c = _a.y, y = _c === void 0 ? 0 : _c, _d = _a.z, z = _d === void 0 ? 0 : _d;
@@ -67,6 +130,12 @@ var HandLocator = (function (_super) {
     HandLocator.prototype.getItemCoordinates = function (item, context) {
         return this.getLocationCoordinates(item.location, context, this.getItemIndex(item, context));
     };
+    /**
+     * See {@link Locator.getRotateZ}.
+     * @param location Location to position
+     * @param context Context of the game
+     * @param index Index of the item (or location) to place
+     */
     HandLocator.prototype.getRotateZ = function (location, context, index) {
         if (index === void 0) { index = this.getLocationIndex(location, context); }
         var baseAngle = this.getBaseAngle(location, context);
@@ -96,6 +165,9 @@ var HandLocator = (function (_super) {
             borderRadius: borderRadius
         });
     };
+    /**
+     * See {@link Locator.getHoverTransform}. By default, display the item on top of others, straight, and twice as big.
+     */
     HandLocator.prototype.getHoverTransform = function (item, context) {
         return ['translateZ(10em)', "rotateZ(".concat(-this.getItemRotateZ(item, context)).concat(this.rotationUnit, ")"), 'scale(2)'];
     };

package/dist/locators/HandLocator.js.map

@@ -1 +1 @@
-{"version":3,"file":"HandLocator.js","sourceRoot":"","sources":["../../src/locators/HandLocator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,4CAAyF;AACzF,qCAAiE;AAKjE;IAAkH,+BAAgB;IAEhI,qBAAY,KAA4B;QAAxC,YACE,iBAAO,SAER;QAKD,YAAM,GAAW,GAAG,CAAA;QAepB,eAAS,GAAW,CAAC,CAAA;QAerB,cAAQ,GAAW,EAAE,CAAA;QAerB,iBAAW,GAAW,CAAC,CAAA;QAevB,eAAS,GAAY,IAAI,CAAA;QAezB,YAAM,GAAW,IAAI,CAAA;QAjFnB,MAAM,CAAC,MAAM,CAAC,KAAI,EAAE,KAAK,CAAC,CAAA;;IAC5B,CAAC;IAaD,+BAAS,GAAT,UAAU,SAAyB,EAAE,QAAkC;QACrE,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAaD,kCAAY,GAAZ,UAAa,SAAyB,EAAE,QAAkC;QACxE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAaD,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAaD,oCAAc,GAAd,UAAe,SAAyB,EAAE,QAAkC;QAC1E,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAaD,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAaD,+BAAS,GAAT,UAAU,SAAyB,EAAE,QAAkC;QACrE,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAQD,4CAAsB,GAAtB,UAAuB,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC/D,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QACtE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC,GAAA,EAAE,CAAC,GAAA,EAAE,CAAC,GAAA,EAAE,CAAA;QAC3C,IAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChD,IAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChD,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,IAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QACvD,OAAO;YACL,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC;YAC9F,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC;YAC9F,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,MAAM;SACtB,CAAA;IACH,CAAC;IAED,wCAAkB,GAAlB,UAAmB,IAAwB,EAAE,OAA6B;QACxE,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9F,CAAC;IAQD,gCAAU,GAAV,UAAW,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACzD,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,SAAS,CAAA;QACzC,IAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC/C,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,IAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC1D,IAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5E,OAAO,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzG,CAAC;IAED,oCAAc,GAAd,UAAe,IAAwB,EAAE,OAA6B;QACpE,IAAI,OAAO,CAAC,aAAa;YAAE,OAAO,CAAC,CAAA;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAClF,CAAC;IAES,gEAA0C,GAApD,UAAqD,SAAyB,EAAE,OAA6B;;QAC3G,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAI,IAAI,4BAAe,EAAE,CAAA;QAC/E,IAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAClE,IAAA,KAAoB,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAlD,KAAK,WAAA,EAAE,MAAM,YAAqC,CAAA;QAC1D,IAAM,YAAY,GAAG,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7D,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QACnC,OAAO,IAAI,gCAAmB,CAAC;YAC7B,KAAK,EAAE,GAAG,GAAG,CAAC;YACd,MAAM,EAAE,GAAG,GAAG,CAAC;YACf,YAAY,cAAA;SACb,CAAC,CAAA;IACJ,CAAC;IAKD,uCAAiB,GAAjB,UAAkB,IAAwB,EAAE,OAA6B;QACvE,OAAO,CAAC,kBAAkB,EAAE,kBAAW,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,SAAG,IAAI,CAAC,YAAY,MAAG,EAAE,UAAU,CAAC,CAAA;IAChH,CAAC;IACH,kBAAC;AAAD,CAAC,AAnKD,CAAkH,iBAAO,GAmKxH;AAnKY,kCAAW"}
+{"version":3,"file":"HandLocator.js","sourceRoot":"","sources":["../../src/locators/HandLocator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,4CAAyF;AACzF,qCAAiE;AAEjE;;GAEG;AACH;IAAkH,+BAAgB;IAEhI,qBAAY,KAA4B;QAAxC,YACE,iBAAO,SAER;QAED;;WAEG;QACH,YAAM,GAAW,GAAG,CAAA;QAYpB;;WAEG;QACH,eAAS,GAAW,CAAC,CAAA;QAYrB;;WAEG;QACH,cAAQ,GAAW,EAAE,CAAA;QAYrB;;WAEG;QACH,iBAAW,GAAW,CAAC,CAAA;QAYvB;;WAEG;QACH,eAAS,GAAY,IAAI,CAAA;QAYzB;;WAEG;QACH,YAAM,GAAW,IAAI,CAAA;QAjFnB,MAAM,CAAC,MAAM,CAAC,KAAI,EAAE,KAAK,CAAC,CAAA;;IAC5B,CAAC;IAOD;;;;;OAKG;IACH,+BAAS,GAAT,UAAU,SAAyB,EAAE,QAAkC;QACrE,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAOD;;;;;OAKG;IACH,kCAAY,GAAZ,UAAa,SAAyB,EAAE,QAAkC;QACxE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAOD;;;;;OAKG;IACH,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAOD;;;;;OAKG;IACH,oCAAc,GAAd,UAAe,SAAyB,EAAE,QAAkC;QAC1E,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAOD;;;;;OAKG;IACH,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAOD;;;;;OAKG;IACH,+BAAS,GAAT,UAAU,SAAyB,EAAE,QAAkC;QACrE,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACH,4CAAsB,GAAtB,UAAuB,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC/D,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QACtE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC,GAAA,EAAE,CAAC,GAAA,EAAE,CAAC,GAAA,EAAE,CAAA;QAC3C,IAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChD,IAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChD,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,IAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QACvD,OAAO;YACL,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC;YAC9F,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC;YAC9F,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,MAAM;SACtB,CAAA;IACH,CAAC;IAED,wCAAkB,GAAlB,UAAmB,IAAwB,EAAE,OAA6B;QACxE,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9F,CAAC;IAED;;;;;OAKG;IACH,gCAAU,GAAV,UAAW,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACzD,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,SAAS,CAAA;QACzC,IAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC/C,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,IAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC1D,IAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5E,OAAO,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzG,CAAC;IAED,oCAAc,GAAd,UAAe,IAAwB,EAAE,OAA6B;QACpE,IAAI,OAAO,CAAC,aAAa;YAAE,OAAO,CAAC,CAAA;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAClF,CAAC;IAES,gEAA0C,GAApD,UAAqD,SAAyB,EAAE,OAA6B;;QAC3G,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAI,IAAI,4BAAe,EAAE,CAAA;QAC/E,IAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAClE,IAAA,KAAoB,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAlD,KAAK,WAAA,EAAE,MAAM,YAAqC,CAAA;QAC1D,IAAM,YAAY,GAAG,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7D,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QACnC,OAAO,IAAI,gCAAmB,CAAC;YAC7B,KAAK,EAAE,GAAG,GAAG,CAAC;YACd,MAAM,EAAE,GAAG,GAAG,CAAC;YACf,YAAY,cAAA;SACb,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,uCAAiB,GAAjB,UAAkB,IAAwB,EAAE,OAA6B;QACvE,OAAO,CAAC,kBAAkB,EAAE,kBAAW,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,SAAG,IAAI,CAAC,YAAY,MAAG,EAAE,UAAU,CAAC,CAAA;IAChH,CAAC;IACH,kBAAC;AAAD,CAAC,AAnKD,CAAkH,iBAAO,GAmKxH;AAnKY,kCAAW"}

package/dist/locators/ListLocator.d.ts

@@ -1,14 +1,50 @@
 import { Coordinates, Location, MaterialItem, XYCoordinates } from '@gamepark/rules-api';
 import { LocationDescription } from '../components';
 import { ItemContext, Locator, MaterialContext } from './Locator';
+/**
+ * This Locator places items at regular intervals.
+ */
 export declare class ListLocator<P extends number = number, M extends number = number, L extends number = number> extends Locator<P, M, L> {
     constructor(clone?: Partial<ListLocator>);
+    /**
+     * The default gap between 2 consecutive items
+     */
     gap?: Partial<Coordinates>;
+    /**
+     * Function to override to provide a {@link gap} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The default gap between 2 consecutive items
+     */
     getGap(_location: Location<P, L>, _context: MaterialContext<P, M, L>): Partial<Coordinates>;
+    /**
+     * The maximum number of items that can be displayed in the list before the gap between items is reduced to fill in the same space.
+     */
     maxCount?: number;
+    /**
+     * Function to override to provide a {@link maxCount that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The maximum number of items that can be displayed in the list before the gap between items is reduced to fill in the same space.
+     */
     getMaxCount(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number | undefined;
+    /**
+     * The maximum gap between the first and the last items. See {@link maxCount} to get a maxGap based on a max number of items.
+     */
     maxGap?: Partial<Coordinates>;
+    /**
+     * Function to override to provide a {@link maxGap} that depends on the context
+     * @param location Location to position
+     * @param context Context of the game
+     * @returns The maximum gap between the first and the last items
+     */
     getMaxGap(location: Location<P, L>, context: MaterialContext<P, M, L>): Partial<Coordinates>;
+    /**
+     * The number of items displayed in the list
+     * @param location Location area of the items
+     * @param context Context of the game
+     * @returns number of items in the location area
+     */
     countListItems(location: Location<P, L>, context: MaterialContext<P, M, L>): number;
     protected getAreaCoordinates(location: Location<P, L>, context: MaterialContext<P, M, L>): Partial<Coordinates>;
     protected getCurrentMaxGap(location: Location<P, L>, context: MaterialContext<P, M, L>): XYCoordinates;

package/dist/locators/ListLocator.js

@@ -18,20 +18,41 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListLocator = void 0;
 var components_1 = require("../components");
 var Locator_1 = require("./Locator");
-var ListLocator = (function (_super) {
+/**
+ * This Locator places items at regular intervals.
+ */
+var ListLocator = /** @class */ (function (_super) {
     __extends(ListLocator, _super);
     function ListLocator(clone) {
         var _this = _super.call(this) || this;
         Object.assign(_this, clone);
         return _this;
     }
+    /**
+     * Function to override to provide a {@link gap} that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The default gap between 2 consecutive items
+     */
     ListLocator.prototype.getGap = function (_location, _context) {
         var _a;
         return (_a = this.gap) !== null && _a !== void 0 ? _a : {};
     };
+    /**
+     * Function to override to provide a {@link maxCount that depends on the context
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns The maximum number of items that can be displayed in the list before the gap between items is reduced to fill in the same space.
+     */
     ListLocator.prototype.getMaxCount = function (_location, _context) {
         return this.maxCount;
     };
+    /**
+     * Function to override to provide a {@link maxGap} that depends on the context
+     * @param location Location to position
+     * @param context Context of the game
+     * @returns The maximum gap between the first and the last items
+     */
     ListLocator.prototype.getMaxGap = function (location, context) {
         if (this.maxGap)
             return this.maxGap;
@@ -45,6 +66,12 @@ var ListLocator = (function (_super) {
             z: z ? z * (maxCount - 1) : z
         };
     };
+    /**
+     * The number of items displayed in the list
+     * @param location Location area of the items
+     * @param context Context of the game
+     * @returns number of items in the location area
+     */
     ListLocator.prototype.countListItems = function (location, context) {
         var _a;
         return Math.min((_a = this.limit) !== null && _a !== void 0 ? _a : Infinity, this.countItems(location, context));

package/dist/locators/ListLocator.js.map

@@ -1 +1 @@
-{"version":3,"file":"ListLocator.js","sourceRoot":"","sources":["../../src/locators/ListLocator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,4CAAwE;AACxE,qCAAiE;AAKjE;IAAkH,+BAAgB;IAEhI,qBAAY,KAA4B;QAAxC,YACE,iBAAO,SAER;QADC,MAAM,CAAC,MAAM,CAAC,KAAI,EAAE,KAAK,CAAC,CAAA;;IAC5B,CAAC;IAaD,4BAAM,GAAN,UAAO,SAAyB,EAAE,QAAkC;;QAClE,OAAO,MAAA,IAAI,CAAC,GAAG,mCAAI,EAAE,CAAA;IACvB,CAAC;IAaD,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAaD,+BAAS,GAAT,UAAU,QAAwB,EAAE,OAAiC;QACnE,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,MAAM,CAAA;QACnC,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,EAAE,CAAA;QAC/B,IAAA,KAAc,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA1C,CAAC,OAAA,EAAE,CAAC,OAAA,EAAE,CAAC,OAAmC,CAAA;QAClD,OAAO;YACL,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9B,CAAA;IACH,CAAC;IAQD,oCAAc,GAAd,UAAe,QAAwB,EAAE,OAAiC;;QACxE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;IAC7E,CAAC;IAES,wCAAkB,GAA5B,UAA6B,QAAwB,EAAE,OAAiC;QAChF,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QAChE,IAAA,KAAmB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAtD,EAAE,OAAA,EAAK,EAAE,OAA6C,CAAA;QACjE,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAA,EAAE,CAAA;IAC5C,CAAC;IAES,sCAAgB,GAA1B,UAA2B,QAAwB,EAAE,OAAiC;QAC9E,IAAA,KAA2B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAvD,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAmC,CAAA;QACzD,IAAA,KAAqB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAjD,GAAG,OAAA,EAAK,GAAG,OAAsC,CAAA;QAC5D,IAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACvE,CAAC;IAED,4CAAsB,GAAtB,UAAuB,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACrE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpE,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QAChE,IAAA,KAAyC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAArE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAY,EAAT,EAAE,mBAAG,IAAI,KAAmC,CAAA;QACvE,IAAA,KAA6B,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAzD,GAAG,OAAA,EAAK,GAAG,OAAA,EAAK,GAAG,OAAsC,CAAA;QACpE,IAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,OAAO;YACL,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACnF,CAAA;IACH,CAAC;IAED,wCAAkB,GAAlB,UAAmB,IAAwB,EAAE,OAA6B;QACxE,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9F,CAAC;IAES,gEAA0C,GAApD,UAAqD,QAAwB,EAAE,OAA6B;;QAC1G,IAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACxE,IAAI,CAAC,IAAI;YAAE,OAAM;QACX,IAAA,KAA4B,MAAA,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,0CAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,mCAAI,EAAE,EAAhF,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EAAE,cAAU,EAAV,MAAM,mBAAG,CAAC,KAA2D,CAAA;QAClF,IAAA,KAAW,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAjD,CAAC,OAAA,EAAE,CAAC,OAA6C,CAAA;QACzD,IAAM,YAAY,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,0CAAE,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,mCAAI,CAAC,CAAA;QAClF,OAAO,IAAI,gCAAmB,CAAC;YAC7B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,YAAY,cAAA;SACb,CAAC,CAAA;IACJ,CAAC;IACH,kBAAC;AAAD,CAAC,AAjHD,CAAkH,iBAAO,GAiHxH;AAjHY,kCAAW"}
+{"version":3,"file":"ListLocator.js","sourceRoot":"","sources":["../../src/locators/ListLocator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,4CAAwE;AACxE,qCAAiE;AAEjE;;GAEG;AACH;IAAkH,+BAAgB;IAEhI,qBAAY,KAA4B;QAAxC,YACE,iBAAO,SAER;QADC,MAAM,CAAC,MAAM,CAAC,KAAI,EAAE,KAAK,CAAC,CAAA;;IAC5B,CAAC;IAOD;;;;;OAKG;IACH,4BAAM,GAAN,UAAO,SAAyB,EAAE,QAAkC;;QAClE,OAAO,MAAA,IAAI,CAAC,GAAG,mCAAI,EAAE,CAAA;IACvB,CAAC;IAOD;;;;;OAKG;IACH,iCAAW,GAAX,UAAY,SAAyB,EAAE,QAAkC;QACvE,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAOD;;;;;OAKG;IACH,+BAAS,GAAT,UAAU,QAAwB,EAAE,OAAiC;QACnE,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,MAAM,CAAA;QACnC,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,EAAE,CAAA;QAC/B,IAAA,KAAc,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA1C,CAAC,OAAA,EAAE,CAAC,OAAA,EAAE,CAAC,OAAmC,CAAA;QAClD,OAAO;YACL,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,oCAAc,GAAd,UAAe,QAAwB,EAAE,OAAiC;;QACxE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;IAC7E,CAAC;IAES,wCAAkB,GAA5B,UAA6B,QAAwB,EAAE,OAAiC;QAChF,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QAChE,IAAA,KAAmB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAtD,EAAE,OAAA,EAAK,EAAE,OAA6C,CAAA;QACjE,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAA,EAAE,CAAA;IAC5C,CAAC;IAES,sCAAgB,GAA1B,UAA2B,QAAwB,EAAE,OAAiC;QAC9E,IAAA,KAA2B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAvD,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAmC,CAAA;QACzD,IAAA,KAAqB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAjD,GAAG,OAAA,EAAK,GAAG,OAAsC,CAAA;QAC5D,IAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACvE,CAAC;IAED,4CAAsB,GAAtB,UAAuB,QAAwB,EAAE,OAAiC,EAC3D,KAAgD;QAAhD,sBAAA,EAAA,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACrE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpE,IAAA,KAA0B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAA9D,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAAA,EAAE,SAAK,EAAL,CAAC,mBAAG,CAAC,KAA2C,CAAA;QAChE,IAAA,KAAyC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAArE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAS,EAAN,EAAE,mBAAG,CAAC,KAAA,EAAE,SAAY,EAAT,EAAE,mBAAG,IAAI,KAAmC,CAAA;QACvE,IAAA,KAA6B,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAzD,GAAG,OAAA,EAAK,GAAG,OAAA,EAAK,GAAG,OAAsC,CAAA;QACpE,IAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACpD,OAAO;YACL,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACnF,CAAA;IACH,CAAC;IAED,wCAAkB,GAAlB,UAAmB,IAAwB,EAAE,OAA6B;QACxE,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9F,CAAC;IAES,gEAA0C,GAApD,UAAqD,QAAwB,EAAE,OAA6B;;QAC1G,IAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACxE,IAAI,CAAC,IAAI;YAAE,OAAM;QACX,IAAA,KAA4B,MAAA,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,0CAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,mCAAI,EAAE,EAAhF,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EAAE,cAAU,EAAV,MAAM,mBAAG,CAAC,KAA2D,CAAA;QAClF,IAAA,KAAW,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAjD,CAAC,OAAA,EAAE,CAAC,OAA6C,CAAA;QACzD,IAAM,YAAY,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,0CAAE,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,mCAAI,CAAC,CAAA;QAClF,OAAO,IAAI,gCAAmB,CAAC;YAC7B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,YAAY,cAAA;SACb,CAAC,CAAA;IACJ,CAAC;IACH,kBAAC;AAAD,CAAC,AAjHD,CAAkH,iBAAO,GAiHxH;AAjHY,kCAAW"}

package/dist/locators/Locator.d.ts

@@ -1,50 +1,248 @@
-import { Coordinates, DisplayedItem, Location, MaterialItem, MaterialRules, XYCoordinates } from '@gamepark/rules-api';
+/** @jsxImportSource @emotion/react */
+import { Coordinates, DeleteItem, DisplayedItem, Location, MaterialItem, MaterialRules, MoveItem, XYCoordinates } from '@gamepark/rules-api';
 import { LocationDescription, MaterialDescriptionRecord } from '../components';
 export type SortFunction = ((item: MaterialItem) => number);
+/**
+ * A Locator is responsible for placing item and locations (such as drop areas) on the Game Table.
+ */
 export declare class Locator<P extends number = number, M extends number = number, L extends number = number> {
+    /**
+     * With the constructor, you can create new locators in one line.
+     * @example `new Locator({ coordinates: { x: -10, y: -5 } })`
+     * @param clone Object to clone into the class
+     */
     constructor(clone?: Partial<Locator>);
+    /**
+     * Types of items placed by the locator since it was created
+     * @internal
+     * @protected
+     */
     protected itemTypes: M[];
+    /**
+     * If the locator places items on top of another item (a game board for instance), the type of the parent item must be provided here.
+     */
     parentItemType?: M;
+    /**
+     * The maximum number of items do display.
+     */
     limit?: number;
+    /**
+     * The rotation unit to use. See {@link getRotateZ}
+     */
     rotationUnit: string;
+    /**
+     * Declare this field if you always need to display one location that does not depend on the context. See {@link getLocations}.
+     */
     location?: Location<P, L>;
+    /**
+     * Declare this field if you always need to display some locations that does not depend on the context. See {@link getLocations}.
+     */
     locations: Location<P, L>[];
+    /**
+     * Override this if you need to display some locations on the Game Table that depends on the context.
+     * By default, return any {@link location} or {@link locations}.
+     */
     getLocations(_context: MaterialContext<P, M, L>): Location<P, L>[];
+    /**
+     * If you need do display custom locations in the game, provide their description here.
+     */
     locationDescription?: LocationDescription<P, M, L>;
+    /**
+     * @internal
+     * This function automatically create some drop location descriptions based on the context (dragged item, parent item).
+     *
+     * Do not override it but use {@link locationDescription},
+     * otherwise the images of the location descriptions will not be preloaded by the {@link MaterialImageLoader}.
+     */
     getLocationDescription(location: Location<P, L>, context: MaterialContext<P, M, L> | ItemContext<P, M, L>): LocationDescription<P, M, L> | undefined;
+    /**
+     * @internal This function provides a custom location description for the current dragged item.
+     */
     protected generateLocationDescriptionFromDraggedItem(_location: Location<P, L>, context: ItemContext<P, M, L>): LocationDescription<P, M, L> | undefined;
+    /**
+     * This function can hide some items on the game table depending on the context.
+     * @param item The item
+     * @param context The context of the item
+     * @returns true if the item must be hidden
+     */
     hide(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): boolean;
+    /**
+     * Provide a list of css transform operations to place a location on the game table.
+     * @param location Location to place
+     * @param context Context of the location in the game
+     * @returns the css transform that will be applied to the location
+     */
     placeLocation(location: Location<P, L>, context: LocationContext<P, M, L>): string[];
+    /**
+     * Provide a list of css transform operations to place an item on the game table.
+     * @param item Item to place
+     * @param context Context of the item in the game
+     * @returns the css transform that will be applied to the item
+     */
     placeItem(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): string[];
+    /**
+     * Provide a list of css transform operations to place an item on a parent item.
+     * @param item Item to place
+     * @param context Context of the item in the game
+     * @returns the css transform that will be applied to the item
+     */
     protected placeItemOnParent(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): string[];
+    /**
+     * If a location belongs to an item, returns the item
+     * @param location A location
+     * @param context Context of the game
+     * @returns the parent item of the location if any
+     */
     getParentItem(location: Location<P, L>, { rules, material }: MaterialContext<P, M, L>): MaterialItem<P, L> | undefined;
+    /**
+     * Position of the location on the parent item, in percentage. Use {@link getPositionOnParent} to provide a dynamic position.
+     */
     positionOnParent: XYCoordinates;
+    /**
+     * Place the center of the item in the plan of their parent item. This is ignored if "parentItemType" is undefined.
+     * Examples: {x: 0, y: 0} places the center of the item in the top-left corner of the parent item
+     * {x: 50, y: 50} centers the item in the parent item.
+     *
+     * @param _location Location of the item or area inside the parent item
+     * @param _context THe material game context
+     * @return {x, y} with "x" as a percentage from the parent's width, "y" a percentage of the height
+     */
     getPositionOnParent(_location: Location<P, L>, _context: MaterialContext<P, M, L>): XYCoordinates;
+    /**
+     * Coordinates of the location on the Game Table. Use {@link getCoordinates} to provide dynamic coordinates.
+     */
     coordinates: Partial<Coordinates>;
+    /**
+     * Provide the coordinates of a location on the Game Table.
+     *
+     * Called by {@link getLocationCoordinates} but can be used as the Hand, List or Pile "initial" position in subclasses.
+     *
+     * @param _location Location to position
+     * @param _context Context of the game
+     * @returns the x, y, z coordinates (in cm) of the location
+     */
     getCoordinates(_location: Location<P, L>, _context: MaterialContext<P, M, L>): Partial<Coordinates>;
+    /**
+     * Provide the coordinates of a location on the Game Table.
+     *
+     * Fallback to {@link getCoordinates} but the differences appear in subclasses {@link ListLocator}, {@link PileLocator}, {@link HandLocator}.
+     *
+     * @param location Location to position
+     * @param context Context of the game
+     * @returns the x, y, z coordinates (in cm) of the location
+     */
     getLocationCoordinates(location: Location<P, L>, context: MaterialContext<P, M, L>): Partial<Coordinates>;
+    /**
+     * Provide the coordinates of the center of an item on the Game Table.
+     *
+     * @param item Item being placed
+     * @param context Context of the item in the game
+     * @return The x, y, z coordinates in cm of the center of the item on the table
+     */
     getItemCoordinates(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): Partial<Coordinates>;
+    /**
+     * The default Z-axis rotation of the items or locations to place if {@link getRotateZ} is not overridden.
+     */
     rotateZ: number;
+    /**
+     * Get the Z-axis rotation of a location.
+     * @param _location Location to place
+     * @param _context Context of the location
+     * @returns the rotation (unit in {@link rotationUnit})
+     */
     getRotateZ(_location: Location<P, L>, _context: MaterialContext<P, M, L>): number;
+    /**
+     * Get the Z-axis rotation of an item. Defaults to {@link getRotateZ}.
+     * @param item item to place
+     * @param context Context of the item
+     * @returns the rotation (unit in {@link rotationUnit})
+     */
     getItemRotateZ(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): number;
+    /**
+     * The index of a location to place, if it matters in the locator's context (see {@link HandLocator}, {@link ListLocator} or {@link PileLocator}).
+     *
+     * Defaults to location.x first, y otherwise, z last.
+     *
+     * @param location Location to index in the location area (see {@link isSameLocationArea})
+     * @param _context Context of the game
+     * @returns the index of the location in the location area
+     */
     getLocationIndex(location: Location<P, L>, _context: MaterialContext<P, M, L>): number | undefined;
+    /**
+     * Index of an item to place (fallback to {@link getLocationIndex} or item's displayIndex).
+     * @param item Item to place
+     * @param context Context of the item
+     * @returns the index of the item in the location area
+     */
     getItemIndex(item: MaterialItem<P, L>, context: ItemContext<P, M, L>): number;
+    /**
+     * The total number of items in the same location area (see {@link isSameLocationArea}).
+     *
+     * @param location the location area
+     * @param context Context of the game
+     * @returns the total number of items in the location area
+     */
     countItems(location: Location<P, L>, { rules }: MaterialContext<P, M, L>): number;
+    /**
+     * Any css transform to apply to the item when it is hovered by the pointer. See {@link HandLocator} override for example.
+     * @param _item The item
+     * @param _context Context of the item
+     * @returns the list of css transforms
+     */
     getHoverTransform(_item: MaterialItem<P, L>, _context: ItemContext<P, M, L>): string[];
+    /**
+     * How items in the same location area are sorted for the help dialog navigation arrows.
+     */
     navigationSorts: SortFunction[];
+    /**
+     * How items in the same location area are sorted for the help dialog navigation arrows.
+     * @param _context Context of the game
+     * @returns The list of sort functions to sort the items.
+     */
     getNavigationSorts(_context: ItemContext<P, M, L>): SortFunction[];
+    /**
+     * Utility function for animation to know if the item is one that should be animated.
+     * @param item Item to consider
+     * @param context Context of the Item
+     * @param move Move to animate
+     * @returns true if the items must be animated
+     */
+    isItemToAnimate(item: MaterialItem<P, L>, context: ItemContext<P, M, L>, move: MoveItem<P, M, L> | DeleteItem<M>): boolean;
 }
+/**
+ * A record of item locators, to provide to the game context.
+ */
 export type ItemLocatorRecord<P extends number = number, M extends number = number, L extends number = number> = Record<L, Locator<P, M, L>>;
+/**
+ * Data structure for the context of a game displayed.
+ * @property rules The rules of the game with current game state.
+ * @property material The record of the material descriptions to display the items.
+ * @property locators The record of the locators to place the items.
+ * @property player The player currently displaying the game. Undefined for spectators.
+ */
 export type MaterialContext<P extends number = number, M extends number = number, L extends number = number> = {
     rules: MaterialRules<P, M, L>;
     material: Partial<MaterialDescriptionRecord<P, M, L>>;
     locators: Partial<ItemLocatorRecord<P, M, L>>;
     player?: P;
 };
+/**
+ * Data structure for the context of an item in a game displayed.
+ * @property dragTransform The CSS translate operation applied to the item, if any.
+ */
 export type ItemContext<P extends number = number, M extends number = number, L extends number = number> = MaterialContext<P, M, L> & DisplayedItem<M> & {
     dragTransform?: string;
 };
+/**
+ * Type guard to test if some MaterialContext is also an item context.
+ * @param context Context of the game
+ * @returns true if the context also hold information about a specific item in the game.
+ */
 export declare function isItemContext<P extends number = number, M extends number = number, L extends number = number>(context: MaterialContext<P, M, L>): context is ItemContext<P, M, L>;
+/**
+ * Context of a location in a displayed game.
+ * @property canDrop Whether some item is currently being dragged, and can be dropped in the location.
+ */
 export type LocationContext<P extends number = number, M extends number = number, L extends number = number> = MaterialContext<P, M, L> & {
     canDrop?: boolean;
 };