ItemStack (Bukkit 1.12.2-R0.1-SNAPSHOT API 中文文档)

java.lang.Object
- org.bukkit.inventory.ItemStack

所有已实现的接口:: java.lang.Cloneable, ConfigurationSerializable

public class ItemStack
extends java.lang.Object
implements java.lang.Cloneable, ConfigurationSerializable

代表物品堆

构造器概要

构造器
限定符	构造器和说明
`protected`	`ItemStack()`
	`ItemStack(int type)` 已过时。不安全的参数
	`ItemStack(int type, int amount)` 已过时。不安全的参数
	`ItemStack(int type, int amount, short damage)` 已过时。不安全的参数
	`ItemStack(int type, int amount, short damage, java.lang.Byte data)` 已过时。该方法使用了意义不明确的data byte对象
	`ItemStack(ItemStack stack)` 构造一个指定物品堆的副本.
	`ItemStack(Material type)` 构造一个堆叠数为1, 无附加数据的物品堆.
	`ItemStack(Material type, int amount)` 构造指定堆叠数, 无附加数据的物品堆.
	`ItemStack(Material type, int amount, short damage)` 构造一个具有指定损耗值(耐久度)的物品堆.
	`ItemStack(Material type, int amount, short damage, java.lang.Byte data)` 已过时。该方法使用了意义不明确的data byte对象

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addEnchantment(Enchantment ench, int level)` 向物品堆添加`附魔`.
`void`	`addEnchantments(java.util.Map<Enchantment,java.lang.Integer> enchantments)` 向物品堆添加附魔.
`void`	`addUnsafeEnchantment(Enchantment ench, int level)` 向物品堆添加`附魔`.
`void`	`addUnsafeEnchantments(java.util.Map<Enchantment,java.lang.Integer> enchantments)` 以不安全的方式向物品堆添加附魔.
`ItemStack`	`clone()`
`boolean`	`containsEnchantment(Enchantment ench)` 检测该物品堆是否包含指定`附魔`.
`static ItemStack`	`deserialize(java.util.Map<java.lang.String,java.lang.Object> args)` 实现配置序列化与反序列化需要的方法.
`boolean`	`equals(java.lang.Object obj)`
`int`	`getAmount()` 获取该物品堆的物品堆叠数量.
`MaterialData`	`getData()` 获取该物品堆的 MateralData 数据.
`short`	`getDurability()` 获取该物品的耐久度.
`int`	`getEnchantmentLevel(Enchantment ench)` 获取该物品指定附魔的附魔等级.
`java.util.Map<Enchantment,java.lang.Integer>`	`getEnchantments()` 获取该物品的所有附魔以及对应的附魔等级, 用map表示.
`ItemMeta`	`getItemMeta()` 获取此物品堆的`ItemMeta`的副本.
`int`	`getMaxStackSize()` 获取该物品的最大堆叠数 (若物品未知返回-1).
`Material`	`getType()` 获取该物品的种类.
`int`	`getTypeId()` 已过时。不安全的参数
`int`	`hashCode()`
`boolean`	`hasItemMeta()` 检测该物品堆是否含有任何物品元数据.
`boolean`	`isSimilar(ItemStack stack)` 该方法与equals方法相同, 但不考虑堆叠数量.
`int`	`removeEnchantment(Enchantment ench)` 移除指定的`附魔`.
`java.util.Map<java.lang.String,java.lang.Object>`	`serialize()` Creates a Map representation of this class.
`void`	`setAmount(int amount)` 设置该物品堆的物品堆叠数量.
`void`	`setData(MaterialData data)` 设置该物品堆的 MateralData 数据.
`void`	`setDurability(short durability)` 设置该物品的耐久度.
`boolean`	`setItemMeta(ItemMeta itemMeta)` 向物品堆设置元数据.
`void`	`setType(Material type)` 设置该物品的种类.
`void`	`setTypeId(int type)` 已过时。不安全的参数
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - ItemStack
```
protected ItemStack()
```
  - ItemStack
```
@Deprecated
public ItemStack(int type)
```
    已过时。不安全的参数
    
    构造一个堆叠数为1, 无附加数据的物品堆.
    原文:Defaults stack size to 1, with no extra data
    
    参数:
    
    type - 物品material id
  - ItemStack
```
public ItemStack(Material type)
```
    构造一个堆叠数为1, 无附加数据的物品堆.
    原文:Defaults stack size to 1, with no extra data
    
    参数:
    
    type - 物品种类
  - ItemStack
```
@Deprecated
public ItemStack(int type,
                             int amount)
```
    已过时。不安全的参数
    
    构造指定堆叠数, 无附加数据的物品堆.
    原文:An item stack with no extra data
    
    参数:
    
    type - 物品material id
    
    amount - 堆叠数
  - ItemStack
```
public ItemStack(Material type,
                 int amount)
```
    构造指定堆叠数, 无附加数据的物品堆.
    原文:An item stack with no extra data
    
    参数:
    
    type - 物品种类
    
    amount - 堆叠数
  - ItemStack
```
@Deprecated
public ItemStack(int type,
                             int amount,
                             short damage)
```
    已过时。不安全的参数
    
    构造一个具有指定损耗值(耐久度)的物品堆.
    原文:An item stack with the specified damage / durability
    
    参数:
    
    type - 物品material id
    
    amount - 堆叠数
    
    damage - 损耗值/耐久度
  - ItemStack
```
public ItemStack(Material type,
                 int amount,
                 short damage)
```
    构造一个具有指定损耗值(耐久度)的物品堆.
    原文:An item stack with the specified damage / durability
    
    参数:
    
    type - 物品种类
    
    amount - 堆叠数
    
    damage - 损耗值
  - ItemStack
```
@Deprecated
public ItemStack(int type,
                             int amount,
                             short damage,
                             java.lang.Byte data)
```
    已过时。该方法使用了意义不明确的data byte对象
    
    参数:
    
    type - the raw type id
    
    amount - the amount in the stack
    
    damage - the damage value of the item
    
    data - the data value or null
  - ItemStack
```
@Deprecated
public ItemStack(Material type,
                             int amount,
                             short damage,
                             java.lang.Byte data)
```
    已过时。该方法使用了意义不明确的data byte对象
    
    参数:
    
    type - the type
    
    amount - the amount in the stack
    
    damage - the damage value of the item
    
    data - the data value or null
  - ItemStack
```
public ItemStack(ItemStack stack)
          throws java.lang.IllegalArgumentException
```
    构造一个指定物品堆的副本.
    原文:Creates a new item stack derived from the specified stack
    
    参数:
    
    stack - 要复制的物品堆
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果指定的 stack 为null或返回的物品元数据不是通过ItemFactory创建的
- 方法详细资料
  - getType
```
public Material getType()
```
    获取该物品的种类.
    原文:Gets the type of this item
    
    返回:
    
    该物品的种类
  - setType
```
public void setType(Material type)
```
    设置该物品的种类.
    注:在做这件事的同时你将清除该物品堆上的MaterialData数据.
    原文:Sets the type of this item
    Note that in doing so you will reset the MaterialData for this stack
    
    参数:
    
    type - 该物品的种类
  - getTypeId
```
@Deprecated
public int getTypeId()
```
    已过时。不安全的参数
    
    获取该物品的物品id.
    原文:Gets the type id of this item
    
    返回:
    
    物品id
  - setTypeId
```
@Deprecated
public void setTypeId(int type)
```
    已过时。不安全的参数
    
    设置此物品的物品id.
    注:在做这件事的同时你将清除该物品堆上的MaterialData数据.
    原文:Sets the type id of this item
    Note that in doing so you will reset the MaterialData for this stack
    
    参数:
    
    type - 物品id
  - getAmount
```
public int getAmount()
```
    获取该物品堆的物品堆叠数量.
    原文:Gets the amount of items in this stack
    
    返回:
    
    物品堆叠数量
  - setAmount
```
public void setAmount(int amount)
```
    设置该物品堆的物品堆叠数量.
    原文:Sets the amount of items in this stack
    
    参数:
    
    amount - 物品堆叠数量
  - getData
```
public MaterialData getData()
```
    获取该物品堆的 MateralData 数据.
    原文:Gets the MaterialData for this stack of items
    
    返回:
    
    物品堆的MaterialData数据
  - setData
```
public void setData(MaterialData data)
```
    设置该物品堆的 MateralData 数据.
    原文:Sets the MaterialData for this stack of items
    
    参数:
    
    data - 物品堆的MaterialData数据
  - setDurability
```
public void setDurability(short durability)
```
    设置该物品的耐久度.
    原文:Sets the durability of this item
    
    参数:
    
    durability - 物品耐久度
  - getDurability
```
public short getDurability()
```
    获取该物品的耐久度.
    原文:Gets the durability of this item
    
    返回:
    
    物品耐久度
  - getMaxStackSize
```
public int getMaxStackSize()
```
    获取该物品的最大堆叠数 (若物品未知返回-1).
    原文:Get the maximum stacksize for the material hold in this ItemStack. (Returns -1 if it has no idea)
    
    返回:
    
    该物品的最大堆叠数
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - isSimilar
```
public boolean isSimilar(ItemStack stack)
```
    该方法与equals方法相同, 但不考虑堆叠数量.
    原文:This method is the same as equals, but does not consider stack size (amount).
    
    参数:
    
    stack - 与哪个物品堆作比较
    
    返回:
    
    若两者相同返回true (忽略其堆叠数)
  - clone
```
public ItemStack clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - containsEnchantment
```
public boolean containsEnchantment(Enchantment ench)
```
    检测该物品堆是否包含指定附魔.
    原文:Checks if this ItemStack contains the given Enchantment
    
    参数:
    
    ench - 附魔
    
    返回:
    
    若该物品含有此附魔返回true
  - getEnchantmentLevel
```
public int getEnchantmentLevel(Enchantment ench)
```
    获取该物品指定附魔的附魔等级.
    原文:Gets the level of the specified enchantment on this item stack
    
    参数:
    
    ench - 附魔
    
    返回:
    
    指定附魔的附魔等级, 若附魔不存在/没有附魔则为0
  - getEnchantments
```
public java.util.Map<Enchantment,java.lang.Integer> getEnchantments()
```
    获取该物品的所有附魔以及对应的附魔等级, 用map表示.
    原文:Gets a map containing all enchantments and their levels on this item.
    
    返回:
    
    附魔魔咒
  - addEnchantments
```
public void addEnchantments(java.util.Map<Enchantment,java.lang.Integer> enchantments)
```
    向物品堆添加附魔.
    该方法实质就是遍历你所给的map, 逐一调用addEnchantment(org.bukkit.enchantments.Enchantment, int).
    原文:Adds the specified enchantments to this item stack.
    This method is the same as calling addEnchantment(org.bukkit.enchantments.Enchantment, int) for each element of the map.
    
    参数:
    
    enchantments - 要添加的附魔
    
    抛出:
    
    java.lang.IllegalArgumentException - 若参数enchantments为null
    
    java.lang.IllegalArgumentException - 若任何指定的附魔或等级为null. 警告: 某些附魔可能会在此异常抛出前添加到此物品上
  - addEnchantment
```
public void addEnchantment(Enchantment ench,
                           int level)
```
    向物品堆添加附魔.
    若此物品堆已经含有给定的附魔(无论它们的附魔等级是什么), 将替换已有的附魔.
    原文:Adds the specified Enchantment to this item stack.
    If this item stack already contained the given enchantment (at any level), it will be replaced.
    
    参数:
    
    ench - 附魔
    
    level - 附魔等级
    
    抛出:
    
    java.lang.IllegalArgumentException - 若enchantment为null, 或该附魔不可应用于此物品上
  - addUnsafeEnchantments
```
public void addUnsafeEnchantments(java.util.Map<Enchantment,java.lang.Integer> enchantments)
```
    以不安全的方式向物品堆添加附魔.
    该方法实质就是遍历你所给的map, 逐一调用addUnsafeEnchantment(org.bukkit.enchantments.Enchantment, int).
    原文:Adds the specified enchantments to this item stack in an unsafe manner.
    This method is the same as calling addUnsafeEnchantment(org.bukkit.enchantments.Enchantment, int) for each element of the map.
    
    参数:
    
    enchantments - 附魔
  - addUnsafeEnchantment
```
public void addUnsafeEnchantment(Enchantment ench,
                                 int level)
```
    向物品堆添加附魔.
    若此物品堆已经含有给定的附魔(无论它们的附魔等级是什么), 将替换已有的附魔.
    该方法是个不安全操作, 忽略附魔的等级限制以及对此物品的可用性. 请慎重使用.
    原文:Adds the specified Enchantment to this item stack.
    If this item stack already contained the given enchantment (at any level), it will be replaced.
    This method is unsafe and will ignore level restrictions or item type. Use at your own discretion.
    
    参数:
    
    ench - 附魔
    
    level - 附魔等级
  - removeEnchantment
```
public int removeEnchantment(Enchantment ench)
```
    移除指定的附魔.
    原文:Removes the specified Enchantment if it exists on this ItemStack
    
    参数:
    
    ench - 要移除的附魔
    
    返回:
    
    附魔先前的等级, 若附魔不存在为0
  - serialize
```
public java.util.Map<java.lang.String,java.lang.Object> serialize()
```
    从接口复制的说明: ConfigurationSerializable
    
    Creates a Map representation of this class.
    This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs.
    
    指定者:
    
    serialize 在接口中 ConfigurationSerializable
    
    返回:
    
    Map containing the current state of this class
  - deserialize
```
public static ItemStack deserialize(java.util.Map<java.lang.String,java.lang.Object> args)
```
    实现配置序列化与反序列化需要的方法.
    原文:Required method for configuration serialization
    
    参数:
    
    args - 需要反序列化的map
    
    返回:
    
    反序列化后的物品堆
    
    另请参阅:
    
    ConfigurationSerializable
  - getItemMeta
```
public ItemMeta getItemMeta()
```
    获取此物品堆的ItemMeta的副本.
    原文:Get a copy of this ItemStack's ItemMeta.
    
    返回:
    
    物品堆元数据副本
  - hasItemMeta
```
public boolean hasItemMeta()
```
    检测该物品堆是否含有任何物品元数据.
    原文:Checks to see if any meta data has been defined.
    
    返回:
    
    返回该物品是否被设置了任何附加元数据值
  - setItemMeta
```
public boolean setItemMeta(ItemMeta itemMeta)
```
    向物品堆设置元数据.
    原文:Set the ItemMeta of this ItemStack.
    
    参数:
    
    itemMeta - 新物品元数据,或用null来清除此物品上的元数据
    
    返回:
    
    若成功应用物品元数据返回true, 另请参见 ItemFactory.isApplicable(ItemMeta, ItemStack)
    
    抛出:
    
    java.lang.IllegalArgumentException - 物品元数据不是通过ItemFactory创建的

类 ItemStack

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

方法详细资料

getType

setType

getTypeId

setTypeId

getAmount

setAmount

getData

setData

setDurability

getDurability

getMaxStackSize

toString

equals

isSimilar

clone

hashCode

containsEnchantment

getEnchantmentLevel

getEnchantments

addEnchantments

addEnchantment

addUnsafeEnchantments

addUnsafeEnchantment

removeEnchantment

serialize

deserialize

getItemMeta

hasItemMeta

setItemMeta