script-sdk/org.tribot.script.sdk/Inventory

Inventory

open class Inventory

Utilities for interacting with and inspecting the inventory

Constructors

Inventory

constructor()

Types

DropPattern

enum DropPattern

A pattern, or order, to drop items in

Functions

contains

open fun contains(id: Array<Int>): Boolean

Checks if any inventory item exists with any of the specified ids param id the item ids

open fun contains(name: Array<String>): Boolean

Checks if any inventory item exists with any of the specified names param name the item names

open fun contains(filter: Predicate<InventoryItem>): Boolean

Checks if any inventory item exists matching the specified filter param filter the item filter

drop

open fun drop(ids: Array<Int>): Int

Drops all items with the specified ids

open fun drop(names: Array<String>): Int

Drops all items with the specified names

open fun drop(items: List<out Item>): Int

Drops all items in the specified list

getAll

open fun getAll(): List<InventoryItem>

Gets all inventory items

getCount

open fun getCount(id: Array<Int>): Int

Sums the item stacks of all inventory items with the specified item ids

open fun getCount(name: Array<String>): Int

Sums the item stacks of all inventory items with the specified item names

open fun getCount(filter: Predicate<InventoryItem>): Int

Sums the item stacks of all inventory items matching the specified filter

getEmptySlots

open fun getEmptySlots(): Int

Gets the number of open inventory slots

getFilledSlots

open fun getFilledSlots(): Int

Gets the amount of filled inventory slots

getSelected

open fun getSelected(): Optional<InventoryItem>

Gets the selected inventory item, if an item is selected

isEmpty

open fun isEmpty(): Boolean

Checks if the inventory is completely empty

isFull

open fun isFull(): Boolean

Checks if the inventory is full

sort

open fun sort(ids: Array<Int>): Boolean

Sorts the inventory by ids in the order they are specified

open fun sort(names: Array<String>): Boolean

Sorts the inventory by names in the order they are specified

open fun sort(comparator: Comparator<InventoryItem>): Boolean

Sorts the inventory by the specified comparator

Inventory

See also

Constructors

Types

Functions