Class Inventory

java.lang.Object

net.minestom.server.inventory.AbstractInventory

net.minestom.server.inventory.Inventory

All Implemented Interfaces:

EventHandler<InventoryEvent>, InventoryClickHandler, Taggable, TagReadable, TagWritable, Viewable

Direct Known Subclasses:

AnvilInventory, BeaconInventory, BrewingStandInventory, EnchantmentTableInventory, FurnaceInventory, VillagerInventory

public non-sealed class Inventory
extends AbstractInventory

Represents an inventory which can be viewed by a collection of Player.

You can create one with Inventory(InventoryType, String) or by making your own subclass. It can then be opened using Player.openInventory(Inventory).

Field Summary

Fields inherited from class AbstractInventory

clickProcessor, itemStacks, unmodifiableViewers, viewers

Constructor Summary

Constructors

Constructor	Description
Inventory(InventoryType inventoryType, String title)
Inventory(InventoryType inventoryType, Component title)

Method Summary

Modifier and Type	Method	Description
boolean	addViewer(Player player)	This will not open the inventory for player, use Player.openInventory(Inventory).
boolean	changeHeld(Player player, int slot, int key)	Called when a Player held click in the inventory
boolean	doubleClick(Player player, int slot)	Called when a Player double click in the inventory
boolean	dragging(Player player, List<Integer> slots, int button)
boolean	drop(Player player, boolean all, int slot)	Called when a Player press the drop button
ItemStack	getCursorItem(Player player)	Deprecated. normal inventories no longer store cursor items
InventoryType	getInventoryType()	Gets the inventory type.
Component	getTitle()	Gets the inventory title.
byte	getWindowId()	Gets this window id.
boolean	leftClick(Player player, int slot)	Called when a Player left click in the inventory.
boolean	middleClick(Player player, int slot)
boolean	removeViewer(Player player)	This will not close the inventory for player, use Player.closeInventory().
boolean	rightClick(Player player, int slot)	Called when a Player right click in the inventory.
protected void	sendProperty(InventoryProperty property, short value)	Sends a window property to all viewers.
void	setCursorItem(Player player, ItemStack cursorItem)	Deprecated. normal inventories no longer store cursor items
void	setTitle(Component title)	Changes the inventory title.
boolean	shiftClick(Player player, int slot, int button)	Called when a Player shift click in the inventory

Methods inherited from class AbstractInventory

addItemStack, addItemStack, addItemStacks, clear, copyContents, eventNode, getInnerSize, getItemStack, getItemStacks, getSize, getViewers, processItemStack, processItemStacks, replaceItemStack, sendSlotRefresh, setItemStack, setItemStack, tagHandler, takeItemStack, takeItemStacks, UNSAFE_itemInsert, update, update

Methods inherited from class Object

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

Methods inherited from interface InventoryClickHandler

callClickEvent, handleClick

Methods inherited from interface Taggable

getAndSetTag, getAndUpdateTag, getTag, hasTag, removeTag, setTag, updateAndGetTag, updateTag

Methods inherited from interface Viewable

getViewersAsAudience, getViewersAsAudiences, isViewer, sendPacketsToViewers, sendPacketsToViewers, sendPacketToViewers, sendPacketToViewersAndSelf

Constructor Details

Inventory

public Inventory(InventoryType inventoryType,
 Component title)

Inventory

public Inventory(InventoryType inventoryType,
 String title)

Method Details

getInventoryType

public InventoryType getInventoryType()

Gets the inventory type.

Returns:

the inventory type

getTitle

public Component getTitle()

Gets the inventory title.

Returns:

the inventory title

setTitle

public void setTitle(Component title)

Changes the inventory title.

Parameters:

title - the new inventory title

getWindowId

public byte getWindowId()

Description copied from class: AbstractInventory

Gets this window id.

This is the id that the client will send to identify the affected inventory, mostly used by packets.

Specified by:

getWindowId in class AbstractInventory

Returns:

the window id

addViewer

public boolean addViewer(Player player)

This will not open the inventory for player, use Player.openInventory(Inventory).

Specified by:

addViewer in interface Viewable

Overrides:

addViewer in class AbstractInventory

Parameters:

player - the viewer to add

Returns:

true if the player has successfully been added

removeViewer

public boolean removeViewer(Player player)

This will not close the inventory for player, use Player.closeInventory().

Specified by:

removeViewer in interface Viewable

Overrides:

removeViewer in class AbstractInventory

Parameters:

player - the viewer to remove

Returns:

true if the player has successfully been removed

getCursorItem

@Deprecated
public ItemStack getCursorItem(Player player)

Deprecated.

normal inventories no longer store cursor items

Gets the cursor item of a player.

See Also:

• the relevant PR

setCursorItem

@Deprecated
public void setCursorItem(Player player,
 ItemStack cursorItem)

Deprecated.

normal inventories no longer store cursor items

Changes the cursor item of a player.

See Also:

• the relevant PR

sendProperty

protected void sendProperty(InventoryProperty property,
 short value)

Sends a window property to all viewers.

Parameters:

property - the property to send

value - the value of the property

See Also:

• the Minecraft wiki

leftClick

public boolean leftClick(Player player,
 int slot)

Description copied from interface: InventoryClickHandler

Called when a Player left click in the inventory. Can also be to drop the cursor item

Parameters:

player - the player who clicked

slot - the slot number

Returns:

true if the click hasn't been cancelled, false otherwise

rightClick

public boolean rightClick(Player player,
 int slot)

Description copied from interface: InventoryClickHandler

Called when a Player right click in the inventory. Can also be to drop the cursor item

Parameters:

player - the player who clicked

slot - the slot number

Returns:

true if the click hasn't been cancelled, false otherwise

shiftClick

public boolean shiftClick(Player player,
 int slot,
 int button)

Description copied from interface: InventoryClickHandler

Called when a Player shift click in the inventory

Parameters:

player - the player who clicked

slot - the slot number

button - the button (same behaviour in vanilla, but can be used for custom behaviour)

Returns:

true if the click hasn't been cancelled, false otherwise

changeHeld

public boolean changeHeld(Player player,
 int slot,
 int key)

Description copied from interface: InventoryClickHandler

Called when a Player held click in the inventory

Parameters:

player - the player who clicked

slot - the slot number

key - the held slot (0-8) pressed

Returns:

true if the click hasn't been cancelled, false otherwise

middleClick

public boolean middleClick(Player player,
 int slot)

drop

public boolean drop(Player player,
 boolean all,
 int slot)

Description copied from interface: InventoryClickHandler

Called when a Player press the drop button

Parameters:

player - the player who clicked

all -

slot - the slot number (-999 if clicking outside, i.e. dropping cursor)

Returns:

true if the drop hasn't been cancelled, false otherwise

dragging

public boolean dragging(Player player,
 List<Integer> slots,
 int button)

doubleClick

public boolean doubleClick(Player player,
 int slot)

Description copied from interface: InventoryClickHandler

Called when a Player double click in the inventory

Parameters:

player - the player who clicked

slot - the slot number

Returns:

true if the click hasn't been cancelled, false otherwise