Inventory

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.Inventory

public class Inventory
extends ItemContainer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BANK_WIDGET_ID`
`static int`	`GRAND_EXCHANGE_WIDGET_ID`
`static int`	`INVENTORY_WIDGET_ID`
`static int`	`SHOP_WIDGET_ID`
`static int`	`SIZE`
`static int`	`TRADING_WIDGET_ID`

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

Inventory()

Constructors
Constructor and Description
`Inventory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`deselectItem()` Deselects an item if an item is selected by clicking on the inventory tab.
`boolean`	`drop(int... ids)` Drops the first item matched with the specified ids.
`boolean`	`drop(java.lang.String... names)` Drops the first item matched with the specified names.
`boolean`	`dropAll()` Drops all the items.
`boolean`	`dropAll(Filter<Item>... filters)` Drops all the items in the filters.
`boolean`	`dropAll(int... ids)` Drops all the items matched with the specified ids.
`boolean`	`dropAll(java.util.List<Item> items)` Drops all the items in the list.
`boolean`	`dropAll(java.lang.String... names)` Drops all the items matched with the specified ids.
`boolean`	`dropAllExcept(Filter<Item>... filters)` Drops all the items in the inventory excluding items within the filters passed.
`boolean`	`dropAllExcept(int... ids)` Drops all the items in the inventory excluding items with the ids passed.
`boolean`	`dropAllExcept(java.util.List<Item> items)` Drops all the items in the inventory excluding items in the list.
`boolean`	`dropAllExcept(java.lang.String... names)` Drops all the items in the inventory excluding items with the names passed.
`boolean`	`dropForFilter(Filter<Item>... filters)` Drops the first item matched by the filters.
`boolean`	`dropForNameThatContains(java.lang.String... names)` Drops the first item matched with the specified names.
`int`	`getCapacity()`
`int`	`getEmptySlotCount()` Deprecated. Use `ItemContainer.getEmptySlots()`
`int`	`getInterfaceChildId()` Gets the interface child id that this item container represents.
`int`	`getInterfaceId()` Gets the interface id that this item container represents.
`Item[]`	`getItems()` Gets the array of items stored in this container in order.
`MouseDestination`	`getMouseDestination(int slot)` Gets the mouse destination for the specified slot.
`int`	`getSelectedItemId()` Returns the id of the item selected.
`int`	`getSelectedItemIndex()` Returns the index of the item selected.
`java.lang.String`	`getSelectedItemName()` Returns the name of the item selected.
`java.awt.Rectangle`	`getSlotBoundingBox(int slot)` Gets the bounding box for the given item slot
`void`	`initializeModule()`
`boolean`	`isEmptyExcept(int... ids)` Checks if your inventory is empty, ignoring items that have an id from the list of ids.
`boolean`	`isEmptyExcept(java.lang.String... strings)` Checks if your inventory is empty, ignoring items that have a name from the list of strings.
`boolean`	`isItemSelected()` Returns whether an item in your inventory is selected.

Methods inherited from class org.osbot.rs07.api.util.ItemContainer
contains, contains, contains, contains, containsAll, containsAll, filter, getAmount, getAmount, getAmount, getEmptySlots, getItem, getItem, getItem, getItemInSlot, getSlot, getSlot, getSlot, getSlot, getSlot, getSlotForNameThatContains, hover, interact, 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
  - SIZE
```
public static final int SIZE
```
    See Also:
    
    Constant Field Values
  - INVENTORY_WIDGET_ID
```
public static final int INVENTORY_WIDGET_ID
```
    See Also:
    
    Constant Field Values
  - BANK_WIDGET_ID
```
public static final int BANK_WIDGET_ID
```
    See Also:
    
    Constant Field Values
  - TRADING_WIDGET_ID
```
public static final int TRADING_WIDGET_ID
```
    See Also:
    
    Constant Field Values
  - GRAND_EXCHANGE_WIDGET_ID
```
public static final int GRAND_EXCHANGE_WIDGET_ID
```
    See Also:
    
    Constant Field Values
  - SHOP_WIDGET_ID
```
public static final int SHOP_WIDGET_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Inventory
```
public Inventory()
```
- 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.
  - getMouseDestination
```
public MouseDestination getMouseDestination(int slot)
```
    Description copied from class: ItemContainer
    
    Gets the mouse destination for the specified slot.
    
    Parameters:
    
    slot - The slot.
    
    Returns:
    
    The mouse destination for the specified slot.
  - getCapacity
```
public int getCapacity()
```
    Overrides:
    
    getCapacity in class ItemContainer
    
    Returns:
    
    The capacity of the item container.
  - getItems
```
public Item[] getItems()
```
    Description copied from class: ItemContainer
    
    Gets the array of items stored in this container in order.
    Some entries may be null as place-markers.
    
    Specified by:
    
    getItems in class ItemContainer
    
    Returns:
    
    the items.
  - getEmptySlotCount
```
@Deprecated
public int getEmptySlotCount()
```
    Deprecated. Use ItemContainer.getEmptySlots()
  - drop
```
public boolean drop(int... ids)
```
    Drops the first item matched with the specified ids.
    
    Parameters:
    
    ids - The ids to match.
    
    Returns:
    
    Whether or not the action was successfully executed.
  - drop
```
public boolean drop(java.lang.String... names)
```
    Drops the first item matched with the specified names.
    
    Parameters:
    
    names - The names to match.
    
    Returns:
    
    Whether or not the action was successfully executed.
  - dropForNameThatContains
```
public boolean dropForNameThatContains(java.lang.String... names)
```
    Drops the first item matched with the specified names.
    
    Parameters:
    
    names - The names to match.
    
    Returns:
    
    Whether or not an item was successfully dropped.
  - dropForFilter
```
@SafeVarargs
public final boolean dropForFilter(Filter<Item>... filters)
```
    Drops the first item matched by the filters.
    
    Parameters:
    
    filters - The filters to find a match.
    
    Returns:
    
    Whether or not an item was successfully dropped.
  - dropAll
```
public boolean dropAll()
```
    Drops all the items.
    
    Returns:
    
    If this event was executed sucessfully.
  - dropAll
```
public boolean dropAll(int... ids)
```
    Drops all the items matched with the specified ids.
    
    Parameters:
    
    ids - The ids to match.
    
    Returns:
    
    If this event was executed successfully.
  - dropAll
```
public boolean dropAll(java.lang.String... names)
```
    Drops all the items matched with the specified ids.
    
    Parameters:
    
    names - The names to match.
    
    Returns:
    
    If this event was executed successfully.
  - dropAll
```
public boolean dropAll(java.util.List<Item> items)
```
    Drops all the items in the list.
    
    Parameters:
    
    items - The items to be dropped.
    
    Returns:
    
    True if the items were dropped successfully.
  - dropAll
```
@SafeVarargs
public final boolean dropAll(Filter<Item>... filters)
```
    Drops all the items in the filters.
    
    Parameters:
    
    filters - The filters.
    
    Returns:
    
    True if the items were dropped successfully.
  - dropAllExcept
```
public boolean dropAllExcept(int... ids)
```
    Drops all the items in the inventory excluding items with the ids passed.
    
    Parameters:
    
    ids - Item ids to ignore when dropping.
    
    Returns:
    
    True if the items were dropped successfully.
  - dropAllExcept
```
public boolean dropAllExcept(java.lang.String... names)
```
    Drops all the items in the inventory excluding items with the names passed.
    
    Parameters:
    
    names - Item names to ignore when dropping.
    
    Returns:
    
    True if the items were dropped successfully.
  - dropAllExcept
```
public boolean dropAllExcept(java.util.List<Item> items)
```
    Drops all the items in the inventory excluding items in the list.
    
    Parameters:
    
    items - The list.
    
    Returns:
    
    True if the items were dropped successfully.
  - dropAllExcept
```
@SafeVarargs
public final boolean dropAllExcept(Filter<Item>... filters)
```
    Drops all the items in the inventory excluding items within the filters passed.
    
    Parameters:
    
    filters - The filters.
    
    Returns:
    
    True if the items were dropped successfully.
  - isItemSelected
```
public boolean isItemSelected()
```
    Returns whether an item in your inventory is selected.
    
    Returns:
    
    True if an item in your inventory is selected.
  - getSelectedItemName
```
public java.lang.String getSelectedItemName()
```
    Returns the name of the item selected.
    
    Returns:
    
    null if no item is selected.
  - getSelectedItemIndex
```
public int getSelectedItemIndex()
```
    Returns the index of the item selected.
    
    Returns:
    
    -1 if no item is selected.
  - getSelectedItemId
```
public int getSelectedItemId()
```
    Returns the id of the item selected.
    
    Returns:
    
    -1 if no item is selected.
  - deselectItem
```
public boolean deselectItem()
```
    Deselects an item if an item is selected by clicking on the inventory tab.
  - isEmptyExcept
```
public boolean isEmptyExcept(java.lang.String... strings)
```
    Checks if your inventory is empty, ignoring items that have a name from the list of strings. This method is not case-sensitive.
    
    Parameters:
    
    strings - The strings you wish to ignore in determining if your inventory is empty.
    
    Returns:
    
    True if your inventory is empty.
  - isEmptyExcept
```
public boolean isEmptyExcept(int... ids)
```
    Checks if your inventory is empty, ignoring items that have an id from the list of ids.
    
    Parameters:
    
    ids - The ids you wish to ignore in determining if your inventory is empty.
    
    Returns:
    
    True if your inventory is empty.
  - getSlotBoundingBox
```
public java.awt.Rectangle getSlotBoundingBox(int slot)
```
    Gets the bounding box for the given item slot
    
    Parameters:
    
    slot - The slot to get the bounding box of
    
    Returns:
    
    The bounding box for the given item slot

Class Inventory

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

SIZE

INVENTORY_WIDGET_ID

BANK_WIDGET_ID

TRADING_WIDGET_ID

GRAND_EXCHANGE_WIDGET_ID

SHOP_WIDGET_ID

Constructor Detail

Inventory

Method Detail

initializeModule

getInterfaceId

getInterfaceChildId

getMouseDestination

getCapacity

getItems

getEmptySlotCount

drop

drop

dropForNameThatContains

dropForFilter

dropAll

dropAll

dropAll

dropAll

dropAll

dropAllExcept

dropAllExcept

dropAllExcept

dropAllExcept

isItemSelected

getSelectedItemName

getSelectedItemIndex

getSelectedItemId

deselectItem

isEmptyExcept

isEmptyExcept

getSlotBoundingBox