Package cn.nukkit.inventory

Class PlayerUIComponent

java.lang.Object

cn.nukkit.inventory.BaseInventory

cn.nukkit.inventory.PlayerUIComponent

All Implemented Interfaces:

Inventory

Direct Known Subclasses:

CraftingGrid, FakeBlockUIComponent, PlayerCursorInventory

public class PlayerUIComponent
extends BaseInventory

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CREATED_ITEM_OUTPUT_UI_SLOT
protected final PlayerUIInventory	playerUI

Fields inherited from class cn.nukkit.inventory.BaseInventory

AIR_ITEM, holder, maxStackSize, name, slots, title, type, viewers

Fields inherited from interface cn.nukkit.inventory.Inventory

MAX_STACK

Method Summary

Modifier and Type	Method	Description
boolean	clear(int index, boolean send)
void	close(Player who)
Map<Integer,Item>	getContents()
Item	getItem(int index)	获取该库存指定索引处的物品
int	getMaxStackSize()	获取最大库存大小
int	getSize()	获取该库存大小
String	getTitle()	获取该库存的标题
InventoryType	getType()
Set<Player>	getViewers()
void	onClose(Player who)
void	onOpen(Player who)
void	onSlotChange(int index, Item before, boolean send)	当执行Inventory.setItem(int, Item)时该方法会被调用，此时物品已经put进slots
boolean	open(Player who)
void	sendContents(Player... players)
void	sendSlot(int index, Player... players)
boolean	setItem(int index, Item item, boolean send)	设置该库存指定索引处的物品
void	setMaxStackSize(int size)	设置最大库存大小

Methods inherited from class cn.nukkit.inventory.BaseInventory

addItem, addListener, all, canAddItem, clearAll, contains, decreaseCount, first, firstEmpty, getFreeSpace, getHolder, getName, getUnclonedItem, isEmpty, isFull, remove, removeItem, removeListener, sendContents, sendContents, sendSlot, sendSlot, setContents, setSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.nukkit.inventory.Inventory

clear, first, setItem, setItemByPlayer

Field Details

CREATED_ITEM_OUTPUT_UI_SLOT

@Since("1.4.0.0-PN")
public static final int CREATED_ITEM_OUTPUT_UI_SLOT

See Also:

• Constant Field Values

playerUI

@PowerNukkitOnly
protected final PlayerUIInventory playerUI

Method Details

getSize

public int getSize()

Description copied from interface: Inventory

获取该库存大小

Specified by:

getSize in interface Inventory

Overrides:

getSize in class BaseInventory

getMaxStackSize

public int getMaxStackSize()

Description copied from interface: Inventory

获取最大库存大小

Specified by:

getMaxStackSize in interface Inventory

Overrides:

getMaxStackSize in class BaseInventory

setMaxStackSize

public void setMaxStackSize(int size)

Description copied from interface: Inventory

设置最大库存大小

Specified by:

setMaxStackSize in interface Inventory

Overrides:

setMaxStackSize in class BaseInventory

getTitle

public String getTitle()

Description copied from interface: Inventory

获取该库存的标题

Specified by:

getTitle in interface Inventory

Overrides:

getTitle in class BaseInventory

getItem

@NotNull
public Item getItem(int index)

Description copied from interface: Inventory

获取该库存指定索引处的物品

Specified by:

getItem in interface Inventory

Overrides:

getItem in class BaseInventory

Parameters:

index - the index

Returns:

the item

setItem

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

Description copied from interface: Inventory

设置该库存指定索引处的物品

Specified by:

setItem in interface Inventory

Overrides:

setItem in class BaseInventory

Parameters:

index - the index

item - the item

send - 是否同时发送数据包

Returns:

the item

clear

public boolean clear(int index,
 boolean send)

Specified by:

clear in interface Inventory

Overrides:

clear in class BaseInventory

getContents

public Map<Integer,Item> getContents()

Specified by:

getContents in interface Inventory

Overrides:

getContents in class BaseInventory

sendContents

public void sendContents(Player... players)

Specified by:

sendContents in interface Inventory

Overrides:

sendContents in class BaseInventory

sendSlot

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

Specified by:

sendSlot in interface Inventory

Overrides:

sendSlot in class BaseInventory

getViewers

public Set<Player> getViewers()

Specified by:

getViewers in interface Inventory

Overrides:

getViewers in class BaseInventory

getType

public InventoryType getType()

Specified by:

getType in interface Inventory

Overrides:

getType in class BaseInventory

onOpen

public void onOpen(Player who)

Specified by:

onOpen in interface Inventory

Overrides:

onOpen in class BaseInventory

open

public boolean open(Player who)

Specified by:

open in interface Inventory

Overrides:

open in class BaseInventory

close

public void close(Player who)

Specified by:

close in interface Inventory

Overrides:

close in class BaseInventory

onClose

public void onClose(Player who)

Specified by:

onClose in interface Inventory

Overrides:

onClose in class BaseInventory

onSlotChange

public void onSlotChange(int index,
 Item before,
 boolean send)

Description copied from interface: Inventory

当执行Inventory.setItem(int, Item)时该方法会被调用，此时物品已经put进slots

This method is called when Inventory.setItem(int, Item) is executed, and the item has been put into slots

Specified by:

onSlotChange in interface Inventory

Overrides:

onSlotChange in class BaseInventory

Parameters:

index - 物品变动的格子索引
The grid index of the item's changes

before - 变动前的物品
Items before the change

send - 是否发送InventorySlotPacket到客户端
Whether to send InventorySlotPacket to the client