@gamepark/react-game 6.38.7 → 7.0.0-beta.3

package/dist/locators/Locator.js

@@ -1,422 +1,376 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getItemFromContext = exports.isItemContext = exports.Locator = void 0;
-/** @jsxImportSource @emotion/react */
-var rules_api_1 = require("@gamepark/rules-api");
-var isEqual_1 = __importDefault(require("lodash/isEqual"));
-var sumBy_1 = __importDefault(require("lodash/sumBy"));
-var uniqWith_1 = __importDefault(require("lodash/uniqWith"));
-var components_1 = require("../components");
-/**
- * A Locator is responsible for placing item and locations (such as drop areas) on the Game Table.
- */
-var Locator = /** @class */ (function () {
-    /**
-     * 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
-     */
-    function Locator(clone) {
-        /**
-         * Types of items placed by the locator since it was created
-         * @internal
-         * @protected
-         */
-        this.itemTypes = [];
-        /**
-         * The rotation unit to use. See {@link getRotateZ}
-         */
-        this.rotationUnit = 'deg';
-        /**
-         * Declare this field if you always need to display some locations that does not depend on the context. See {@link getLocations}.
-         */
-        this.locations = [];
-        /**
-         * Position of the location on the parent item, in percentage. Use {@link getPositionOnParent} to provide a dynamic position.
-         */
-        this.positionOnParent = { x: 50, y: 50 };
-        /**
-         * Coordinates of the location on the Game Table. Use {@link getCoordinates} to provide dynamic coordinates.
-         */
-        this.coordinates = { x: 0, y: 0, z: 0 };
-        /**
-         * The default Z-axis rotation of the items or locations to place if {@link getRotateZ} is not overridden.
-         */
-        this.rotateZ = 0;
-        /**
-         * How items in the same location area are sorted for the help dialog navigation arrows.
-         */
-        this.navigationSorts = [function (item) { var _a; return (_a = item.location.x) !== null && _a !== void 0 ? _a : 0; }, function (item) { var _a; return (_a = item.location.y) !== null && _a !== void 0 ? _a : 0; }, function (item) { var _a; return (_a = item.location.z) !== null && _a !== void 0 ? _a : 0; }];
-        /**
-         * If set to true, each time an item is dragged over
-         */
-        this.dropPreview = false;
-        Object.assign(this, clone);
-    }
-    /**
-     * 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}.
-     */
-    Locator.prototype.getLocations = function (_context) {
-        return this.location ? [this.location] : this.locations;
-    };
-    /**
-     * @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}.
-     */
-    Locator.prototype.getLocationDescription = function (location, context) {
-        if (!this.locationDescription) {
-            if (this.parentItemType !== undefined && location.x === undefined && location.y === undefined && location.z === undefined) {
-                var material = context.material[this.parentItemType];
-                if (material) {
-                    this.locationDescription = new components_1.DropAreaDescription(material);
-                }
-            }
-            else if (isItemContext(context)) {
-                return this.generateLocationDescriptionFromDraggedItem(location, context);
-            }
-        }
-        return this.locationDescription;
-    };
-    /**
-     * @internal This function provides a custom location description for the current dragged item.
-     */
-    Locator.prototype.generateLocationDescriptionFromDraggedItem = function (_location, context) {
-        return new components_1.DropAreaDescription(context.material[context.type]);
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.hide = function (item, context) {
-        return this.limit !== undefined && this.getItemIndex(item, context) < 0;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.placeLocation = function (location, context) {
-        var transform = [];
-        var _a = this.getLocationCoordinates(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;
-        if (x || y || z) {
-            transform.push("translate3d(".concat(x, "em, ").concat(y, "em, ").concat(z, "em)"));
-        }
-        var rotateZ = this.getRotateZ(location, context);
-        if (rotateZ) {
-            transform.push("rotateZ(".concat(rotateZ).concat(this.rotationUnit, ")"));
-        }
-        if (context.canDrop)
-            transform.push('translateZ(5em)');
-        return transform;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.placeItem = function (item, context) {
-        if (!this.itemTypes.includes(context.type)) {
-            this.itemTypes.push(context.type);
-        }
-        var transform = this.placeItemOnParent(item, context);
-        var _a = this.getItemCoordinates(item, 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;
-        if (x || y || z) {
-            transform.push("translate3d(".concat(x, "em, ").concat(y, "em, ").concat(z, "em)"));
-        }
-        var rotateZ = this.getItemRotateZ(item, context);
-        if (rotateZ) {
-            transform.push("rotateZ(".concat(rotateZ).concat(this.rotationUnit, ")"));
-        }
-        return transform;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.placeItemOnParent = function (item, context) {
-        var _a;
-        var parentItem = this.getParentItem(item.location, context);
-        if (this.parentItemType === undefined || !parentItem)
-            return [];
-        var locator = context.locators[parentItem.location.type];
-        var parentContext = __assign(__assign({}, context), { type: this.parentItemType, displayIndex: 0 });
-        var transform = (_a = locator === null || locator === void 0 ? void 0 : locator.placeItem(parentItem, parentContext)) !== null && _a !== void 0 ? _a : [];
-        var parentMaterial = context.material[this.parentItemType];
-        var _b = this.getPositionOnParent(item.location, context), x = _b.x, y = _b.y;
-        if (parentMaterial && (x !== 0 || y !== 0)) {
-            var _c = parentMaterial.getSize(parentItem.id), width = _c.width, height = _c.height;
-            transform.push("translate3d(".concat(width * (x - 50) / 100, "em, ").concat(height * (y - 50) / 100, "em, ").concat(parentMaterial.getThickness(parentItem, parentContext), "em)"));
-        }
-        return transform;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getParentItem = function (location, context) {
-        var _a;
-        var rules = context.rules, material = context.material;
-        if (this.parentItemType === undefined)
-            return undefined;
-        if (location.parent === undefined)
-            return (_a = material[this.parentItemType]) === null || _a === void 0 ? void 0 : _a.staticItem;
-        return rules.material(this.parentItemType).getItem(location.parent);
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getPositionOnParent = function (_location, _context) {
-        return this.positionOnParent;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getCoordinates = function (_location, _context) {
-        return this.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
-     */
-    Locator.prototype.getLocationCoordinates = function (location, context) {
-        return this.getCoordinates(location, context);
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getItemCoordinates = function (item, context) {
-        return this.getLocationCoordinates(item.location, context);
-    };
-    /**
-     * 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})
-     */
-    Locator.prototype.getRotateZ = function (_location, _context) {
-        return this.rotateZ;
-    };
-    /**
-     * 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})
-     */
-    Locator.prototype.getItemRotateZ = function (item, context) {
-        return this.getRotateZ(item.location, context);
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getLocationIndex = function (location, _context) {
-        var _a, _b;
-        return (_b = (_a = location.x) !== null && _a !== void 0 ? _a : location.y) !== null && _b !== void 0 ? _b : location.z;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getItemIndex = function (item, context) {
-        var _a;
-        var index = (_a = this.getLocationIndex(item.location, context)) !== null && _a !== void 0 ? _a : context.displayIndex;
-        if (this.limit === undefined)
-            return index;
-        var count = this.countItems(item.location, context);
-        if (count <= this.limit)
-            return index;
-        return this.limit - count + index;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.countItems = function (location, _a) {
-        var rules = _a.rules;
-        return (0, sumBy_1.default)(this.itemTypes, function (type) { return rules.material(type).location(function (itemLocation) { return (0, rules_api_1.isSameLocationArea)(itemLocation, location); }).getQuantity(); });
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.getHoverTransform = function (_item, _context) {
-        return [];
-    };
-    /**
-     * 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.
-     */
-    Locator.prototype.getNavigationSorts = function (_context) {
-        return this.navigationSorts;
-    };
-    /**
-     * 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
-     */
-    Locator.prototype.isItemToAnimate = function (item, context, move) {
-        var e_1, _a;
-        var _b, _c, _d;
-        var rules = context.rules, type = context.type, index = context.index, displayIndex = context.displayIndex;
-        if (move.itemType !== type || move.itemIndex !== index)
-            return false;
-        var quantity = (_b = item.quantity) !== null && _b !== void 0 ? _b : 1;
-        var movedQuantity = (_c = move.quantity) !== null && _c !== void 0 ? _c : 1;
-        if (quantity === movedQuantity)
-            return true;
-        // If we move only a part of the quantity, we need to find which displayed items should move
-        var droppedItems = (_d = rules.game.droppedItems) !== null && _d !== void 0 ? _d : [];
-        var displayIndexMoving = quantity - movedQuantity;
-        try {
-            for (var droppedItems_1 = __values(droppedItems), droppedItems_1_1 = droppedItems_1.next(); !droppedItems_1_1.done; droppedItems_1_1 = droppedItems_1.next()) {
-                var droppedItem = droppedItems_1_1.value;
-                if (droppedItem.type === type && droppedItem.index === index) {
-                    var droppedIndex = droppedItem.displayIndex;
-                    if (displayIndex === droppedIndex)
-                        return true;
-                    if (droppedIndex < displayIndexMoving)
-                        displayIndexMoving++;
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (droppedItems_1_1 && !droppedItems_1_1.done && (_a = droppedItems_1.return)) _a.call(droppedItems_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return context.displayIndex >= displayIndexMoving;
-    };
-    /**
-     * Given an item being dragged, and all the moves for this item going to this location type, this function must return the list of valid drop locations
-     * for the item
-     * @param moves Legal movements for the item
-     * @param context Context of the item
-     * @return the drop locations to display
-     */
-    Locator.prototype.getDropLocations = function (moves, context) {
-        return (0, uniqWith_1.default)(moves.map(function (move) {
-            var _a;
-            var _b = move.location, rotation = _b.rotation, location = __rest(_b, ["rotation"]);
-            var itemIndex = (0, rules_api_1.isMoveItem)(move) ? move.itemIndex : move.indexes[0];
-            var type = (_a = location.type) !== null && _a !== void 0 ? _a : context.rules.material(move.itemType).getItem(itemIndex).location.type;
-            return __assign({ type: type }, location);
-        }), isEqual_1.default);
-    };
-    /**
-     * If this function returns true, a preview of the dragged item will be displayed when it is over this location.
-     * @param _move The move that will be played if the item is dropped
-     * @param _context Context of the game
-     * @return true if a preview must be displayed
-     */
-    Locator.prototype.showDropPreview = function (_move, _context) {
-        return this.dropPreview;
-    };
-    return Locator;
-}());
-exports.Locator = Locator;
-/**
- * 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.
- */
-function isItemContext(context) {
-    var itemContext = context;
-    return itemContext.type !== undefined && itemContext.index !== undefined && itemContext.displayIndex !== undefined;
-}
-exports.isItemContext = isItemContext;
-/**
- * Help function to get an item from an ItemContext
- * @param context Context of the item
- * @return The item
- */
-function getItemFromContext(context) {
-    return context.rules.material(context.type).getItem(context.index);
-}
-exports.getItemFromContext = getItemFromContext;
+/** @jsxImportSource @emotion/react */
+import { isMoveItem, isSameLocationArea } from '@gamepark/rules-api';
+import { isEqual, sumBy, uniqWith } from 'es-toolkit';
+import { DropAreaDescription } from '../components';
+/**
+ * A Locator is responsible for placing item and locations (such as drop areas) on the Game Table.
+ */
+export class Locator {
+    /**
+     * 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) {
+        Object.assign(this, clone);
+    }
+    /**
+     * Types of items placed by the locator since it was created
+     * @internal
+     * @protected
+     */
+    itemTypes = [];
+    /**
+     * 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;
+    /**
+     * The maximum number of items do display.
+     */
+    limit;
+    /**
+     * The rotation unit to use. See {@link getRotateZ}
+     */
+    rotationUnit = 'deg';
+    /**
+     * Declare this field if you always need to display one location that does not depend on the context. See {@link getLocations}.
+     */
+    location;
+    /**
+     * Declare this field if you always need to display some locations that does not depend on the context. See {@link getLocations}.
+     */
+    locations = [];
+    /**
+     * 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) {
+        return this.location ? [this.location] : this.locations;
+    }
+    /**
+     * If you need do display custom locations in the game, provide their description here.
+     */
+    locationDescription;
+    /**
+     * @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, context) {
+        if (!this.locationDescription) {
+            if (this.parentItemType !== undefined && location.x === undefined && location.y === undefined && location.z === undefined) {
+                const material = context.material[this.parentItemType];
+                if (material) {
+                    this.locationDescription = new DropAreaDescription(material);
+                }
+            }
+            else if (isItemContext(context)) {
+                return this.generateLocationDescriptionFromDraggedItem(location, context);
+            }
+        }
+        return this.locationDescription;
+    }
+    /**
+     * @internal This function provides a custom location description for the current dragged item.
+     */
+    generateLocationDescriptionFromDraggedItem(_location, context) {
+        return new DropAreaDescription(context.material[context.type]);
+    }
+    /**
+     * 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, context) {
+        return this.limit !== undefined && this.getItemIndex(item, context) < 0;
+    }
+    /**
+     * 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, context) {
+        const transform = [];
+        const { x = 0, y = 0, z = 0 } = this.getLocationCoordinates(location, context);
+        if (x || y || z) {
+            transform.push(`translate3d(${x}em, ${y}em, ${z}em)`);
+        }
+        const rotateZ = this.getRotateZ(location, context);
+        if (rotateZ) {
+            transform.push(`rotateZ(${rotateZ}${this.rotationUnit})`);
+        }
+        if (context.canDrop)
+            transform.push('translateZ(5em)');
+        return transform;
+    }
+    /**
+     * 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, context) {
+        if (!this.itemTypes.includes(context.type)) {
+            this.itemTypes.push(context.type);
+        }
+        const transform = this.placeItemOnParent(item, context);
+        const { x = 0, y = 0, z = 0 } = this.getItemCoordinates(item, context);
+        if (x || y || z) {
+            transform.push(`translate3d(${x}em, ${y}em, ${z}em)`);
+        }
+        const rotateZ = this.getItemRotateZ(item, context);
+        if (rotateZ) {
+            transform.push(`rotateZ(${rotateZ}${this.rotationUnit})`);
+        }
+        return transform;
+    }
+    /**
+     * 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
+     */
+    placeItemOnParent(item, context) {
+        const parentItem = this.getParentItem(item.location, context);
+        if (this.parentItemType === undefined || !parentItem)
+            return [];
+        const locator = context.locators[parentItem.location.type];
+        const parentContext = { ...context, type: this.parentItemType, displayIndex: 0 };
+        const transform = locator?.placeItem(parentItem, parentContext) ?? [];
+        const parentMaterial = context.material[this.parentItemType];
+        const { x, y } = this.getPositionOnParent(item.location, context);
+        if (parentMaterial && (x !== 0 || y !== 0)) {
+            const { width, height } = parentMaterial.getSize(parentItem.id);
+            transform.push(`translate3d(${width * (x - 50) / 100}em, ${height * (y - 50) / 100}em, ${parentMaterial.getThickness(parentItem, parentContext)}em)`);
+        }
+        return transform;
+    }
+    /**
+     * 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, context) {
+        const { rules, material } = context;
+        if (this.parentItemType === undefined)
+            return undefined;
+        if (location.parent === undefined)
+            return material[this.parentItemType]?.staticItem;
+        return rules.material(this.parentItemType).getItem(location.parent);
+    }
+    /**
+     * Position of the location on the parent item, in percentage. Use {@link getPositionOnParent} to provide a dynamic position.
+     */
+    positionOnParent = { x: 50, y: 50 };
+    /**
+     * 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, _context) {
+        return this.positionOnParent;
+    }
+    /**
+     * Coordinates of the location on the Game Table. Use {@link getCoordinates} to provide dynamic coordinates.
+     */
+    coordinates = { x: 0, y: 0, z: 0 };
+    /**
+     * 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, _context) {
+        return this.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, context) {
+        return this.getCoordinates(location, context);
+    }
+    /**
+     * 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, context) {
+        return this.getLocationCoordinates(item.location, context);
+    }
+    /**
+     * The default Z-axis rotation of the items or locations to place if {@link getRotateZ} is not overridden.
+     */
+    rotateZ = 0;
+    /**
+     * 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, _context) {
+        return this.rotateZ;
+    }
+    /**
+     * 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, context) {
+        return this.getRotateZ(item.location, context);
+    }
+    /**
+     * 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, _context) {
+        return location.x ?? location.y ?? location.z;
+    }
+    /**
+     * 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, context) {
+        const index = this.getLocationIndex(item.location, context) ?? context.displayIndex;
+        if (this.limit === undefined)
+            return index;
+        const count = this.countItems(item.location, context);
+        if (count <= this.limit)
+            return index;
+        return this.limit - count + index;
+    }
+    /**
+     * 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, { rules }) {
+        return sumBy(this.itemTypes, type => rules.material(type).location(itemLocation => isSameLocationArea(itemLocation, location)).getQuantity());
+    }
+    /**
+     * 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, _context) {
+        return [];
+    }
+    /**
+     * How items in the same location area are sorted for the help dialog navigation arrows.
+     */
+    navigationSorts = [(item) => item.location.x ?? 0, (item) => item.location.y ?? 0, (item) => item.location.z ?? 0];
+    /**
+     * 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) {
+        return this.navigationSorts;
+    }
+    /**
+     * 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, context, move) {
+        const { rules, type, index, displayIndex } = context;
+        if (move.itemType !== type || move.itemIndex !== index)
+            return false;
+        const quantity = item.quantity ?? 1;
+        const movedQuantity = move.quantity ?? 1;
+        if (quantity === movedQuantity)
+            return true;
+        // If we move only a part of the quantity, we need to find which displayed items should move
+        const droppedItems = rules.game.droppedItems ?? [];
+        let displayIndexMoving = quantity - movedQuantity;
+        for (const droppedItem of droppedItems) {
+            if (droppedItem.type === type && droppedItem.index === index) {
+                const droppedIndex = droppedItem.displayIndex;
+                if (displayIndex === droppedIndex)
+                    return true;
+                if (droppedIndex < displayIndexMoving)
+                    displayIndexMoving++;
+            }
+        }
+        return context.displayIndex >= displayIndexMoving;
+    }
+    /**
+     * Given an item being dragged, and all the moves for this item going to this location type, this function must return the list of valid drop locations
+     * for the item
+     * @param moves Legal movements for the item
+     * @param context Context of the item
+     * @return the drop locations to display
+     */
+    getDropLocations(moves, context) {
+        return uniqWith(moves.map(move => {
+            const { rotation, ...location } = move.location;
+            const itemIndex = isMoveItem(move) ? move.itemIndex : move.indexes[0];
+            const type = location.type ?? context.rules.material(move.itemType).getItem(itemIndex).location.type;
+            return { type, ...location };
+        }), isEqual);
+    }
+    /**
+     * If set to true, each time an item is dragged over
+     */
+    dropPreview = false;
+    /**
+     * If this function returns true, a preview of the dragged item will be displayed when it is over this location.
+     * @param _move The move that will be played if the item is dropped
+     * @param _context Context of the game
+     * @return true if a preview must be displayed
+     */
+    showDropPreview(_move, _context) {
+        return this.dropPreview;
+    }
+    help;
+}
+/**
+ * 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 function isItemContext(context) {
+    const itemContext = context;
+    return itemContext.type !== undefined && itemContext.index !== undefined && itemContext.displayIndex !== undefined;
+}
+/**
+ * Help function to get an item from an ItemContext
+ * @param context Context of the item
+ * @return The item
+ */
+export function getItemFromContext(context) {
+    return context.rules.material(context.type).getItem(context.index);
+}
 //# sourceMappingURL=Locator.js.map