Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-10-31 16:00:52 +01:00
Code Issues Projects Releases Wiki Activity

Inform about the purpose of the fromItemStack (fromItemTag) method.

Browse Source
This commit is contained in:
Kristian S. Stangeland 2013-01-09 04:52:53 +01:00
parent dbc28c0035
commit f791e2726f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ProtocolLib/src/main/java/com/comphenix/protocol/wrappers/nbt/NbtFactory.java
View File

@ -112,14 +112,16 @@ public class NbtFactory {
}
/**
* Construct a wrapper for an NBT tag stored (in memory) in an item stack.
* Construct a wrapper for an NBT tag stored (in memory) in an item stack. This is where
* auxillary data such as enchanting, name and lore is stored. It doesn't include the items
* material, damage value or count.
* <p>
* The item stack must be a wrapper for a CraftItemStack. Use
* {@link MinecraftReflection#getBukkitItemStack(ItemStack)} if not.
* @param stack - the item stack.
* @return A wrapper for its NBT tag.
*/
public static NbtWrapper<?> fromItemStack(ItemStack stack) {
public static NbtWrapper<?> fromItemTag(ItemStack stack) {
if (!MinecraftReflection.isCraftItemStack(stack))
throw new IllegalArgumentException("Stack must be a CraftItemStack.");