Module br.player.equiped
These functions help in retrieving information about equiped items.
Equiped Item functions are stored in br.player.equiped and can be utilized by `local equiped = br.player.equiped` in your profile. `item` in the function represent the name in the item list defined in System/List/Items.lua
Functions
| equiped.item ([slotID]) | Checks if item is equiped or not. |
| equiped.item (itemID, slotID) | This function checks if the specified itemID is equipped or not. |
| equiped.item.socket (gemID) | Checks if the specified `gemID` is equiped in the item's socket or not. |
| equiped.tier (tierLevel) | Gets the number of equiped items for the specified `tierLevel`. |
| equiped.type (itemType) | Checks if you have the specified `itemType` equiped or not. |
Functions
- equiped.item ([slotID])
-
Checks if item is equiped or not.
Parameters:
- slotID number The equipment slot number to check. (optional)
Returns:
-
boolean
- equiped.item (itemID, slotID)
-
This function checks if the specified itemID is equipped or not.
It can also check a specific slotID.
If no slotID is provided, it checks all slots for that item.
Parameters:
- itemID the ID of the item you want to check if it's equipped
- slotID optional parameter. If specified, it represents the ID of the slot you want to check for the existence of the given item.
Returns:
-
boolean value indicating whether the item with specific ID is equipped in the specified slot (if provided)
Usage:
equipes.item(12345) -- will return true if item with ID 12345 is equipped anywhere
equipes.item(12345, 1) -- will return true if item with ID 12345 is equipped in slot 1
- equiped.item.socket (gemID)
-
Checks if the specified `gemID` is equiped in the item's socket or not.
Parameters:
- gemID number The ID of the gem to check for.
Returns:
-
boolean
- equiped.tier (tierLevel)
-
Gets the number of equiped items for the specified `tierLevel`.
Parameters:
- tierLevel string|number The tier level to check for. (e.g. "T20" or 20)
Returns:
-
number
- equiped.type (itemType)
-
Checks if you have the specified `itemType` equiped or not.
Parameters:
- itemType string The type of item to check for. (e.g. "Weapon" or "Trinket")
Returns:
-
boolean