org.cloudburstmc.api.inventory

Interface Inventory

All Known Subinterfaces:

AnvilInventory, BarrelInventory, BeaconInventory, BrewingInventory, ChestInventory, ContainerInventory, CraftingGrid, CreatureInventory, EnchantInventory, FurnaceInventory, HopperInventory, PlayerInventory, ShulkerBoxInventory

public interface Inventory

author: MagicDroidX Nukkit Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_STACK

Method Summary

Modifier and Type	Method and Description
ItemStack[]	addItem(ItemStack... slots)
Map<Integer,ItemStack>	all(ItemStack item)
boolean	canAddItem(ItemStack item)
default boolean	clear(int index)
boolean	clear(int index, boolean send)
void	clearAll()
void	close(Player who)
boolean	contains(ItemStack item)
void	decrementCount(int slot) Decrease item count in the given slot
default int	first(ItemStack item)
int	first(ItemStack item, boolean exact) Search for the first occurrence of target item
int	firstEmpty() Search for the first empty slot
default int	firstFit(ItemStack item)
int	firstFit(ItemStack item, boolean single) Returns the first slot where item fits to
int	firstNonEmpty() Search for the first slot containing an item
Map<Integer,ItemStack>	getContents()
int	getFreeSpace(ItemStack item) Returns how much space remains for the target item
InventoryHolder	getHolder()
ItemStack	getItem(int index)
int	getMaxStackSize()
String	getName()
int	getSize()
String	getTitle()
InventoryType	getType()
Set<? extends Player>	getViewers()
void	incrementCount(int slot) Increase item count in the given slot
boolean	isEmpty()
boolean	isFull()
void	onClose(Player who)
void	onOpen(Player who)
void	onSlotChange(int index, ItemStack before, boolean send)
boolean	open(Player who)
void	remove(ItemStack item)
ItemStack[]	removeItem(ItemStack... slots)
default void	sendContents(Collection<? extends Player> players)
void	sendContents(Player... players)
default void	sendContents(Player player)
default void	sendSlot(int index, Collection<? extends Player> players)
void	sendSlot(int index, Player... players)
default void	sendSlot(int index, Player player)
void	setContents(Map<Integer,ItemStack> items)
default boolean	setItem(int index, ItemStack item)
boolean	setItem(int index, ItemStack item, boolean send)
void	setMaxStackSize(int size)

Field Detail

MAX_STACK

static final int MAX_STACK

See Also:

Constant Field Values

Method Detail

getSize

int getSize()

getMaxStackSize

int getMaxStackSize()

setMaxStackSize

void setMaxStackSize(int size)

getName

String getName()

getTitle

String getTitle()

getItem

@Nonnull
ItemStack getItem(int index)

setItem

default boolean setItem(int index,
                        ItemStack item)

setItem

boolean setItem(int index,
                ItemStack item,
                boolean send)

addItem

ItemStack[] addItem(ItemStack... slots)

canAddItem

boolean canAddItem(ItemStack item)

removeItem

ItemStack[] removeItem(ItemStack... slots)

getContents

Map<Integer,ItemStack> getContents()

setContents

void setContents(Map<Integer,ItemStack> items)

sendContents

default void sendContents(Player player)

sendContents

default void sendContents(Collection<? extends Player> players)

sendContents

void sendContents(Player... players)

sendSlot

default void sendSlot(int index,
                      Player player)

sendSlot

default void sendSlot(int index,
                      Collection<? extends Player> players)

sendSlot

void sendSlot(int index,
              Player... players)

contains

boolean contains(ItemStack item)

all

Map<Integer,ItemStack> all(ItemStack item)

first

default int first(ItemStack item)

first

int first(ItemStack item,
          boolean exact)

Search for the first occurrence of target item

Parameters:

item - target item

exact - if true the item count will be must match

Returns:

the first index containing the item

firstFit

default int firstFit(ItemStack item)

firstFit

int firstFit(ItemStack item,
             boolean single)

Returns the first slot where item fits to

Parameters:

item - item to search for

single - if false the item count will be used. Otherwise it'll be 1

Returns:

the first slot index that item fits to

firstEmpty

int firstEmpty()

Search for the first empty slot

Returns:

the first slot index

firstNonEmpty

int firstNonEmpty()

Search for the first slot containing an item

Returns:

the first non-empty slot

getFreeSpace

int getFreeSpace(ItemStack item)

Returns how much space remains for the target item

Parameters:

item - target item

Returns:

amount if free space

decrementCount

void decrementCount(int slot)

Decrease item count in the given slot

Parameters:

slot - target slot index

incrementCount

void incrementCount(int slot)

Increase item count in the given slot

Parameters:

slot - target slot index

remove

void remove(ItemStack item)

clear

default boolean clear(int index)

clear

boolean clear(int index,
              boolean send)

clearAll

void clearAll()

isFull

boolean isFull()

isEmpty

boolean isEmpty()

getViewers

Set<? extends Player> getViewers()

getType

@Nonnull
InventoryType getType()

getHolder

InventoryHolder getHolder()

onOpen

void onOpen(Player who)

open

boolean open(Player who)

close

void close(Player who)

onClose

void onClose(Player who)

onSlotChange

void onSlotChange(int index,
                  ItemStack before,
                  boolean send)