@gamepark/rules-api 6.24.2 → 6.24.3

package/dist/material/items/Material.d.ts

@@ -3,52 +3,305 @@ import { CreateItem, CreateItemsAtOnce, DeleteItem, DeleteItemsAtOnce, ItemMove,
 import { MaterialDeck } from './MaterialDeck';
 import { MaterialItem } from './MaterialItem';
 type ItemEntry<P extends number = number, L extends number = number> = [number, MaterialItem<P, L>];
+/**
+ * The Material class is the core helper class that help manipulate the game items in a simple way.
+ * It includes two kind of functions: functions to filter items, and functions to build {@link ItemMove} objects.
+ * Filter function will all return a new instance of Material with only the filtered items. This class is designed to be immutable.
+ *
+ * @typeparam P - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam M - Numeric enum of the types of material manipulated in the game
+ * @typeparam L - Numeric enum of the types of location in the game where the material can be located
+ */
 export declare class Material<P extends number = number, M extends number = number, L extends number = number> {
     readonly type: M;
     readonly entries: ItemEntry<P, L>[];
     protected readonly processMove?: ((move: ItemMove<P, M, L>) => void) | undefined;
+    /**
+     * Construct a new Material helper instance
+     * @param {number} type Type of items this instance will work on
+     * @param {ItemEntry[]} entries The list of items to work on. Each entry consists of an array with the index of the item, and the item
+     * @param {function} processMove if provided, this function will be executed on every move created with this instance
+     */
     constructor(type: M, entries: ItemEntry<P, L>[], processMove?: ((move: ItemMove<P, M, L>) => void) | undefined);
+    /**
+     * Helper function to return a new instance of the same class (works also for children class)
+     * @param {ItemEntry[]} entries Filtered entries for the new class
+     * @returns {this} the new Material instance
+     * @protected
+     */
     protected new(entries: ItemEntry<P, L>[]): this;
+    /**
+     * Use this function to collect all the items in the current Material instance.
+     * For example, you can filter then collect the matching items: this.material(type).location(locationType).getItems()
+     *
+     * @typeparam Id - Identifier of the items (item.id)
+     * @param {function} predicate If provided, only the items matching the predicate will be returned
+     * @returns {MaterialItem[]} the items in this Material instance
+     */
     getItems<Id = any>(predicate?: (item: MaterialItem<P, L, Id>) => boolean): MaterialItem<P, L, Id>[];
+    /**
+     * @overload
+     * Get the item at a specific index.
+     * @throws Error if there is no item at this index
+     *
+     * @param {number} index Index of the item
+     * @returns {MaterialItem} the item
+     */
     getItem<Id = any>(index: number): MaterialItem<P, L, Id>;
+    /**
+     * @overload
+     * @param predicate If provided, returns the first item matching the predicate
+     * @returns {MaterialItem | undefined} the item, or undefined if none match
+     */
     getItem<Id = any>(predicate?: (item: MaterialItem<P, L, Id>) => boolean): MaterialItem<P, L, Id> | undefined;
+    /**
+     * @returns {number} index of the first item
+     */
     getIndex(): number;
+    /**
+     * @returns {number[]} indexes of the items
+     */
     getIndexes(): number[];
+    /**
+     * Filter and return a new instance with only the items that match a specific index, or a specific index predicate
+     * @param {number | function} arg The index to keep, or the predicate matching the indexes to keep
+     */
     index(arg?: number | number[] | ((index: number) => boolean)): this;
+    /**
+     * @deprecated Use {@link index} instead
+     */
     indexes(indexes: number[]): this;
+    /**
+     * @returns {number} number of items
+     */
     get length(): number;
+    /**
+     * @returns {number} Sum of the quantity of all items
+     */
     getQuantity(): number;
+    /**
+     * This function filter the items and returns a new instance with only the filtered items.
+     * This function is the top level filtering function, but other function can be used to simplify the code:
+     * {@link player}, {@link location}, {@link rotation}, {@link id}, {@link locationId}...
+     *
+     * @param {function} predicate The predicate function. Takes every item and index, and keep the item if it returns true
+     * @returns {this} New instance with only the items that match the predicate
+     */
     filter(predicate: (item: MaterialItem<P, L>, index: number) => boolean): this;
+    /**
+     * Filters the items based on their ids.
+     *
+     * @param {function | string | number | Record} arg Id to keep, or predicate function to match the ids of the items to keep
+     * @returns {this} New instance with only the items which ids match the argument
+     */
     id<Id extends string | number | Record<string, any> | undefined>(arg?: Id | ((id: Id) => boolean)): this;
+    /**
+     * Filters the items based on their location type, or their location.
+     *
+     * @param {function | number} arg Location type to keep, or predicate function to match the location of the items to keep
+     * @returns {this} New instance with only the items which locations match the argument
+     */
     location(arg: L | ((location: Location<P, L>) => boolean)): this;
+    /**
+     * Filters the items based on their rotation (item.location.rotation)
+     *
+     * @param {function | string | number | boolean | Record} arg rotation to keep, or predicate function to match the rotations of the items to keep
+     * @returns {this} New instance with only the items which rotation match the argument
+     */
     rotation<R extends string | number | boolean | Record<string, any> | undefined>(arg?: R | ((rotation: R) => boolean)): this;
+    /**
+     * Filters the items based on their owner (item.location.player)
+     *
+     * @param {function | number} arg player id to keep, or predicate function to match the owner player of the items to keep
+     * @returns {this} New instance with only the items which owner match the argument
+     */
     player(arg?: P | ((player?: P) => boolean)): this;
+    /**
+     * Filters the items based on their location's id (item.location.id)
+     *
+     * @param {function | number} arg location id to keep, or predicate function to match the location id of the items to keep
+     * @returns {this} New instance with only the items which location id match the argument
+     */
     locationId<Id extends string | number | boolean | Record<string, any> | undefined>(arg: Id | ((id: Id) => boolean)): this;
+    /**
+     * Filters the items based on their location's parent (item.location.parent).
+     *
+     * @param {function | number} arg location parent to keep, or predicate function to match the location parent of the items to keep
+     * @returns {this} New instance with only the items which location parent match the argument
+     */
     parent(arg?: number | ((parent?: number) => boolean)): this;
+    /**
+     * Filters the items that are selected (item.selected).
+     *
+     * @param {number | boolean} selected The selected value to compare (default is true)
+     * @returns {this} New instance with only the items which are selected
+     */
     selected(selected?: number | boolean): this;
+    /**
+     * Keep only the item that has the minimum value returned by the selector argument.
+     * See {@link minBy} from Lodash
+     *
+     * @param {function} selector The function that evaluate the item's value
+     * @returns {this} New instance with only the item which has the minimum value
+     */
     minBy(selector: (item: MaterialItem<P, L>) => number): this;
+    /**
+     * Keep only the item that has the maximum value returned by the selector argument.
+     * See {@link maxBy} from Lodash
+     *
+     * @param {function} selector The function that evaluate the item's value
+     * @returns {this} New instance with only the item which has the maximum value
+     */
     maxBy(selector: (item: MaterialItem<P, L>) => number): this;
+    /**
+     * Return a new material instance which items are ordered based on provided selector functions.
+     * See {@link orderBy} from Lodash
+     *
+     * @param {...function} selectors The function or functions that evaluate each item's value
+     * @returns {this} New instance with items ordered by the selector functions
+     */
     sort(...selectors: ((item: MaterialItem<P, L>) => number)[]): this;
+    /**
+     * Return a new material instance with only the first N items.
+     * You have to use {@link sort} first as the items are ordered initially by index, which is not relevant.
+     * Example: material.sort(item => !item.location.x!).limit(10)
+     *
+     * @param count Number of items to keep
+     * @returns {this} New instance with only the first "count" items
+     */
     limit(count: number): this;
     private process;
+    /**
+     * Prepare a move that will create a new item
+     * @param {MaterialItem} item The item to create
+     * @returns {CreateItem} the move that creates an item when executed
+     */
     createItem(item: MaterialItem<P, L>): CreateItem<P, M, L>;
+    /**
+     * Prepare a list of moves to create new items
+     * @param {MaterialItem[]} items The items to create
+     * @returns {CreateItem[]} the moves that creates the new items when executed
+     */
     createItems(items: MaterialItem<P, L>[]): CreateItem<P, M, L>[];
+    /**
+     * Prepare one move to create new items
+     * @param {MaterialItem[]} items The items to create
+     * @returns {CreateItemsAtOnce} the move that creates the new items when executed
+     */
     createItemsAtOnce(items: MaterialItem<P, L>[]): CreateItemsAtOnce<P, M, L>;
+    /**
+     * Prepare a move that will delete current first item in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to remove. If undefined, the item is completely removed
+     * @returns {DeleteItem} the move that delete the item, or a part of its quantity, when executed
+     */
     deleteItem(quantity?: number): DeleteItem<M>;
+    /**
+     * Prepare moves that will delete all the items in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to remove. If undefined, the items are completely removed
+     * @returns {DeleteItem[]} the moves that delete the items, or a part of their quantity, when executed
+     */
     deleteItems(quantity?: number): DeleteItem<M>[];
+    /**
+     * Prepare one move that will delete all the items in this material instance
+     *
+     * @returns {DeleteItemsAtOnce} the move that delete the items when executed
+     */
     deleteItemsAtOnce(): DeleteItemsAtOnce<M>;
+    /**
+     * Prepare a move that will change the location of the current first item in this material instance
+     *
+     * @param {Location | function} location The new location of the item. It can be a function to process the location based on the item current state.
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to move. If undefined, the item is completely moved.
+     * @returns {MoveItem} the move that will change the location of the item (or a part of its quantity) when executed
+     */
     moveItem(location: ((item: MaterialItem<P, L>) => Location<P, L>) | Location<P, L>, quantity?: number): MoveItem<P, M, L>;
+    /**
+     * Prepare moves that will change the location of all the items in this material instance
+     *
+     * @param {Location | function} location The new location of the items. It can be a function to process the location based on each item current state.
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to move. If undefined, the items are completely moved.
+     * @returns {MoveItem[]} the moves that will change the location of the items (or a part of their quantity) when executed
+     */
     moveItems(location: ((item: MaterialItem<P, L>, index: number) => Partial<Location<P, L>>) | Partial<Location<P, L>>, quantity?: number): MoveItem<P, M, L>[];
+    /**
+     * Prepare one move that will change the location of all the items in this material instance
+     *
+     * @param {Location | function} location The new location of the items. It can be a function to process the location based on each item current state.
+     * @returns {MoveItemsAtOnce} the move that will change the location of the items when executed
+     */
     moveItemsAtOnce(location: Partial<Location<P, L>>): MoveItemsAtOnce<P, M, L>;
+    /**
+     * Prepare a move that will select current first item in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to select. If undefined, the item is completely selected.
+     * @returns {SelectItem} the move that will select the item (or a part of its quantity) when executed
+     */
     selectItem(quantity?: number): SelectItem<M>;
+    /**
+     * Prepare a move that will select all the items in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to select. If undefined, the items are completely selected.
+     * @returns {SelectItem[]} the moves that will select the items (or a part of their quantity) when executed
+     */
     selectItems(quantity?: number): SelectItem<M>[];
+    /**
+     * Prepare a move that will unselect current first item in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to unselect. If undefined, the item is completely unselected.
+     * @returns {SelectItem} the move that will unselect the item (or a part of its quantity) when executed
+     */
     unselectItem(quantity?: number): SelectItem<M>;
+    /**
+     * Prepare a move that will unselect all the items in this material instance
+     *
+     * @param {number | undefined} quantity Optional: for items with a quantity, the number of items to unselect. If undefined, the items are completely unselected.
+     * @returns {SelectItem[]} the moves that will unselect the items (or a part of their quantity) when executed
+     */
     unselectItems(quantity?: number): SelectItem<M>[];
+    /**
+     * Prepare a move that will rotate current first item in this material instance.
+     * This function creates a {@link MoveItem} but copies the existing location values, only replacing the rotation property.
+     *
+     * @param {string | number | boolean | Record | function | undefined} arg Value of the rotation to give to the item.
+     * In case of a function, process the value based on the item state.
+     * @returns {MoveItem} the move that will rotate the item when executed
+     */
     rotateItem<R extends string | number | boolean | Record<string, any> | undefined>(arg?: R | ((item: MaterialItem<P, L>) => R)): MoveItem<P, M, L>;
+    /**
+     * Prepare a move that will rotate all the items in this material instance.
+     * This function creates an array of {@link MoveItem} but copies the existing locations values, only replacing the rotation property.
+     *
+     * @param {string | number | boolean | Record | function | undefined} arg Value of the rotation to give to the item.
+     * In case of a function, process the value based on the item state.
+     * @returns {MoveItem[]} the moves that will rotate the item when executed
+     */
     rotateItems<R extends string | number | boolean | Record<string, any> | undefined>(arg?: R | ((item: MaterialItem<P, L>) => R | undefined)): MoveItem<P, M, L>[];
+    /**
+     * Prepare a move that will shuffle all the items in the current material instance
+     * @returns {Shuffle} the move that shuffle the items when executed
+     */
     shuffle(): Shuffle<M>;
+    /**
+     * Prepare a move that will roll the current first item in this material instance. See {@link RollItem}.
+     *
+     * @param {Location | function} location The new location of the item. It can be a function to process the location based on the item current state.
+     * @returns {RollItem} the move that rolls the item when executed
+     */
     rollItem(location?: ((item: MaterialItem<P, L>) => Location<P, L>) | Location<P, L>): RollItem<P, M, L>;
+    /**
+     * Prepare a move that will roll all the items in this material instance. See {@link RollItem}.
+     *
+     * @param {Location | function} location The new location of the items. It can be a function to process the location based on each item current state.
+     * @returns {RollItem[]} the moves that rolls the items when executed
+     */
     rollItems(location?: ((item: MaterialItem<P, L>) => Location<P, L>) | Location<P, L>): RollItem<P, M, L>[];
+    /**
+     * Return a new {@link MaterialDeck} helper class, to deal cards easily.
+     *
+     * @param selector The sort to apply on the deck. See {@link sort}. Defaults to -item.location.x
+     */
     deck(selector?: (item: MaterialItem<P, L>) => number): MaterialDeck<P, M, L>;
 }
 export {};