org.osbot.rs07.api

Class Equipment

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.util.ItemContainer

org.osbot.rs07.api.Equipment

public class Equipment
extends ItemContainer

Represents the API regarding equipment functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERFACE_CHILD_ID
static int	ITEM_CONTAINER_ID
static int	MAIN_INTERFACE_ROOT_ID
static int	SIZE

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Equipment()

Method Summary

Modifier and Type	Method and Description
boolean	equip(EquipmentSlot slot, Filter<Item> filter) Equips the first item returned by the specified filter into the specified slot.
boolean	equip(EquipmentSlot slot, int id) Equips an item with the specified item id in the specified slot.
boolean	equip(EquipmentSlot slot, java.lang.String name) Equips an item with the specified item name in the specified slot.
boolean	equip(int slot, java.lang.String action) Equips an item in the specified inventory slot with the specified action.
boolean	equipForNameThatContains(EquipmentSlot slot, java.lang.String... strings) Equips the first item found that contains any of the specified strings in to the specified slot.
int	getCapacity()
EquipmentSlot	getForNameThatContains(java.lang.String... strings) Gets the slot which contains an item which its name contains any of the specified strings.
int	getInterfaceChildId() Gets the interface child id that this item container represents.
int	getInterfaceId() Gets the interface id that this item container represents.
Item	getItemInSlot(int slot) Gets the item in the specified slot.
Item[]	getItems() Gets the array of items stored in this container in order.
EquipmentSlot	getSlotForItemIds(int... ids) Gets the slot which contains an item which its id equals any of the specified ids.
void	initializeModule()
boolean	interact(EquipmentSlot slot, java.lang.String... actions) Interacts with the slot specified.
boolean	interact(int slot, java.lang.String... actions) Interacts with the slot specified.
boolean	isWearingItem(EquipmentSlot slot) Checks if you are wearing an item in the specified equipment slot.
boolean	isWearingItem(EquipmentSlot slot, Filter<Item> filter) Checks if the specified slot contains any of the items returned by the filter.
boolean	isWearingItem(EquipmentSlot slot, int id) Checks if the specified slot contains an item with the specified item id.
boolean	isWearingItem(EquipmentSlot slot, Item item) Checks if the specified slot contains an item with the id of the specified item.
boolean	isWearingItem(EquipmentSlot slot, java.lang.String name) Checks if the specified slot contains an item with the specified item name.
boolean	isWearingItemThatContains(EquipmentSlot slot, java.lang.String... strings) Checks if the specified slot contains an items which its name contains any of the specified strings.
boolean	isWieldingWeapon(Filter<Item> filter) Checks if the weapon slot contains any of the items returned by the filter.
boolean	isWieldingWeapon(int id) Checks if the weapon slot contains an item with the specified item id.
boolean	isWieldingWeapon(java.lang.String name) Checks if the weapon slot contains an item with the specified item name.
boolean	isWieldingWeaponThatContains(java.lang.String... strings) Checks if the weapon slot contains an item which its name contains any of the specified strings.
boolean	openTab() Opens the equipment tab.
boolean	unequip(EquipmentSlot slot) Unequips the item found in the specified slot.
boolean	unequip(EquipmentSlot slot, Filter<Item> filter) Unequips the first item match returned by the filter that sits in the specified slot.
boolean	unequip(EquipmentSlot slot, int id) Unequips an item with the specified item id from the specified slot.
boolean	unequip(EquipmentSlot slot, java.lang.String name) Unequips an item with the specified item name from the specified slot.
boolean	unequip(Filter<Item> filter) Unequips the first item found by the filter.

Methods inherited from class org.osbot.rs07.api.util.ItemContainer

contains, contains, contains, contains, containsAll, containsAll, filter, getAmount, getAmount, getAmount, getEmptySlots, getItem, getItem, getItem, getSlot, getSlot, getSlot, getSlot, getSlot, getSlotForNameThatContains, hover, interact, interact, interact, interactWithNameThatContains, inverseFilter, isEmpty, isFull, onlyContains, onlyContains, onlyContains

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERFACE_CHILD_ID

public static final int INTERFACE_CHILD_ID

See Also:

Constant Field Values

ITEM_CONTAINER_ID

public static final int ITEM_CONTAINER_ID

See Also:

Constant Field Values

SIZE

public static final int SIZE

See Also:

Constant Field Values

MAIN_INTERFACE_ROOT_ID

public static final int MAIN_INTERFACE_ROOT_ID

See Also:

Constant Field Values

Constructor Detail

Equipment

public Equipment()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getInterfaceId

public int getInterfaceId()

Description copied from class: ItemContainer

Gets the interface id that this item container represents.

Specified by:

getInterfaceId in class ItemContainer

Returns:

The interface id that this item container represents.

getInterfaceChildId

public int getInterfaceChildId()

Description copied from class: ItemContainer

Gets the interface child id that this item container represents.

Specified by:

getInterfaceChildId in class ItemContainer

Returns:

The interface child id that this item container represents.

getCapacity

public int getCapacity()

Overrides:

getCapacity in class ItemContainer

Returns:

The capacity of the item container.

getItems

public Item[] getItems()

Gets the array of items stored in this container in order.

Specified by:

getItems in class ItemContainer

Returns:

the items.

isWearingItem

public boolean isWearingItem(EquipmentSlot slot)

Checks if you are wearing an item in the specified equipment slot.

Parameters:

slot - The specified slot.

Returns:

True if you are wearing an item in the specified equipment slot.

isWearingItem

public boolean isWearingItem(EquipmentSlot slot,
                             Filter<Item> filter)

Checks if the specified slot contains any of the items returned by the filter.

Parameters:

slot - The slot to check.

filter - The filter.

Returns:

True if any of the returned items by the filter are worn in the specified slot.

isWearingItem

public boolean isWearingItem(EquipmentSlot slot,
                             int id)

Checks if the specified slot contains an item with the specified item id.

Parameters:

slot - The slot to check.

id - The item id.

Returns:

True if the slot contains an item with the specified item id.

isWearingItem

public boolean isWearingItem(EquipmentSlot slot,
                             java.lang.String name)

Checks if the specified slot contains an item with the specified item name.

Parameters:

slot - The slot to check.

name - The item id.

Returns:

True if the slot contains an item with the specified name.

isWearingItem

public boolean isWearingItem(EquipmentSlot slot,
                             Item item)

Checks if the specified slot contains an item with the id of the specified item.

Parameters:

slot - The slot to check.

item - The item which its id to check for.

Returns:

True if the slot contains an item with the id of the specified item.

isWearingItemThatContains

public boolean isWearingItemThatContains(EquipmentSlot slot,
                                         java.lang.String... strings)

Checks if the specified slot contains an items which its name contains any of the specified strings.

Parameters:

slot - The slot to check.

strings - The strings to check the item for.

Returns:

True if the slot contains an item which its name contains any of specified strings.

isWieldingWeapon

public boolean isWieldingWeapon(Filter<Item> filter)

Checks if the weapon slot contains any of the items returned by the filter.

Parameters:

filter - The filter.

Returns:

True if the weapon slot contains any of the items returned by the filter.

isWieldingWeapon

public boolean isWieldingWeapon(int id)

Checks if the weapon slot contains an item with the specified item id.

Parameters:

id - The item id.

Returns:

True if the weapon slot contains an item with the specified item id.

isWieldingWeapon

public boolean isWieldingWeapon(java.lang.String name)

Checks if the weapon slot contains an item with the specified item name.

Parameters:

name - The item name.

Returns:

True if the weapon slot contains an item with the specified item name.

isWieldingWeaponThatContains

public boolean isWieldingWeaponThatContains(java.lang.String... strings)

Checks if the weapon slot contains an item which its name contains any of the specified strings.

Parameters:

strings - The string to check the name for.

Returns:

True if the weapon slot contains an item which contains any of the specified strings.

equip

public boolean equip(EquipmentSlot slot,
                     Filter<Item> filter)

Equips the first item returned by the specified filter into the specified slot.

Parameters:

slot - The slot the item should go in.

filter - The filter.

Returns:

True if the equipping event finished.

equip

public boolean equip(EquipmentSlot slot,
                     int id)

Equips an item with the specified item id in the specified slot.

Parameters:

slot - The slot the item should go in.

id - The id of the item to equip.

Returns:

True if the equipping event has finished.

equip

public boolean equip(EquipmentSlot slot,
                     java.lang.String name)

Equips an item with the specified item name in the specified slot.

Parameters:

slot - The slot the item should go in.

name - The name of the item to equip.

Returns:

True if the equipping event has finished.

equipForNameThatContains

public boolean equipForNameThatContains(EquipmentSlot slot,
                                        java.lang.String... strings)

Equips the first item found that contains any of the specified strings in to the specified slot.

Parameters:

slot - The slot the item should go in.

strings - The strings of which at least one needs to be contained in the item its name.

Returns:

True if the equipping event has finished.

equip

public boolean equip(int slot,
                     java.lang.String action)

Equips an item in the specified inventory slot with the specified action.

Parameters:

slot - The inventory slot.

action - The action.

Returns:

True if the equipping was successful.

unequip

public boolean unequip(Filter<Item> filter)

Unequips the first item found by the filter.

Parameters:

filter - The filter.

Returns:

True if the unequip was successful.

unequip

public boolean unequip(EquipmentSlot slot)

Unequips the item found in the specified slot.

Parameters:

slot - The equipment slot to unequip from.

Returns:

True if no item is left in the equipment slot.

unequip

public boolean unequip(EquipmentSlot slot,
                       Filter<Item> filter)

Unequips the first item match returned by the filter that sits in the specified slot.

Parameters:

slot - The slot.

filter - The filter.

Returns:

True if any item match by the filter was unequipped or no item was worn in the first place.

unequip

public boolean unequip(EquipmentSlot slot,
                       int id)

Unequips an item with the specified item id from the specified slot.

Parameters:

slot - The slot.

id - The item id to match.

Returns:

True if the no item was equipped or if the specified item was unequipped.

unequip

public boolean unequip(EquipmentSlot slot,
                       java.lang.String name)

Unequips an item with the specified item name from the specified slot.

Parameters:

slot - The slot.

name - The item name to match.

Returns:

True if the no item was equipped or if the specified item was unequipped.

getForNameThatContains

public EquipmentSlot getForNameThatContains(java.lang.String... strings)

Gets the slot which contains an item which its name contains any of the specified strings.

Parameters:

strings - The strings to match.

Returns:

The matched EquipmentSlot.

getSlotForItemIds

public EquipmentSlot getSlotForItemIds(int... ids)

Gets the slot which contains an item which its id equals any of the specified ids.

Parameters:

ids - The ids to match.

Returns:

The matched EquipmentSlot.

openTab

public boolean openTab()

Opens the equipment tab.

Returns:

True if the equipment tab is open after executing this method.

getItemInSlot

public Item getItemInSlot(int slot)

Gets the item in the specified slot.

Overrides:

getItemInSlot in class ItemContainer

Parameters:

slot - The slot to get the item from.

Returns:

The item in the specified slot.

interact

public boolean interact(int slot,
                        java.lang.String... actions)

Interacts with the slot specified.

Overrides:

interact in class ItemContainer

Parameters:

slot - The slot to interact with.

actions - The action to interact with.

Returns:

True if the bot interacted with the specified slot successfully.

interact

public boolean interact(EquipmentSlot slot,
                        java.lang.String... actions)

Interacts with the slot specified.

Parameters:

slot - The EquipmentSlot to interact with.

actions - The action to interact with.

Returns:

True if the bot interacted with the specified slot successfully.