Field Detail

• SLOT_WIDTH

  public static final int SLOT_WIDTH

  See Also:

  Constant Field Values

• SLOT_HEIGHT

  public static final int SLOT_HEIGHT

  See Also:

  Constant Field Values

Method Detail

• getDropPattern

  public static DropPattern getDropPattern()

  Gets the dropping pattern for dropAll(Filter) Defaults to StandardDropPattern.LEFT_TO_RIGHT_THEN_DOWN

  Returns:

• setDropPattern

  public static void setDropPattern​(DropPattern dropPattern)

  Sets the dropping pattern for dropAll(Filter)

  Parameters:

  dropPattern - See StandardDropPattern for basic options or create your own

• widgetParentId

  public static int widgetParentId()

  Gets the basic inventory widget parent ID Basic meaning bank not open, GE not open, shop not open, etc

• widgetChildId

  public static int widgetChildId()

  Gets the basic inventory widget child ID Basic meaning bank not open, ge not open, shop not open, etc

• capacity

  public static int capacity()

  Returns the capacity of your inventory (28)

• getInventoryWidget

  public static WidgetChild getInventoryWidget()

  Gets the basic inventory widget Basic meaning bank not open, ge not open, shop not open, etc

• all

  public static java.util.List<Item> all()

  Gets the items in your inventory

  Returns:

  list of all items in your inventory.

• isLoaded

  public static boolean isLoaded()

  Checks if the Inventory Item Table has been successfully loaded within the client through our all() call

• slotInteract

  public static boolean slotInteract​(int slot,
                                     java.lang.String action)

  Interacts with specified slot in inventory

  Parameters:

  slot - Slot to interact with

  action - Action to use in interacting

  Returns:

  True if interaction was successful, else False

• slotInteract

  public static boolean slotInteract​(int slot)

  Interacts with specified slot in inventory using the first available action

  Parameters:

  slot - Slot to interact with

  Returns:

  True if interaction was successful, else False

• deselect

  public static boolean deselect()

  Deselects any item if it is selected

  Returns:

  True if succeeded

• interact

  public static boolean interact​(int id,
                                 java.lang.String action)

  Interact with an Item with specified ID in inventory

  Parameters:

  id - Item ID to interact with

  action - Action to use in interacting

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(int id)

  Interact with an Item with specified ID in inventory using the first available action

  Parameters:

  id - Item ID to interact with

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(Filter<Item> filter,
                                 java.lang.String action)

  Interact with an Item with specified ID in inventory

  Parameters:

  filter - Item ID to interact with

  action - Action to use in interacting

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(Filter<Item> filter)

  Interact with an Item with specified ID in inventory using the first available action

  Parameters:

  filter - Item ID to interact with

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(java.lang.String name,
                                 java.lang.String action)

  Interact with the Item with specified name in Inventory

  Parameters:

  name - Name of item to interact with

  action - Action to use in interacting

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(java.lang.String name)

  Interact with the Item with specified name in Inventory using the first available action

  Parameters:

  name - Name of item to interact with

  Returns:

  True if interaction was successful, else False

• interact

  public static boolean interact​(Item item,
                                 java.lang.String action)

  Interacts with a given Item with a specified action If Item has an invalid slot value, it will find slot based on item id

  Parameters:

  item - Item to interact with

  action - action to interact with

  Returns:

  false if item is null, else see slotInteract(int, String)

• interact

  public static boolean interact​(Item item)

  Interacts with a given Item with a specified action using the first available action If Item has an invalid slot value, it will find slot based on item id

  Parameters:

  item - Item to interact with

  Returns:

  false if item is null, else see slotInteract(int, String)

• drop

  public static boolean drop​(int id)

  Drops the item with specified ID from inventory

  Parameters:

  id - ID of item to drop

  Returns:

  True if interaction was successful, else False

• drop

  public static boolean drop​(java.lang.String name)

  Drops the item with specified name from Inventory

  Parameters:

  name - Name of item to drop

  Returns:

  True if interaction was successful, else False

• drop

  public static boolean drop​(Filter<Item> filter)

  Drops the item matching specified Filter from Inventory

  Parameters:

  filter -

  Returns:

• dropAll

  public static boolean dropAll()

  Drops all items in your inventory.

  Returns:

  true if all items were dropped

• dropAll

  public static boolean dropAll​(int id)

  Drops all items in your inventory matching specified ID

  Parameters:

  id - Id of item to drop all of

  Returns:

  true if all items matching the id were dropped

• dropAll

  public static boolean dropAll​(java.lang.String name)

  Drops all items in your inventory matching specified name

  Parameters:

  name - name of item to drop all of.

  Returns:

  is all of item matching description was dropped.

• dropAll

  public static boolean dropAll​(java.lang.Integer... ids)

  Drops all items in your inventory matching specified id's

  Parameters:

  ids - id's of items you want to drop all of.

  Returns:

  returns contains(ids);

• dropAll

  public static boolean dropAll​(int[] ids)

  see dropAll(Integer...)

• dropAll

  public static boolean dropAll​(java.lang.String... names)

  Drops all items in your inventory matching specified names.

  Parameters:

  names - names of items you want to drop all of

  Returns:

  returns contains(names)

• dropAll

  public static boolean dropAll​(Filter<Item> filter)

  Drops all items in your inventory matching the specified filter

  Parameters:

  filter - Filter to match any items you want to drop all of

  Returns:

  returns contains(filter)

• dropAllExcept

  public static boolean dropAllExcept​(java.lang.String... names)

  Drops all items that don't match the given names

  Parameters:

  names - Names of items to not drop

• dropAllExcept

  public static boolean dropAllExcept​(java.lang.Integer... ids)

  Drops all items that don't match the given ID's

  Parameters:

  ids - IDs to not drop

• dropAllExcept

  public static boolean dropAllExcept​(int[] ids)

  see dropAllExcept(Integer...)

• dropAllExcept

  public static boolean dropAllExcept​(Filter<Item> filter)

  Drops all items that are not filtered.

  Parameters:

  filter - the filter which excludes items from dropping.

• itemBounds

  public static java.awt.Rectangle itemBounds​(Item item)

  Gets the slot bounds of an item.

  Parameters:

  item - Item to get bounds of.

  Returns:

  Rectangle of Item slot.

• slotBounds

  public static java.awt.Rectangle slotBounds​(int slot)

  Gets the bounds of a slot

  Parameters:

  slot - Slot to get bounds of

  Returns:

  Rectangle of the slot

• isItemSelected

  public static boolean isItemSelected()

  Checks whether an item is currently selected in your inventory

  Returns:

  True if an item is selected, else false

• getSelectedItemName

  public static java.lang.String getSelectedItemName()

  Gets the currently selected item name

  Returns:

  currently selected item name if no item name selected then null

• getSelectedItemIndex

  public static int getSelectedItemIndex()

  Gets the index of the currently selected item.

  Returns:

  Integer value of currently selected item index, or if no item selected -1

• getSelectedItemId

  public static int getSelectedItemId()

  Gets the ID of the currently selected item.

  Returns:

  ID of the currently selected item, or if no item selected -1

• setSelectedWidgetItemId

  public static void setSelectedWidgetItemId​(int id)

• getEmptySlots

  public static int getEmptySlots()

  Gets the count of empty slots in your inventory

  Returns:

  number of empty slots in your inventory

• getRandom

  public static Item getRandom​(java.lang.String... itemNames)

  Gets a random item that matches the item name(s) in your inventory

  Parameters:

  itemNames - Name(s) of the item(s)

  Returns:

  Random Item that matches

• getRandom

  public static Item getRandom​(int... itemIDs)

  Gets a random item that matches the item id(s) in your inventory

  Parameters:

  itemIDs - ID(s) of the item(s)

  Returns:

  Random Item that matches

• getRandom

  public static Item getRandom​(Filter<Item> itemFilter)

  Gets a random item that matches the item filter in your inventory

  Parameters:

  itemFilter - Filter for the item you want to get

  Returns:

  Random item that matches the filter

• isForceNoShift

  public static boolean isForceNoShift()

  Forces the inventory to ignore whether shift interactions are enabled or not

• setForceNoShift

  public static void setForceNoShift​(boolean forceNoShift)

  Sets inventory to force no shift during dropping

• shouldShift

  public static boolean shouldShift()

  Checks whether shift needs to be pressed for shift interactions Only implemented for dropping purposes

  Returns:

  !isForceNoShift() && ClientSettings.isShiftClickDroppingEnabled() ()} && !Keyboard.isHeld(Key)} with Key.SHIFT

• fullSlotCount

  public static int fullSlotCount()

  Full slot count.

  Returns:

  the count of full slots as a int.

• emptySlotCount

  public static int emptySlotCount()

  Empty slot count.

  Returns:

  the count of empty slots as a int.

• isSlotEmpty

  public static boolean isSlotEmpty​(int slot)

  Checks if the given slot has an item in it or not

  Parameters:

  slot - slot to check (0-27)

  Returns:

  True if there is no item in the slot, else false

• isSlotFull

  public static boolean isSlotFull​(int slot)

  Checks if the slot has an Item in it

  Parameters:

  slot - slot to check

  Returns:

  True if there's an item there, else False

• onlyContains

  public static boolean onlyContains​(java.lang.String... names)

  Checks if your Inventory only contains items with specified name

  Parameters:

  names - Names of items to look for

  Returns:

  True if Inventory only contains items with that name, else False

• onlyContains

  public static boolean onlyContains​(java.lang.Integer... id)

  Checks if your Inventory only contains items with specified ID

  Parameters:

  id - IDs of items to check for

  Returns:

  True if Inventory only contains items with specified ID, else False

• onlyContains

  public static boolean onlyContains​(int[] id)

  see onlyContains(Integer...)

• onlyContains

  public static boolean onlyContains​(Filter<Item> f)

  Checks if your Inventory only contains items that match the Filter

  Parameters:

  f - Filter to pass items through

  Returns:

  True if Inventory only contains items matching Filter, else False, also returns False if Inventory is empty

• slotContains

  public static boolean slotContains​(int slot,
                                     java.lang.String... names)

  Checks if the slot contains items that matches the given names.

  Parameters:

  names - names of the items to check

  Returns:

  true if Inventory only contains items matching Filter, else false

• slotNameContains

  public static boolean slotNameContains​(int slot,
                                         java.lang.String sub)

  Checks if the slot contains items that matches the given ids.

  Parameters:

  sub - the substring which will be used to search.

  Returns:

  True if Inventory only contains items matching Filter, else false.

• slotContains

  public static boolean slotContains​(int slot,
                                     java.lang.Integer... ids)

  Checks if the slot contains items that matches the given ids.

  Parameters:

  ids - ids of the items to check.

  Returns:

  True if Inventory only contains items matching Filter, else false.

• slotContains

  public static boolean slotContains​(int slot,
                                     int[] ids)

  see slotContains(int, Integer...)

• slotContains

  public static boolean slotContains​(int slot,
                                     Item t)

  Checks if the slot contains items that matches the given ids.

  Parameters:

  t - The object to check.

  Returns:

  True if Inventory only contains items matching Filter, else false.

• slotContains

  public static boolean slotContains​(int slot,
                                     Filter<Item> filter)

  Checks if the slot contains items that matches the filter.

  Parameters:

  filter - Filter to pass items through.

  Returns:

  True if Inventory only contains items matching Filter, else false.

• getFirstEmptySlot

  public static int getFirstEmptySlot()

  Gets the first empty slot in your inventory.

  Returns:

  slot number, if inventory is full -1.

• getFirstFullSlot

  public static int getFirstFullSlot()

  Gets the next full slot in your inventory

  Returns:

  slot number, if inventory is empty -1

• getIdForSlot

  public static int getIdForSlot​(int slot)

  Gets the Id of the Item in the slot.

  Parameters:

  slot - Slot to get item id of.

  Returns:

  Item ID or -1 if no item.

• getNameForSlot

  public static java.lang.String getNameForSlot​(int slot)

  Gets the Name for the Item in the slot.

  Parameters:

  slot - Slot to get item name of.

  Returns:

  Item name or "" if item is null.

• slot

  public static int slot​(int id)

  Gets the slot for the item with specified ID.

  Parameters:

  id - ID of item to get slot of.

  Returns:

  Item slot or -1 if Item is null.

• slot

  public static int slot​(java.lang.String name)

  Gets the slot for the item with specified name.

  Parameters:

  name - Name of item to get slot of.

  Returns:

  Item slot or -1 if Item is null.

• slot

  public static int slot​(Filter<Item> filter)

  Gets the slot for the item with specified name.

  Parameters:

  filter - filter of the item to get slot of.

  Returns:

  Item slot or -1 if Item is null.

• add

  public static boolean add​(Item t)

  Adds an item manually to the Inventory collection Not recommended unless you know what you're doing.

• toArray

  public static Item[] toArray()

  Converts all() to an Item array

• add

  public static void add​(int index,
                         Item t)

  Adds an item manually to the inventory collection at the given index Not recommended unless you know what you're doing

• all

  public static java.util.List<Item> all​(Filter<Item> filter)

  A list of all the items.

  Parameters:

  filter - the filter to search with.

  Returns:

  the list of all filtered items.

• getItemInSlot

  public static Item getItemInSlot​(int index)

  Gets item in specified slot.

  Parameters:

  index - the index.

  Returns:

  the item in slot.

• get

  public static Item get​(int id)

  Gets the first item that matches the given item ID

  Parameters:

  id - item ID to get

  Returns:

  First item that matches the given item ID, else null

• get

  public static Item get​(java.lang.Integer... ids)

  Gets the first item that matches one of the given IDs

  Parameters:

  ids - Integer varargs for ID's to look for

  Returns:

  the first item that matches any of the given ID's

• get

  public static Item get​(int[] ids)

• get

  public static Item get​(java.lang.String name)

  Get item for specified name.

  Parameters:

  name - the name of the item.

  Returns:

  the item if list contains it, otherwise null.

• get

  public static Item get​(java.lang.String... names)

• get

  public static Item get​(Filter<Item> filter)

• except

  public static java.util.List<Item> except​(Filter<Item> filter)

  Get all items which do not fit the given criteria.

  Parameters:

  filter - The filter of the items to ignore.

  Returns:

  The list of items found which do not match the given criteria.

• size

  public static int size()

• isEmpty

  public static boolean isEmpty()

• contains

  public static boolean contains​(int id)

  Contains boolean.

  Parameters:

  id - the id

  Returns:

  the boolean

• contains

  public static boolean contains​(java.lang.String string)

  Determines if collection contains item with specified name.

  Parameters:

  string - the name of the item.

  Returns:

  true if collection contains item, otherwise false.

• containsAll

  public static boolean containsAll​(java.lang.String... names)

  Checks if your Inventory contains all of the items with names specified

  Parameters:

  names - Names of items to check for

  Returns:

  True if Inventory contains all names, else False

• containsAll

  public static boolean containsAll​(int... ids)

  Checks if your Inventory contains all of the items with specified IDs

  Parameters:

  ids - IDs of items to check for

  Returns:

  True if Inventory contains all IDs, else false.

• containsAll

  public static boolean containsAll​(java.util.Collection<?> collection)

  Checks if your collection contains all of the items in the collections

  Parameters:

  collection - The collection of items to compare against

  Returns:

  True if inventory contains all of the items, else false.

• contains

  public static boolean contains​(java.lang.Integer... ids)

  Checks if your collection contains one item which meets one of the specified ids.

  Parameters:

  ids - Item IDs to check for

  Returns:

  True if contains one of, else false

• contains

  public static boolean contains​(int[] ids)

• contains

  public static boolean contains​(java.lang.String... names)

  Checks if your collection contains one item which meets one of the specified names.

  Parameters:

  names - names to check for

  Returns:

  true if contains one of, else false.

• contains

  public static boolean contains​(Filter<Item> filter)

  Checks if your collection contains one item which meets the specified filter.

  Parameters:

  filter - the filter to search with.

  Returns:

  true if contains one of, else false.

• contains

  public static boolean contains​(java.lang.Object o)

• isFull

  public static boolean isFull()

  Determines if container full.

  Returns:

  the boolean

• count

  public static int count​(java.lang.String name)

  Count of all the items that match the search.

  Parameters:

  name - the name of the item.

  Returns:

  the total count of matching items.

• count

  public static int count​(int id)

  Count of all the items that match the search.

  Parameters:

  id - the id of them item.

  Returns:

  the total count of matching items.

• count

  public static int count​(Filter<Item> filter)

  Count of all the items that match the search.

  Parameters:

  filter - the filter to count with

  Returns:

  the total count of matching items.

• set

  public static Item set​(int index,
                         Item element)

• getWidgetForSlot

  public static WidgetChild getWidgetForSlot​(int slot)

• getWidgetForSlot

  public static WidgetChild getWidgetForSlot​(int slot,
                                             java.lang.String action)

• isOpen

  public static boolean isOpen()

• open

  public static boolean open()

• use

  public static boolean use​(int id)

• use

  public static boolean use​(java.lang.String name)

• use

  public static boolean use​(Item item)

• combine

  public static boolean combine​(java.lang.String primaryItemName,
                                java.lang.String secondaryItemName)

• combine

  public static boolean combine​(int primaryItemId,
                                int secondaryItemId)

• combine

  public static boolean combine​(Item primary,
                                Item secondary)

• drag

  public static boolean drag​(Filter<Item> itemFilter,
                             int toSlot)

  This will move the first matching item in the inventory to the provided slot. This will only move the first found item in the inventory, if you want to move a specific item to the slot, see swap(int, int) instead.

  Parameters:

  itemFilter - the item filter to be used to find a matching inventory item

  toSlot - the slot where the item should end up

  Returns:

  true if we move the item successfully or if it's already there

• drag

  public static boolean drag​(java.lang.String itemName,
                             int toSlot)

  This will move the first matching item in the inventory to the provided slot. This will only move the first found item in the inventory, if you want to move a specific item to the slot, see swap(int, int) instead.

  Parameters:

  itemName - the item name to be moved

  toSlot - the slot where the item should end up

  Returns:

  true if we move the item successfully or if it's already there

• drag

  public static boolean drag​(int itemId,
                             int toSlot)

  This will move the first matching item in the inventory to the provided slot. This will only move the first found item in the inventory, if you want to move a specific item to the slot, see swap(int, int) instead.

  Parameters:

  itemId - the item id to be moved

  toSlot - the slot where the item should end up

  Returns:

  true if we move the item successfully or if it's already there

• drag

  public static boolean drag​(Item item,
                             int toSlot)

  This will move the first matching item in the inventory to the provided slot. This will only move the first found item in the inventory, if you want to move a specific item to the slot, see swap(int, int) instead.

  Parameters:

  item - the item to be moved

  toSlot - the slot where the item should end up

  Returns:

  true if we move the item successfully or if it's already there

• swap

  public static boolean swap​(Item firstItem,
                             Item secondItem)

  Swaps the first of each item given if found, if you want to swap specific slots use swap(int, int) instead

  Parameters:

  firstItem - the first item

  secondItem - the second item

  Returns:

  true if both items are found, aren't the same, and are successfully swapped

• swap

  public static boolean swap​(int fromSlot,
                             int toSlot)

  Swaps the contents of two inventory slots, either of which can be empty to simply move an item from one to the other

  Parameters:

  fromSlot - the start inventory slot

  toSlot - the end inventory slot

  Returns:

  true if the items are swapped successfully or if both slots are the same, false otherwise

• getActionsForSlot

  public static java.lang.String[] getActionsForSlot​(int slot)