net.darkhax.wawla.utils

Class NBTUtils

java.lang.Object

net.darkhax.wawla.utils.NBTUtils

public final class NBTUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<net.minecraft.nbt.NBTTagCompound>	NBT_COMPARATOR A Comparator used to compare NBTTagCompound.

Method Summary

Modifier and Type	Method and Description
static net.minecraft.nbt.NBTTagCompound	getDeepTagCompound(net.minecraft.nbt.NBTTagCompound tag, java.lang.String[] tags) Provides a way to access an NBTTagCompound that is very deep within another NBTTagCompound.
static net.minecraft.item.ItemStack[]	getStoredItems(net.minecraft.nbt.NBTTagCompound tag, int invSize) Retrieves an array of ItemStack from an NBTTagCompound.
static net.minecraft.inventory.InventoryBasic	readInventoryFromNBT(net.minecraft.nbt.NBTTagCompound tag, net.minecraft.inventory.InventoryBasic inventory) Reads an inventory from an NBTTagCompound.
static void	setGenericNBTValue(net.minecraft.nbt.NBTTagCompound dataTag, java.lang.String tagName, java.lang.Object value) Sets an unknown data type to an NBTTagCompound.
static net.minecraft.nbt.NBTTagCompound	writeInventoryToNBT(net.minecraft.nbt.NBTTagCompound tag, net.minecraft.inventory.InventoryBasic inventory) Writes an inventory to an NBTTagCompound.

Methods inherited from class java.lang.Object

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

Field Detail

NBT_COMPARATOR

public static final java.util.Comparator<net.minecraft.nbt.NBTTagCompound> NBT_COMPARATOR

A Comparator used to compare NBTTagCompound.

Method Detail

setGenericNBTValue

public static void setGenericNBTValue(net.minecraft.nbt.NBTTagCompound dataTag,
                                      java.lang.String tagName,
                                      java.lang.Object value)

Sets an unknown data type to an NBTTagCompound. If the type of the data can not be identified, and exception will be thrown. Current supported data types include String, Integer, Float, Boolean, Double, Long, Short, Byte, ItemStack, Entity and Position.

Parameters:

dataTag: - An NBTTagCompound to write this unknown data to.

tagName: - The name to save this unknown data under.

value: - The unknown data you wish to write to the dataTag.

writeInventoryToNBT

public static net.minecraft.nbt.NBTTagCompound writeInventoryToNBT(net.minecraft.nbt.NBTTagCompound tag,
                                                                   net.minecraft.inventory.InventoryBasic inventory)

Writes an inventory to an NBTTagCompound. Can be used to save an inventory in a TileEntity, or perhaps an ItemStack.

Parameters:

tag: - The NBTTagCompound to write the inventory to.

inventory: - The inventory to write to the NBTTagCompound.

Returns:

NBTTagCompound: The same NBTTagCompound that was passed to this method.

readInventoryFromNBT

public static net.minecraft.inventory.InventoryBasic readInventoryFromNBT(net.minecraft.nbt.NBTTagCompound tag,
                                                                          net.minecraft.inventory.InventoryBasic inventory)

Reads an inventory from an NBTTagCompound. Can be used to load an Inventory from a TileEntity or perhaps an ItemStak.

Parameters:

tag: - The NBTTagCompound to read the inventory data from.

inventory: - The inventory to set all of the inventory data to.

Returns:

InventoryBasic: The same instance of InventoryBasic that was passed to this method.

getStoredItems

public static net.minecraft.item.ItemStack[] getStoredItems(net.minecraft.nbt.NBTTagCompound tag,
                                                            int invSize)

Retrieves an array of ItemStack from an NBTTagCompound. This method is intended to be used with the NBT version of an IInventory and can be used when parsing things like TileEntity NBT data.

Parameters:

tag: - The tag to retrieve all of the item data from.

invSize: - The projected size of the inventory stored to the tag. It is critical that this never be smaller then the actual amount.

Returns:

ItemStack[]: An array of ItemStack stored on the NBTTagCompound.

getDeepTagCompound

public static net.minecraft.nbt.NBTTagCompound getDeepTagCompound(net.minecraft.nbt.NBTTagCompound tag,
                                                                  java.lang.String[] tags)

Provides a way to access an NBTTagCompound that is very deep within another NBTTagCompound. This will allow you to use an array of strings which represent the different steps to get to the deep NBTTagCompound.

Parameters:

tag: - An NBTTagCompound to search through.

tags: - An array containing the various steps to get to the desired deep NBTTagCompound.

Returns:

NBTTagCompound: This method will return the deepest possible NBTTagCompound. In some cases, this may be the tag you provide, or only a few steps deep, rather than all of the way.