Package cn.nukkit.inventory

Class BaseInventory

java.lang.Object

cn.nukkit.inventory.BaseInventory

All Implemented Interfaces:

Inventory

Direct Known Subclasses:

ContainerInventory, EntityArmorInventory, EntityEquipmentInventory, FakeHumanEnderChestInventory, FakeHumanInventory, FakeHumanOffhandInventory, HorseInventory, PlayerEnderChestInventory, PlayerInventory, PlayerOffhandInventory, PlayerUIComponent, PlayerUIInventory, TradeInventory

public abstract class BaseInventory
extends Object
implements Inventory

Author:

MagicDroidX (Nukkit Project)

Field Summary

Fields

Modifier and Type	Field	Description
static final Item	AIR_ITEM
protected InventoryHolder	holder
protected int	maxStackSize
protected final String	name
protected int	size
final Map<Integer,Item>	slots
protected final String	title
protected final InventoryType	type
protected final Set<Player>	viewers

Fields inherited from interface cn.nukkit.inventory.Inventory

MAX_STACK

Constructor Summary

Constructors

Constructor	Description
BaseInventory(InventoryHolder holder, InventoryType type)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items, Integer overrideSize)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items, Integer overrideSize, String overrideTitle)

Method Summary

Modifier and Type	Method	Description
Item[]	addItem(Item... slots)
void	addListener(InventoryListener listener)
Map<Integer,Item>	all(Item item)
boolean	canAddItem(Item item)
boolean	clear(int index, boolean send)
void	clearAll()
void	close(Player who)
boolean	contains(Item item)
void	decreaseCount(int slot)
int	first(Item item, boolean exact)
int	firstEmpty(Item item)
Map<Integer,Item>	getContents()
int	getFreeSpace(Item item)	检测指定物品能在该库存所能存放的空余数量
InventoryHolder	getHolder()
Item	getItem(int index)	获取该库存指定索引处的物品
int	getMaxStackSize()	获取最大库存大小
String	getName()	获取该库存的名字
int	getSize()	获取该库存大小
String	getTitle()	获取该库存的标题
InventoryType	getType()
Item	getUnclonedItem(int index)	获取该库存指定索引处的未克隆的物品
Set<Player>	getViewers()
boolean	isEmpty()
boolean	isFull()
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	remove(Item item)
Item[]	removeItem(Item... slots)
void	removeListener(InventoryListener listener)
void	sendContents(Player player)
void	sendContents(Player... players)
void	sendContents(Collection<Player> players)
void	sendSlot(int index, Player player)
void	sendSlot(int index, Player... players)
void	sendSlot(int index, Collection<Player> players)
void	setContents(Map<Integer,Item> items)
boolean	setItem(int index, Item item, boolean send)	设置该库存指定索引处的物品
void	setMaxStackSize(int maxStackSize)	设置最大库存大小
void	setSize(int size)

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

AIR_ITEM

public static final Item AIR_ITEM

type

protected final InventoryType type

maxStackSize

protected int maxStackSize

size

protected int size

name

protected final String name

title

protected final String title

slots

public final Map<Integer,Item> slots

viewers

protected final Set<Player> viewers

holder

protected InventoryHolder holder

Constructor Details

BaseInventory

public BaseInventory(InventoryHolder holder,
 InventoryType type)

BaseInventory

public BaseInventory(InventoryHolder holder,
 InventoryType type,
 Map<Integer,Item> items)

BaseInventory

public BaseInventory(InventoryHolder holder,
 InventoryType type,
 Map<Integer,Item> items,
 Integer overrideSize)

BaseInventory

public BaseInventory(InventoryHolder holder,
 InventoryType type,
 Map<Integer,Item> items,
 Integer overrideSize,
 String overrideTitle)

Method Details

getSize

public int getSize()

Description copied from interface: Inventory

获取该库存大小

Specified by:

getSize in interface Inventory

setSize

public void setSize(int size)

getMaxStackSize

public int getMaxStackSize()

Description copied from interface: Inventory

获取最大库存大小

Specified by:

getMaxStackSize in interface Inventory

getName

public String getName()

Description copied from interface: Inventory

获取该库存的名字

Specified by:

getName in interface Inventory

getTitle

public String getTitle()

Description copied from interface: Inventory

获取该库存的标题

Specified by:

getTitle in interface Inventory

getItem

@NotNull
public Item getItem(int index)

Description copied from interface: Inventory

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

Specified by:

getItem in interface Inventory

Parameters:

index - the index

Returns:

the item

getUnclonedItem

@PowerNukkitXOnly
@Since("1.19.60-r1")
public Item getUnclonedItem(int index)

Description copied from interface: Inventory

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

若调用方保证不会修改此方法返回的Item对象，则使用此方法将降低特定场景下Item::clone()造成的性能开销

Specified by:

getUnclonedItem in interface Inventory

Parameters:

index - the index

Returns:

the item

getContents

public Map<Integer,Item> getContents()

Specified by:

getContents in interface Inventory

setContents

public void setContents(Map<Integer,Item> items)

Specified by:

setContents in interface Inventory

setItem

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

Description copied from interface: Inventory

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

Specified by:

setItem in interface Inventory

Parameters:

index - the index

item - the item

send - 是否同时发送数据包

Returns:

the item

contains

public boolean contains(Item item)

Specified by:

contains in interface Inventory

all

public Map<Integer,Item> all(Item item)

Specified by:

all in interface Inventory

remove

public void remove(Item item)

Specified by:

remove in interface Inventory

first

public int first(Item item,
 boolean exact)

Specified by:

first in interface Inventory

firstEmpty

public int firstEmpty(Item item)

Specified by:

firstEmpty in interface Inventory

decreaseCount

public void decreaseCount(int slot)

Specified by:

decreaseCount in interface Inventory

canAddItem

@PowerNukkitXDifference(info="Using BaseInventory::getUnclonedItem() to improve performance",
                        since="1.19.60-r1")
public boolean canAddItem(Item item)

Specified by:

canAddItem in interface Inventory

addItem

public Item[] addItem(Item... slots)

Specified by:

addItem in interface Inventory

removeItem

public Item[] removeItem(Item... slots)

Specified by:

removeItem in interface Inventory

clear

public boolean clear(int index,
 boolean send)

Specified by:

clear in interface Inventory

clearAll

public void clearAll()

Specified by:

clearAll in interface Inventory

getViewers

public Set<Player> getViewers()

Specified by:

getViewers in interface Inventory

getHolder

public InventoryHolder getHolder()

Specified by:

getHolder in interface Inventory

setMaxStackSize

public void setMaxStackSize(int maxStackSize)

Description copied from interface: Inventory

设置最大库存大小

Specified by:

setMaxStackSize in interface Inventory

open

public boolean open(Player who)

Specified by:

open in interface Inventory

close

public void close(Player who)

Specified by:

close in interface Inventory

onOpen

public void onOpen(Player who)

Specified by:

onOpen in interface Inventory

onClose

public void onClose(Player who)

Specified by:

onClose in interface Inventory

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

Parameters:

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

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

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

sendContents

public void sendContents(Player player)

Specified by:

sendContents in interface Inventory

sendContents

public void sendContents(Player... players)

Specified by:

sendContents in interface Inventory

isFull

public boolean isFull()

Specified by:

isFull in interface Inventory

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Inventory

getFreeSpace

public int getFreeSpace(Item item)

检测指定物品能在该库存所能存放的空余数量

Parameters:

item - 要检测的物品

Returns:

所能存放的空余数量

sendContents

public void sendContents(Collection<Player> players)

Specified by:

sendContents in interface Inventory

sendSlot

public void sendSlot(int index,
 Player player)

Specified by:

sendSlot in interface Inventory

sendSlot

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

Specified by:

sendSlot in interface Inventory

sendSlot

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

Specified by:

sendSlot in interface Inventory

addListener

@PowerNukkitOnly
public void addListener(InventoryListener listener)

Specified by:

addListener in interface Inventory

removeListener

@PowerNukkitOnly
public void removeListener(InventoryListener listener)

Specified by:

removeListener in interface Inventory

getType

public InventoryType getType()

Specified by:

getType in interface Inventory