org.osbot.rs07.api.util

Class ItemContainer

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.util.ItemContainer

Direct Known Subclasses:

Bank, DepositBox, Equipment, Inventory, Store, Trade.OurOffer, Trade.TheirOffer

public abstract class ItemContainer
extends API

Represents an item container such as the inventory, bank, shop, etc.

Field Summary

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
ItemContainer()

Method Summary

Modifier and Type	Method and Description
boolean	contains(Filter<Item>... filters) Determines whether or not this containers contains any of items specified by the filter(s).
boolean	contains(int... ids) Determines whether or not this container contains any of the specified ids.
boolean	contains(java.util.List<Item> items) Determines whether or not this containers contains any of the specified items.
boolean	contains(java.lang.String... names) Determines whether or not this container contains any of the specified names.
boolean	containsAll(int... ids) Checks whether or not this container contains all of the specified ids.
boolean	containsAll(java.lang.String... names) Checks whether or not this container contains all of the specified names.
java.util.List<Item>	filter(Filter<Item>... filters) Filters the item array with the specified filters.
long	getAmount(Filter<Item>... filters) Determines the amount of items of the container filtered by the specified filter(s).
long	getAmount(int... ids) Determines the amount of items of the specified ids are contained in this container.
long	getAmount(java.lang.String... names) Determines the amount of items of the specified ids are contained in this container.
int	getCapacity()
int	getEmptySlots()
abstract int	getInterfaceChildId() Gets the interface child id that this item container represents.
abstract int	getInterfaceId() Gets the interface id that this item container represents.
Item	getItem(Filter<Item>... filter) Gets the first item found after filtering the container with the specified filter.
Item	getItem(int... ids) Gets the first item with the specified ids
Item	getItem(java.lang.String... names) Gets the first item with the specified names
Item	getItemInSlot(int slot) Gets the item in the specified slot.
abstract Item[]	getItems() Gets the array of items stored in this container in order.
int	getSlot(Filter<Item>... filter) Gets the slot for the first item matched after filtering the container.
int	getSlot(int... ids) Gets the slot for the first item matched with the specified ids.
int	getSlot(Item item) Gets the slot for the specified item.
int	getSlot(java.util.List<Item> items) Gets the slot for the first item matched with the specified list.
int	getSlot(java.lang.String... names) Gets the slot for the first item matched with the specified ids.
int	getSlotForNameThatContains(java.lang.String... strings) Gets the slot for the first item matched that contains any of the given strings in its name.
boolean	hover(int slot) Hovers over the slot specified.
boolean	interact(int slot, java.lang.String... actions) Interacts with the slot specified.
boolean	interact(java.lang.String action, Filter<Item>... filter) Interacts with the first item matched.
boolean	interact(java.lang.String action, int... ids) Interacts with the first item matched.
boolean	interact(java.lang.String action, java.lang.String... names) Interacts with the first item matched.
boolean	interactWithNameThatContains(java.lang.String action, java.lang.String... strings) Interacts with an item that contains any of the specified strings in their name.
java.util.List<Item>	inverseFilter(Filter<Item>... filters) Filters out the item array removing the specified filters.
boolean	isEmpty() Determines if this container is empty.
boolean	isFull() Determines if this container is full.
boolean	onlyContains(Filter<Item>... filters) Determines whether this container only exists out of the items specified by the filters.
boolean	onlyContains(int... ids) Determines whether this container only exists out of the items specified.
boolean	onlyContains(java.lang.String... names) Determines whether this container only exists out of the items specified.

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

initializeModule

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

Constructor Detail

ItemContainer

public ItemContainer()

Method Detail

getInterfaceId

public abstract int getInterfaceId()

Gets the interface id that this item container represents.

Returns:

The interface id that this item container represents.

getInterfaceChildId

public abstract int getInterfaceChildId()

Gets the interface child id that this item container represents.

Returns:

The interface child id that this item container represents.

getItems

public abstract Item[] getItems()

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

Some entries may be null as place-markers.

Returns:

the items.

getCapacity

public int getCapacity()

Returns:

The capacity of the item container.

getEmptySlots

public int getEmptySlots()

Returns:

The remaining empty slots of the item container.

filter

public java.util.List<Item> filter(Filter<Item>... filters)

Filters the item array with the specified filters.

Parameters:

filters - The filters.

Returns:

A list of filtered items.

inverseFilter

@SafeVarargs
public final java.util.List<Item> inverseFilter(Filter<Item>... filters)

Filters out the item array removing the specified filters.

Parameters:

filters - The filters.

Returns:

A list of non-filtered items.

getItemInSlot

public Item getItemInSlot(int slot)

Gets the item in the specified slot.

Parameters:

slot - The slot to get the item from.

Returns:

The item in the specified slot.

getItem

@SafeVarargs
public final Item getItem(Filter<Item>... filter)

Gets the first item found after filtering the container with the specified filter.

Parameters:

filter - The filter(s).

Returns:

The first item matched.

getItem

public Item getItem(int... ids)

Gets the first item with the specified ids

Parameters:

ids - The ids to match.

Returns:

The first item matched.

getItem

public Item getItem(java.lang.String... names)

Gets the first item with the specified names

Parameters:

names - The names to match.

Returns:

The first item matched.

getSlot

@SafeVarargs
public final int getSlot(Filter<Item>... filter)

Gets the slot for the first item matched after filtering the container.

Parameters:

filter - The filter(s).

Returns:

The first slot matched.

getSlot

public int getSlot(int... ids)

Gets the slot for the first item matched with the specified ids.

Parameters:

ids - The ids to match.

Returns:

The first slot matched.

getSlot

public int getSlot(java.lang.String... names)

Gets the slot for the first item matched with the specified ids.

Parameters:

names - The names to match.

Returns:

The first slot matched.

getSlotForNameThatContains

public int getSlotForNameThatContains(java.lang.String... strings)

Gets the slot for the first item matched that contains any of the given strings in its name.

Parameters:

strings - The strings to match.

Returns:

The first slot matched.

getSlot

public int getSlot(java.util.List<Item> items)

Gets the slot for the first item matched with the specified list.

Parameters:

items - The items to match.

Returns:

The first slot matched.

getSlot

public int getSlot(Item item)

Gets the slot for the specified item.

Note: The item is matched based on id and amount only.

Parameters:

item - The item to match.

Returns:

The slot of the item. If no item is found, -1 is returned.

contains

@SafeVarargs
public final boolean contains(Filter<Item>... filters)

Determines whether or not this containers contains any of items specified by the filter(s).

Parameters:

filters - The filter(s).

Returns:

True if the container contains at least one item matched.

contains

public boolean contains(int... ids)

Determines whether or not this container contains any of the specified ids.

Parameters:

ids - The ids to match.

Returns:

True if the container contains at least one item matched.

contains

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

Determines whether or not this container contains any of the specified names.

Parameters:

names - The names to match.

Returns:

True if the container contains at least one item matched.

contains

public boolean contains(java.util.List<Item> items)

Determines whether or not this containers contains any of the specified items.

Parameters:

items - The items to match.

Returns:

True if the containers contains at least one item matched.

containsAll

public boolean containsAll(int... ids)

Checks whether or not this container contains all of the specified ids.

Parameters:

ids - The ids to match

Returns:

True if this container contains all of the specified ids.

containsAll

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

Checks whether or not this container contains all of the specified names.

Parameters:

names - The names to match

Returns:

True if this container contains all of the specified names.

isFull

public boolean isFull()

Determines if this container is full.

Returns:

True if full.

isEmpty

public boolean isEmpty()

Determines if this container is empty.

Returns:

True if empty.

getAmount

@SafeVarargs
public final long getAmount(Filter<Item>... filters)

Determines the amount of items of the container filtered by the specified filter(s).

Parameters:

filters - The filter(s).

Returns:

The amount of items.

getAmount

public long getAmount(int... ids)

Determines the amount of items of the specified ids are contained in this container.

Parameters:

ids - The ids to look for.

Returns:

The amount of items of the specified ids.

getAmount

public long getAmount(java.lang.String... names)

Determines the amount of items of the specified ids are contained in this container.

Parameters:

names - The names to look for.

Returns:

The amount of items of the specified ids.

onlyContains

@SafeVarargs
public final boolean onlyContains(Filter<Item>... filters)

Determines whether this container only exists out of the items specified by the filters. This method does not require that all the specified items exist, it determines whether there are no other items in the container. Note on the other hand if NONE of the items specified in the filters exists in the container false will be returned.

Parameters:

filters - The filter(s).

Returns:

True if the container only exists out of the specified items. False if NONE of the items exist, even when the container is empty.

onlyContains

public boolean onlyContains(int... ids)

Determines whether this container only exists out of the items specified. This method does not require that all the specified items exist, it determines whether there are no other items in the container. Note on the other hand if NONE of the items specified exists in the container false will be returned.

Parameters:

ids - The item ids.

Returns:

True if the container only exists out of the specified items. False if NONE of the items exist, even when the container is empty.

onlyContains

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

Determines whether this container only exists out of the items specified. This method does not require that all the specified items exist, it determines whether there are no other items in the container. Note on the other hand if NONE of the items specified exists in the container false will be returned.

Parameters:

names - The item names.

Returns:

True if the container only exists out of the specified items. False if NONE of the items exist, even when the container is empty.

interactWithNameThatContains

public boolean interactWithNameThatContains(java.lang.String action,
                                            java.lang.String... strings)

Interacts with an item that contains any of the specified strings in their name.

Parameters:

action - The action to interact with, null to allow any action.

strings - The strings to match with item names.

Returns:

True if this event was executed successfully.

interact

@SafeVarargs
public final boolean interact(java.lang.String action,
                                            Filter<Item>... filter)

Interacts with the first item matched.

Parameters:

action - The action to interact with.

filter - The filter to match items with.

Returns:

If this event was executed successfully.

interact

public boolean interact(java.lang.String action,
                        int... ids)

Interacts with the first item matched.

Parameters:

action - The action to interact with.

ids - The ids to match.

Returns:

If this event was executed successfully.

interact

public boolean interact(java.lang.String action,
                        java.lang.String... names)

Interacts with the first item matched.

Parameters:

action - The action to interact with.

names - The names to match.

Returns:

True if the bot interacted with the specified slot successfully.

interact

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

Interacts with the slot specified.

Parameters:

slot - The slot to interact with.

actions - The action to interact with.

Returns:

True if the bot interacted with the specified slot successfully.

hover

public boolean hover(int slot)

Hovers over the slot specified.

Parameters:

slot - The slot to hover over.

Returns:

True if the bot hovered over the specified slot successfully.