Inventory
constInventory:object
Type Declaration
Section titled “Type Declaration”contains
Section titled “contains”contains: (
query,quantity?) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”quantity?
Section titled “quantity?”number
Returns
Section titled “Returns”Effect<boolean, never, never>
equip: (
query,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”options?
Section titled “options?”EquipOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
equipByEnhancement
Section titled “equipByEnhancement”equipByEnhancement: (
selector,options) =>Effect<boolean,never,never>
Equips the highest-level item already carrying the enhancement. A bare "forge" needs slot or
special, since every Forge slot shares it.
Parameters
Section titled “Parameters”selector
Section titled “selector”options?
Section titled “options?”EquipOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
getAvailableSlots
Section titled “getAvailableSlots”getAvailableSlots: (
pool) =>Effect<number,never,never>
Parameters
Section titled “Parameters”InventoryPool = "bag"
Returns
Section titled “Returns”Effect<number, never, never>
getItem
Section titled “getItem”getItem: (
query) =>Effect<Item|null,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<Item | null, never, never>
getItems
Section titled “getItems”getItems: () =>
Effect<readonlyItem[],never,never>
Returns
Section titled “Returns”Effect<readonly Item[], never, never>
getQuantity
Section titled “getQuantity”getQuantity: (
query) =>Effect<number,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<number, never, never>
getSlots
Section titled “getSlots”getSlots: () =>
Effect<number,never,never>
Each pool has this many slots.
Returns
Section titled “Returns”Effect<number, never, never>
getUsedSlots
Section titled “getUsedSlots”getUsedSlots: (
pool) =>Effect<number,never,never>
Parameters
Section titled “Parameters”InventoryPool = "bag"
Returns
Section titled “Returns”Effect<number, never, never>
isEquipped
Section titled “isEquipped”isEquipped: (
query) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<boolean, never, never>
unequip
Section titled “unequip”unequip: (
query) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<boolean, never, never>
use: (
query) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<boolean, never, never>
wear: (
query) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<boolean, never, never>