org.cloudburstmc.server.inventory

Interface Inventory

All Known Implementing Classes:

AnvilInventory, BarrelInventory, BaseInventory, BeaconInventory, BigCraftingGrid, BrewingInventory, ChestInventory, ContainerInventory, CraftingGrid, CustomInventory, DoubleChestInventory, EnchantInventory, FakeBlockUIComponent, FurnaceInventory, HopperInventory, PlayerCursorInventory, PlayerEnderChestInventory, PlayerInventory, PlayerUIComponent, PlayerUIInventory, 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
Item[]	addItem(Item... slots)
Map<Integer,Item>	all(Item item)
boolean	canAddItem(Item item)
default boolean	clear(int index)
boolean	clear(int index, boolean send)
void	clearAll()
void	close(Player who)
boolean	contains(Item item)
void	decreaseCount(int slot) Decrease item count in the given slot
default int	first(Item item)
int	first(Item item, boolean exact) Search for the first occurrence of target item
int	firstEmpty() Search for the first empty slot
default int	firstFit(Item item)
int	firstFit(Item item, boolean single) Returns the first slot where item fits to
int	firstNonEmpty() Search for the first slot containing an item
Map<Integer,Item>	getContents()
int	getFreeSpace(Item item) Returns how much space remains for the target item
InventoryHolder	getHolder()
Item	getItem(int index)
int	getMaxStackSize()
String	getName()
int	getSize()
String	getTitle()
InventoryType	getType()
Set<Player>	getViewers()
void	increaseCount(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, Item before, boolean send)
boolean	open(Player who)
void	remove(Item item)
Item[]	removeItem(Item... slots)
void	sendContents(Collection<Player> players)
void	sendContents(Player... players)
void	sendContents(Player player)
void	sendSlot(int index, Collection<Player> players)
void	sendSlot(int index, Player... players)
void	sendSlot(int index, Player player)
void	setContents(Map<Integer,Item> items)
default boolean	setItem(int index, Item item)
boolean	setItem(int index, Item 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

Item getItem(int index)

setItem

default boolean setItem(int index,
                        Item item)

setItem

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

addItem

Item[] addItem(Item... slots)

canAddItem

boolean canAddItem(Item item)

removeItem

Item[] removeItem(Item... slots)

getContents

Map<Integer,Item> getContents()

setContents

void setContents(Map<Integer,Item> items)

sendContents

void sendContents(Player player)

sendContents

void sendContents(Player... players)

sendContents

void sendContents(Collection<Player> players)

sendSlot

void sendSlot(int index,
              Player player)

sendSlot

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

sendSlot

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

contains

boolean contains(Item item)

all

Map<Integer,Item> all(Item item)

first

default int first(Item item)

first

int first(Item 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(Item item)

firstFit

int firstFit(Item 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(Item item)

Returns how much space remains for the target item

Parameters:

item - target item

Returns:

amount if free space

decreaseCount

void decreaseCount(int slot)

Decrease item count in the given slot

Parameters:

slot - target slot index

increaseCount

void increaseCount(int slot)

Increase item count in the given slot

Parameters:

slot - target slot index

remove

void remove(Item 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<Player> getViewers()

getType

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,
                  Item before,
                  boolean send)