Module use

These functions help in retrieving information if you can use an item or not.

Use functions are the profile API table `use` (br.api.profile.use); profiles use it by name. For item use, `item` in the function represent the name in the items list defined in System/List/Items.lua An item list entry may be a table of ranks: the best one held is used. use.able.() says whether the item is ready. use.() also waits while the player casts or channels, like cast.(); use..whileCasting() (and use.slot.whileCasting(13), ...) uses it anyway, for items the game allows during a cast.

Functions

use.able.item (itemID) Checks if item is usable or not.
use.able.slot (slotID) Checks if item in the specified equipment slot is usable or not.
item (itemID[, thisUnit="target"]) Uses the item.
slot (slotID[, thisUnit="target"]) Uses the item in the specified equipment slot.
able. ([slotID]) Checks if item is usable or not.
use. ([slotID[, thisUnit="target"]]) Uses the item.


Functions

use.able.item (itemID)
Checks if item is usable or not. Note: `item` here is literally item, you pass the itemID to specify the item

Parameters:

  • itemID number The ID of the item check.

Returns:

    boolean
use.able.slot (slotID)
Checks if item in the specified equipment slot is usable or not.

Parameters:

  • slotID number The ID of the equipment slot to check.

Returns:

    boolean
item (itemID[, thisUnit="target"])
Uses the item. Note: `item` here is literally item, you pass the itemID to specify the item

Parameters:

  • itemID number The ID of the item to use.
  • thisUnit string The unit to use the item on. (default "target")

Returns:

    boolean
slot (slotID[, thisUnit="target"])
Uses the item in the specified equipment slot.

Parameters:

  • slotID number The ID of the equipment slot to use the item from.
  • thisUnit string The unit to use the item on. (default "target")

Returns:

    boolean
able. ([slotID])
Checks if item is usable or not. Note: `item` here refers to the name in the item list defined in System/List/Items.lua

Parameters:

  • slotID number The ID of the equipment slot to check. (optional)

Returns:

    boolean
use. ([slotID[, thisUnit="target"]])
Uses the item.

Parameters:

  • slotID number The equipment slot number to use the item from. (optional)
  • thisUnit string The unit to use the item on. (default "target")

Returns:

    boolean
generated by LDoc 1.5.0 Last updated 2026-11-16 01:18:17