Package net.minestom.server.inventory

Class PlayerInventory

java.lang.Object

net.minestom.server.inventory.PlayerInventory

All Implemented Interfaces:

DataContainer, EquipmentHandler, InventoryClickHandler, InventoryModifier

public class PlayerInventory
extends java.lang.Object
implements InventoryModifier, InventoryClickHandler, EquipmentHandler, DataContainer

Represents the inventory of a Player, retrieved with Player.getInventory().

Field Summary

Fields

Modifier and Type	Field	Description
static int	INVENTORY_SIZE

Constructor Summary

Constructors

Constructor	Description
PlayerInventory(Player player)

Method Summary

Modifier and Type	Method	Description
void	addInventoryCondition(InventoryCondition inventoryCondition)	Adds a new InventoryCondition to this inventory.
boolean	addItemStack(ItemStack itemStack)	Adds an ItemStack to the inventory and send relevant update to the viewer(s).
boolean	changeHeld(Player player, int slot, int key)	Called when a Player held click in the inventory
void	clear()	Clears the inventory and send relevant update to the viewer(s).
boolean	doubleClick(Player player, int slot)	Called when a Player double click in the inventory
boolean	dragging(Player player, int slot, int button)
boolean	drop(Player player, int mode, int slot, int button)	Called when a Player press the drop button
ItemStack	getBoots()	Gets the boots.
ItemStack	getChestplate()	Gets the chestplate.
ItemStack	getCursorItem()	Gets the item in player cursor.
Data	getData()	Gets the Data of this container.
ItemStack	getHelmet()	Gets the helmet.
java.util.List<InventoryCondition>	getInventoryConditions()	Gets all the InventoryCondition of this inventory.
ItemStack	getItemInMainHand()	Gets the ItemStack in main hand.
ItemStack	getItemInOffHand()	Gets the ItemStack in off hand.
ItemStack	getItemStack(int slot)	Gets the ItemStack at the specified slot.
protected ItemStack	getItemStack(int slot, int offset)	Gets the item from a packet slot.
ItemStack[]	getItemStacks()	Gets all the ItemStack in the inventory.
ItemStack	getLeggings()	Gets the leggings.
int	getSize()	Gets the size of the inventory.
boolean	leftClick(Player player, int slot)	Called when a Player left click in the inventory.
boolean	middleClick(Player player, int slot)
void	refreshSlot(short slot)	Refreshes only a specific slot with the updated item stack data.
boolean	rightClick(Player player, int slot)	Called when a Player right click in the inventory.
protected void	sendSlotRefresh(short slot, ItemStack itemStack)	Refreshes an inventory slot.
void	setBoots(ItemStack itemStack)	Changes the boots.
void	setChestplate(ItemStack itemStack)	Changes the chestplate.
void	setCursorItem(ItemStack cursorItem)	Changes the player cursor item.
void	setData(Data data)	Sets the Data of this container.
void	setHelmet(ItemStack itemStack)	Changes the helmet.
void	setItemInMainHand(ItemStack itemStack)	Changes the main hand ItemStack.
void	setItemInOffHand(ItemStack itemStack)	Changes the off hand ItemStack.
protected void	setItemStack(int slot, int offset, ItemStack itemStack)	Sets an item from a packet slot.
void	setItemStack(int slot, ItemStack itemStack)	Sets an ItemStack at the specified slot and send relevant update to the viewer(s).
protected void	setItemStackInternal(int slot, ItemStack itemStack)
void	setLeggings(ItemStack itemStack)	Changes the leggings.
boolean	shiftClick(Player player, int slot)	Called when a Player shift click in the inventory
void	update()	Refreshes the player inventory by sending a WindowItemsPacket containing all.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.inventory.EquipmentHandler

getEquipment, getEquipmentsPacket, getItemInHand, setItemInHand, syncEquipment, syncEquipments, syncEquipments

Methods inherited from interface net.minestom.server.inventory.InventoryClickHandler

callClickEvent

Field Details

INVENTORY_SIZE

public static final int INVENTORY_SIZE

See Also:

Constant Field Values

Constructor Details

PlayerInventory

public PlayerInventory(Player player)

Method Details

getItemStack

@NotNull public ItemStack getItemStack(int slot)

Description copied from interface: InventoryModifier

Gets the ItemStack at the specified slot.

Specified by:

getItemStack in interface InventoryModifier

Parameters:

slot - the slot to check

Returns:

the item in the slot slot

getItemStacks

@NotNull public ItemStack[] getItemStacks()

Description copied from interface: InventoryModifier

Gets all the ItemStack in the inventory.

Specified by:

getItemStacks in interface InventoryModifier

Returns:

an array containing all the inventory's items

getInventoryConditions

@NotNull public java.util.List<InventoryCondition> getInventoryConditions()

Description copied from interface: InventoryModifier

Gets all the InventoryCondition of this inventory.

Specified by:

getInventoryConditions in interface InventoryModifier

Returns:

a modifiable List containing all the inventory conditions

addInventoryCondition

public void addInventoryCondition(@NotNull InventoryCondition inventoryCondition)

Description copied from interface: InventoryModifier

Adds a new InventoryCondition to this inventory.

Specified by:

addInventoryCondition in interface InventoryModifier

Parameters:

inventoryCondition - the inventory condition to add

setItemStack

public void setItemStack(int slot, @NotNull ItemStack itemStack)

Description copied from interface: InventoryModifier

Sets an ItemStack at the specified slot and send relevant update to the viewer(s).

Specified by:

setItemStack in interface InventoryModifier

Parameters:

slot - the slot to set the item

itemStack - the item to set

addItemStack

public boolean addItemStack(@NotNull ItemStack itemStack)

Description copied from interface: InventoryModifier

Adds an ItemStack to the inventory and send relevant update to the viewer(s).

Even the item cannot be fully added, the amount of itemStack will be updated.

Specified by:

addItemStack in interface InventoryModifier

Parameters:

itemStack - the item to add

Returns:

true if the item has been successfully fully added, false otherwise

clear

public void clear()

Description copied from interface: InventoryModifier

Clears the inventory and send relevant update to the viewer(s).

Specified by:

clear in interface InventoryModifier

getSize

public int getSize()

Description copied from interface: InventoryModifier

Gets the size of the inventory.

Specified by:

getSize in interface InventoryModifier

Returns:

the inventory's size

getItemInMainHand

@NotNull public ItemStack getItemInMainHand()

Description copied from interface: EquipmentHandler

Gets the ItemStack in main hand.

Specified by:

getItemInMainHand in interface EquipmentHandler

Returns:

the ItemStack in main hand

setItemInMainHand

public void setItemInMainHand(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the main hand ItemStack.

Specified by:

setItemInMainHand in interface EquipmentHandler

Parameters:

itemStack - the main hand ItemStack

getItemInOffHand

@NotNull public ItemStack getItemInOffHand()

Description copied from interface: EquipmentHandler

Gets the ItemStack in off hand.

Specified by:

getItemInOffHand in interface EquipmentHandler

Returns:

the item in off hand

setItemInOffHand

public void setItemInOffHand(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the off hand ItemStack.

Specified by:

setItemInOffHand in interface EquipmentHandler

Parameters:

itemStack - the off hand ItemStack

getHelmet

@NotNull public ItemStack getHelmet()

Description copied from interface: EquipmentHandler

Gets the helmet.

Specified by:

getHelmet in interface EquipmentHandler

Returns:

the helmet

setHelmet

public void setHelmet(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the helmet.

Specified by:

setHelmet in interface EquipmentHandler

Parameters:

itemStack - the helmet

getChestplate

@NotNull public ItemStack getChestplate()

Description copied from interface: EquipmentHandler

Gets the chestplate.

Specified by:

getChestplate in interface EquipmentHandler

Returns:

the chestplate

setChestplate

public void setChestplate(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the chestplate.

Specified by:

setChestplate in interface EquipmentHandler

Parameters:

itemStack - the chestplate

getLeggings

@NotNull public ItemStack getLeggings()

Description copied from interface: EquipmentHandler

Gets the leggings.

Specified by:

getLeggings in interface EquipmentHandler

Returns:

the leggings

setLeggings

public void setLeggings(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the leggings.

Specified by:

setLeggings in interface EquipmentHandler

Parameters:

itemStack - the leggings

getBoots

@NotNull public ItemStack getBoots()

Description copied from interface: EquipmentHandler

Gets the boots.

Specified by:

getBoots in interface EquipmentHandler

Returns:

the boots

setBoots

public void setBoots(@NotNull ItemStack itemStack)

Description copied from interface: EquipmentHandler

Changes the boots.

Specified by:

setBoots in interface EquipmentHandler

Parameters:

itemStack - the boots

update

public void update()

Refreshes the player inventory by sending a WindowItemsPacket containing all. the inventory items

refreshSlot

public void refreshSlot(short slot)

Refreshes only a specific slot with the updated item stack data.

Parameters:

slot - the slot to refresh

getCursorItem

@NotNull public ItemStack getCursorItem()

Gets the item in player cursor.

Returns:

the cursor item

setCursorItem

public void setCursorItem(@NotNull ItemStack cursorItem)

Changes the player cursor item.

Parameters:

cursorItem - the new cursor item

setItemStackInternal

protected void setItemStackInternal(int slot, ItemStack itemStack)

setItemStack

protected void setItemStack(int slot, int offset, ItemStack itemStack)

Sets an item from a packet slot.

Parameters:

slot - a packet slot

offset - offset (generally 9 to ignore armor and craft slots)

itemStack - the item stack to set

getItemStack

protected ItemStack getItemStack(int slot, int offset)

Gets the item from a packet slot.

Parameters:

slot - a packet slot

offset - offset (generally 9 to ignore armor and craft slots)

Returns:

the item in the specified slot

sendSlotRefresh

protected void sendSlotRefresh(short slot, ItemStack itemStack)

Refreshes an inventory slot.

Parameters:

slot - the packet slot see PlayerInventoryUtils.convertToPacketSlot(int)

itemStack - the item stack in the slot

leftClick

public boolean leftClick(@NotNull 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

Specified by:

leftClick in interface InventoryClickHandler

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(@NotNull 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

Specified by:

rightClick in interface InventoryClickHandler

Parameters:

player - the player who clicked

slot - the slot number

Returns:

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

middleClick

public boolean middleClick(@NotNull Player player, int slot)

Specified by:

middleClick in interface InventoryClickHandler

drop

public boolean drop(@NotNull Player player, int mode, int slot, int button)

Description copied from interface: InventoryClickHandler

Called when a Player press the drop button

Specified by:

drop in interface InventoryClickHandler

Parameters:

player - the player who clicked

slot - the slot number

button - -999 if clicking outside, normal if he is not

Returns:

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

shiftClick

public boolean shiftClick(@NotNull Player player, int slot)

Description copied from interface: InventoryClickHandler

Called when a Player shift click in the inventory

Specified by:

shiftClick in interface InventoryClickHandler

Parameters:

player - the player who clicked

slot - the slot number

Returns:

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

changeHeld

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

Description copied from interface: InventoryClickHandler

Called when a Player held click in the inventory

Specified by:

changeHeld in interface InventoryClickHandler

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

dragging

public boolean dragging(@NotNull Player player, int slot, int button)

Specified by:

dragging in interface InventoryClickHandler

doubleClick

public boolean doubleClick(@NotNull Player player, int slot)

Description copied from interface: InventoryClickHandler

Called when a Player double click in the inventory

Specified by:

doubleClick in interface InventoryClickHandler

Parameters:

player - the player who clicked

slot - the slot number

Returns:

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

getData

@Nullable public Data getData()

Description copied from interface: DataContainer

Gets the Data of this container.

A DataContainer data is always optional, meaning that this will be null if no data has been defined.

Specified by:

getData in interface DataContainer

Returns:

the Data of this container, can be null

setData

public void setData(@Nullable Data data)

Description copied from interface: DataContainer

Sets the Data of this container.

Default implementations are DataImpl and SerializableDataImpl depending on your use-case.

Specified by:

setData in interface DataContainer

Parameters:

data - the new Data of this container, null to remove it