EquipmentAPI
Equip, unequip and read the items you wear.
ClassRLPlugins API
public class EquipmentAPIMembers
Static methods
- voidequip(EquipmentLoadout)
Equips a loadout.
- voidequip(String)
Equip an item by name.
- voidequip(int)
Equip an item by id.
- ItemExfromSlot(EquipmentSlot)
Get an equipped item in a specific slot.
- Map<String, List<String>>getActions(ItemEx)
A snapshot of available worn actions, with child actions under their matching parent.
- List<ItemEx>getAll()
Get all equipped items.
- intgetCount(int)
Get the count of a specific equipped item by id.
- ItemExgetItem(Predicate<ItemEx>)
Get an equipped item by predicate.
- ItemExgetItem(String)
Get an equipped item by name.
- ItemExgetItem(int)
Get an equipped item by id.
- booleanhasAction(ItemEx, String)
Whether this currently worn item exposes the named action, including its worn submenu.
- voidinteract(ItemEx, String)
Interact with an item in your inventory by action name.
- voidinteract(ItemEx, int)
Interact with an equipped item.
- booleanisEquipped(Predicate<ItemEx>)
Check if an item is equipped.
- booleanisEquipped(String)
Check if an item is equipped.
- booleanisEquipped(int)
Check if an item is equipped.
- voiditemAction(int, int)
Invoke an action on an equipped item.
- InventoryQuerysearch()
Creates an instance of InventoryQuery from equipment.
- voidunEquip(EquipmentSlot)
Unequip an item in a specific slot.
- voidunEquip(ItemEx)
Unequip an item.
- voidunequipAll()
Unequip all items.
equip(EquipmentLoadout)static
public static void equip(EquipmentLoadout loadout)Equips a loadout.
Parameters
loadout- The loadout to equip.
equip(String)static
public static void equip(String itemName)Equip an item by name.
Parameters
itemName- Item name.
equip(int)static
public static void equip(int itemId)Equip an item by id.
Parameters
itemId- Item id.
fromSlot(EquipmentSlot)static
public static ItemEx fromSlot(EquipmentSlot slot)Get an equipped item in a specific slot.
Parameters
slot- Slot.
Returns
ItemEx.
getActions(ItemEx)static
public static Map<String, List<String>> getActions(ItemEx item)A snapshot of available worn actions, with child actions under their matching parent.
Parameters
item- Item.
getAll()static
public static List<ItemEx> getAll()Get all equipped items.
Returns
List.
getCount(int)static
public static int getCount(int id)Get the count of a specific equipped item by id.
Parameters
id- Item id.
Returns
Int.
getItem(Predicate<ItemEx>)static
public static ItemEx getItem(Predicate<ItemEx> predicate)Get an equipped item by predicate.
Parameters
predicate- Predicate.
Returns
ItemEx.
getItem(String)static
public static ItemEx getItem(String itemName)Get an equipped item by name.
Parameters
itemName- Name.
Returns
ItemEx.
getItem(int)static
public static ItemEx getItem(int itemId)Get an equipped item by id.
Parameters
itemId- Item id.
Returns
ItemEx.
hasAction(ItemEx, String)static
public static boolean hasAction(ItemEx item, String action)Whether this currently worn item exposes the named action, including its worn submenu.
Parameters
item- Item.
action- Action.
interact(ItemEx, String)static
public static void interact(ItemEx item, String action)Interact with an item in your inventory by action name.
Parameters
item- Item.
action- Action name.
interact(ItemEx, int)static
public static void interact(ItemEx item, int action)Interact with an equipped item.
Parameters
item- Item.
action- Action.
isEquipped(Predicate<ItemEx>)static
public static boolean isEquipped(Predicate<ItemEx> predicate)Check if an item is equipped.
Parameters
predicate- Predicate.
Returns
Bool.
isEquipped(String)static
public static boolean isEquipped(String itemName)Check if an item is equipped.
Parameters
itemName- Item name.
Returns
Bool.
isEquipped(int)static
public static boolean isEquipped(int itemId)Check if an item is equipped.
Parameters
itemId- Item id.
Returns
Bool.
itemAction(int, int)static
public static void itemAction(int slot, int action)Invoke an action on an equipped item.
Parameters
slot- Slot.
action- Action.
search()static
public static InventoryQuery search()Creates an instance of InventoryQuery from equipment.
Returns
InventoryQuery.
unEquip(EquipmentSlot)static
public static void unEquip(EquipmentSlot slot)Unequip an item in a specific slot.
Parameters
slot- Slot.
unEquip(ItemEx)static
public static void unEquip(ItemEx item)Unequip an item.
Parameters
item- Item.
unequipAll()static
public static void unequipAll()Unequip all items.
Also allowed
Every class has these, as in plain Java.
equals, toString