com.austinv11.collectiveframework.minecraft.utils

Class NBTHelper

java.lang.Object

com.austinv11.collectiveframework.minecraft.utils.NBTHelper

public class NBTHelper
extends java.lang.Object

This is a class to ease the use of NBTTags with ItemStacks. All methods will initialize an NBT Tag if none exists on the passed ItemStack

Constructor Summary

Constructors

Constructor and Description
NBTHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addInfo(net.minecraft.item.ItemStack itemStack, java.util.List<java.lang.String> text) Appends an item description to the stack
static boolean	getBoolean(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static byte	getByte(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static net.minecraft.nbt.NBTTagCompound	getCompoundTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a compound tag for the provided key in the passed ItemStack
static double	getDouble(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static float	getFloat(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static int	getInt(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static int[]	getIntArray(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static net.minecraft.nbt.NBTTagList	getList(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, int type) Gets the NBTTagList for the provided key in the passed ItemStack
static long	getLong(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static short	getShort(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static java.lang.String	getString(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a value for the given key from the passed ItemStack
static net.minecraft.nbt.NBTBase	getTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Gets a tag for the provided key in the passed ItemStack
static boolean	hasTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Checks if the passed ItemStack contains the given tag in its NBTData
static void	removeInfo(net.minecraft.item.ItemStack itemStack) Removes the item description to the stack
static void	removeTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName) Removes the specified tag from the stack's NBTData
static void	setBoolean(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, boolean keyValue) Sets the value of the provided key on the passed ItemStack
static void	setByte(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, byte keyValue) Sets the value of the provided key on the passed ItemStack
static void	setCompoundTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, net.minecraft.nbt.NBTTagCompound tag) Sets a compound tag for the provided key in the passed ItemStack
static void	setDouble(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, double keyValue) Sets the value of the provided key on the passed ItemStack
static void	setFloat(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, float keyValue) Sets the value of the provided key on the passed ItemStack
static void	setInfo(net.minecraft.item.ItemStack itemStack, java.util.List<java.lang.String> text) Sets an item description to the stack
static void	setIntArray(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, int[] array) Sets the value of the provided key on the passed ItemStack
static void	setInteger(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, int keyValue) Sets the value of the provided key on the passed ItemStack
static void	setList(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, net.minecraft.nbt.NBTTagList tag) Sets the NBTTagList for the provided key in the passed ItemStack
static void	setLong(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, long keyValue) Sets the value of the provided key on the passed ItemStack
static void	setShort(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, short keyValue) Sets the value of the provided key on the passed ItemStack
static void	setString(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, java.lang.String keyValue) Sets the value of the provided key on the passed ItemStack
static void	setTag(net.minecraft.item.ItemStack itemStack, java.lang.String keyName, net.minecraft.nbt.NBTBase tag) Sets a tag for the provided key in the passed ItemStack

Methods inherited from class java.lang.Object

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

Constructor Detail

NBTHelper

public NBTHelper()

Method Detail

hasTag

public static boolean hasTag(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName)

Checks if the passed ItemStack contains the given tag in its NBTData

Parameters:

itemStack - The stack

keyName - The key for the tag

Returns:

True if the stack contains the key

removeTag

public static void removeTag(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName)

Removes the specified tag from the stack's NBTData

Parameters:

itemStack - The stack

keyName - The key representing the tag

getLong

public static long getLong(net.minecraft.item.ItemStack itemStack,
           java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setLong

public static void setLong(net.minecraft.item.ItemStack itemStack,
           java.lang.String keyName,
           long keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getString

public static java.lang.String getString(net.minecraft.item.ItemStack itemStack,
                         java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setString

public static void setString(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName,
             java.lang.String keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getBoolean

public static boolean getBoolean(net.minecraft.item.ItemStack itemStack,
                 java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setBoolean

public static void setBoolean(net.minecraft.item.ItemStack itemStack,
              java.lang.String keyName,
              boolean keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getByte

public static byte getByte(net.minecraft.item.ItemStack itemStack,
           java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setByte

public static void setByte(net.minecraft.item.ItemStack itemStack,
           java.lang.String keyName,
           byte keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getShort

public static short getShort(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setShort

public static void setShort(net.minecraft.item.ItemStack itemStack,
            java.lang.String keyName,
            short keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getInt

public static int getInt(net.minecraft.item.ItemStack itemStack,
         java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setInteger

public static void setInteger(net.minecraft.item.ItemStack itemStack,
              java.lang.String keyName,
              int keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getFloat

public static float getFloat(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setFloat

public static void setFloat(net.minecraft.item.ItemStack itemStack,
            java.lang.String keyName,
            float keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getDouble

public static double getDouble(net.minecraft.item.ItemStack itemStack,
               java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setDouble

public static void setDouble(net.minecraft.item.ItemStack itemStack,
             java.lang.String keyName,
             double keyValue)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

keyValue - The value for the key

getList

public static net.minecraft.nbt.NBTTagList getList(net.minecraft.item.ItemStack itemStack,
                                   java.lang.String keyName,
                                   int type)

Gets the NBTTagList for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

type - The type of tag list, see Constants.NBT

Returns:

The list

setList

public static void setList(net.minecraft.item.ItemStack itemStack,
           java.lang.String keyName,
           net.minecraft.nbt.NBTTagList tag)

Sets the NBTTagList for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

tag - The tag list

addInfo

public static void addInfo(net.minecraft.item.ItemStack itemStack,
           java.util.List<java.lang.String> text)

Appends an item description to the stack

Parameters:

itemStack - The stack

text - The text for the description

setInfo

public static void setInfo(net.minecraft.item.ItemStack itemStack,
           java.util.List<java.lang.String> text)

Sets an item description to the stack

Parameters:

itemStack - The stack

text - The text for the description

removeInfo

public static void removeInfo(net.minecraft.item.ItemStack itemStack)

Removes the item description to the stack

Parameters:

itemStack - The stack

setTag

public static void setTag(net.minecraft.item.ItemStack itemStack,
          java.lang.String keyName,
          net.minecraft.nbt.NBTBase tag)

Sets a tag for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

tag - The tag

getTag

public static net.minecraft.nbt.NBTBase getTag(net.minecraft.item.ItemStack itemStack,
                               java.lang.String keyName)

Gets a tag for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The tag

setIntArray

public static void setIntArray(net.minecraft.item.ItemStack itemStack,
               java.lang.String keyName,
               int[] array)

Sets the value of the provided key on the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key representing the value

array - The value for the key

getIntArray

public static int[] getIntArray(net.minecraft.item.ItemStack itemStack,
                java.lang.String keyName)

Gets a value for the given key from the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The value

setCompoundTag

public static void setCompoundTag(net.minecraft.item.ItemStack itemStack,
                  java.lang.String keyName,
                  net.minecraft.nbt.NBTTagCompound tag)

Sets a compound tag for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

tag - The tag

getCompoundTag

public static net.minecraft.nbt.NBTTagCompound getCompoundTag(net.minecraft.item.ItemStack itemStack,
                                              java.lang.String keyName)

Gets a compound tag for the provided key in the passed ItemStack

Parameters:

itemStack - The stack

keyName - The key

Returns:

The tag