api.inventory
Members
api.inventory.contains()
api.inventory.contains(query: ItemQuery, quantity?: number): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
|||
quantity |
number |
1 |
The minimum quantity required. |
Returns: boolean
Errors: never
api.inventory.equip()
api.inventory.equip(query: ItemQuery, options?: EquipOptions): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
|||
options |
EquipOptions |
Returns: boolean
Errors: never
api.inventory.equipByEnhancement()
api.inventory.equipByEnhancement(query: ScriptEquipEnhancementSelector, options?: EquipOptions): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ScriptEquipEnhancementSelector |
|||
options |
EquipOptions |
Returns: boolean
Errors: never
api.inventory.get()
api.inventory.get(query: ItemQuery): Effect.Effect<LiveItem | null>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
Returns: LiveItem | null
Errors: never
api.inventory.getAll()
api.inventory.getAll(): Effect.Effect<readonly LiveItem[]>Returns: readonly LiveItem[]
Errors: never
api.inventory.getAvailableSlots()
api.inventory.getAvailableSlots(): Effect.Effect<number>Returns: number
Errors: never
api.inventory.getSlots()
api.inventory.getSlots(): Effect.Effect<number>Returns: number
Errors: never
api.inventory.getUsedSlots()
api.inventory.getUsedSlots(): Effect.Effect<number>Returns: number
Errors: never
api.inventory.unequipConsumable()
api.inventory.unequipConsumable(query: ItemQuery): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
Returns: boolean
Errors: never
api.inventory.use()
Uses an eligible item directly from inventory, such as a Tonic, Elixir, or boost.
api.inventory.use(query: ItemQuery): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
Returns: boolean
Errors: never
api.inventory.wear()
api.inventory.wear(query: ItemQuery): Effect.Effect<boolean>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
query |
ItemQuery |
Returns: boolean
Errors: never