Package com.wingman.defaultplugins.devutils.game

Class Inventory

java.lang.Object

com.wingman.defaultplugins.devutils.game.Inventory

public class Inventory
extends java.lang.Object

Provides API for getting data about the local player's inventory.

Constructor Summary

Constructors

Constructor	Description
Inventory()

Method Summary

Modifier and Type	Method	Description
static java.util.Optional<java.lang.Boolean>	containsItem(int itemId)
static java.util.Optional<java.lang.Integer>	countItem(int itemId)
static int	getCapacity()
static java.util.Optional<java.lang.Integer>	getFreeSpace()
static java.util.Optional<int[]>	getItemIds()
static java.util.Optional<int[]>	getItemQuantities()
static java.util.Optional<java.lang.Integer>	getUsedSpace()
static java.util.Optional<Widget>	getWidget()

Methods inherited from class java.lang.Object

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

Constructor Detail

Inventory

public Inventory()

Method Detail

getItemIds

public static java.util.Optional<int[]> getItemIds()

Returns:

an array containing item IDs for item slots, where an "item slot" is an array index; or nothing if the inventory can't be looked up

getItemQuantities

public static java.util.Optional<int[]> getItemQuantities()

Returns:

an array containing item quantities for item slots, where an "item slot" is an array index; or nothing if the inventory can't be looked up

containsItem

public static java.util.Optional<java.lang.Boolean> containsItem(int itemId)

Parameters:

itemId - the item ID of the item to lookup

Returns:

true if the item was successfully found in the inventory; false if it was not found; or nothing if the inventory can't be looked up

countItem

public static java.util.Optional<java.lang.Integer> countItem(int itemId)

Parameters:

itemId - the item ID of the item to count

Returns:

the amount of the item ID in the inventory; or nothing if the inventory can't be looked up

getUsedSpace

public static java.util.Optional<java.lang.Integer> getUsedSpace()

Returns:

the amount of slots that are occupied with an item; or nothing if the inventory can't be looked up

getFreeSpace

public static java.util.Optional<java.lang.Integer> getFreeSpace()

Returns:

the amount of slots that aren't occupied with an item; or nothing if the inventory can't be looked up

getCapacity

public static int getCapacity()

Returns:

the maximum capacity of the inventory

getWidget

public static java.util.Optional<Widget> getWidget()

Returns:

the inventory widget; or nothing if the widget couldn't be retrieved