lol-constants/dist/helpers/item.d.ts

League of Legends constants, functions, and types. Provides a plathera of functions to easily convert between ID, Name, and Key for champions, items, summoner spells, and runes.

import { ItemId, ItemName, Items, ItemsArr } from '../objects/generated/Items';
import { MapId } from '../objects/Maps';
/**
 * Get an item by its **id** or **name**.
 *
 * Item categorization is focused on Summoner's Rift. Item's `srType` field denotes:
 * - `0`: Starter items (Summoner's Rift)
 * - `1`: Basic items (Summoner's Rift)
 * - `2`: Epic items (Summoner's Rift)
 * - `3`: Legendary items (Summoner's Rift)
 * - `11`: Trinkets (Summoner's Rift)
 * - `12`: Boots (Summoner's Rift)
 * - `13`: Consumables (Summoner's Rift)
 * - `-1`: Misc. & Uncategorized (Summoner's Rift & other maps)
 *
 * ---
 * Second argument `mapId` only applies to getting an item by its **name**:
 *
 * Since there can be duplicate item names intended for different maps,
 * `mapId` denotes which map should be prioritized.
 * Function may still return an item for a provided `itemName`
 * even if it does not match the provided `mapId`.
 *
 * Defaults to `11` (Summoner's Rift).
 *
 * Use `lol.item.isAvailable` to determine whether item is available on a certain map.
 */
export declare function getItem(id_name: ItemId | ItemName, mapId?: MapId): typeof Items[keyof typeof Items];
export declare function isStarterItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isBasicItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isEpicItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isLegendaryItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isTrinketItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isBootsItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
export declare function isConsumableItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName | 0): boolean;
/** Check whether item is available on a certain map. */
export declare function isItemAvailableOnMap(itemId: ItemId, mapId: MapId): boolean;
export declare function isItemId(id: number | null | undefined): id is ItemId;
export declare function isItemName(name: string | null | undefined): name is ItemName;