net.darkhax.wawla.utils

Class ItemStackUtils

java.lang.Object

net.darkhax.wawla.utils.ItemStackUtils

public final class ItemStackUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static boolean	areStacksEqual(net.minecraft.item.ItemStack firstStack, net.minecraft.item.ItemStack secondStack, boolean checkNBT) Checks if two given ItemStack are equal.
static boolean	areStacksSimilar(net.minecraft.item.ItemStack firstStack, net.minecraft.item.ItemStack secondStack) Checks to see if two ItemStacks are similar.
static boolean	areStacksSimilarWithSize(net.minecraft.item.ItemStack firstStack, net.minecraft.item.ItemStack secondStack) Checks to see if two ItemStacks are similar.
static boolean	compareStackToOreName(net.minecraft.item.ItemStack stack, java.lang.String oreName) Compares all ore dictionary names associated with an ItemStack, with the provided ore dictionary name.
static net.minecraft.item.ItemStack	consumeStack(net.minecraft.item.ItemStack stack) Safely consumes an item from an ItemStack.
static net.minecraft.item.ItemStack	copyStackWithSize(net.minecraft.item.ItemStack stack, int size) Copies an ItemStack with a new size value.
static net.minecraft.item.ItemStack	createStackFromString(java.lang.String stackString) Reads an ItemStack from a string This method is intended for use in reading information from a configuration file.
static net.minecraft.item.ItemStack	createStackFromTileEntity(net.minecraft.tileentity.TileEntity tile) Creates an ItemStack which represents a TileEntity, and has all of the TileEntities properties stored.
static net.minecraft.item.ItemStack	decreaseStackSize(net.minecraft.item.ItemStack stack, int amount) Safely decreases the amount of items held by an ItemStack.
static boolean	doStacksShareOreName(net.minecraft.item.ItemStack firstStack, net.minecraft.item.ItemStack secondStack) Compares all applicable ore dictionary names for two item stacks, to see if either have a name in common.
static void	dropStackInWorld(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.item.ItemStack stack) Safely drops an ItemStack intot he world.
static net.minecraft.block.Block	getBlockFromStack(net.minecraft.item.ItemStack stack) Safely gets a block instance from an ItemStack.
static net.minecraft.item.ItemStack	getStackFromState(net.minecraft.block.state.IBlockState state, int size) Creates an ItemStack representation of an IBlockState.
static java.lang.Object	getThingByName(java.lang.String name) A blend between the itemRegistry.getObject and bockRegistry.getObject methods.
static boolean	isStackInArray(net.minecraft.item.ItemStack stack, boolean checkNBT, net.minecraft.item.ItemStack... stacks) A check to see if an ItemStack exists within an array of other ItemStack.
static net.minecraft.nbt.NBTTagCompound	prepareDataTag(net.minecraft.item.ItemStack stack) Sets a stack compound to an ItemStack if it does not already have one.
static void	readTileEntityFromStack(net.minecraft.tileentity.TileEntity tile, net.minecraft.item.ItemStack stack) Reads tile entity data from an ItemStack.
static net.minecraft.item.ItemStack	setLore(net.minecraft.item.ItemStack stack, java.lang.String[] lore) Sets the lore for an ItemStack.
static net.minecraft.item.ItemStack	writePotionEffectsToStack(net.minecraft.item.ItemStack stack, net.minecraft.potion.PotionEffect[] effects)
static java.lang.String	writeStackToString(net.minecraft.item.ItemStack stack) Writes an ItemStack as a String.
static void	writeStackToTag(net.minecraft.item.ItemStack stack, net.minecraft.nbt.NBTTagCompound tag, java.lang.String tagName) Writes an ItemStack as a sub NBTTagCompound on a larger NBTTagCompound.

Methods inherited from class java.lang.Object

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

Method Detail

prepareDataTag

public static net.minecraft.nbt.NBTTagCompound prepareDataTag(net.minecraft.item.ItemStack stack)

Sets a stack compound to an ItemStack if it does not already have one.

Parameters:

stackItemStack - having a tag set on it.

setLore

public static net.minecraft.item.ItemStack setLore(net.minecraft.item.ItemStack stack,
                                                   java.lang.String[] lore)

Sets the lore for an ItemStack. This will override any existing lore on that item.

Parameters:

stackAn - instance of an ItemStack to write the lore to.

loreAn - array containing the lore to write. Each line is a new entry.

Returns:

ItemStackThe same instance of ItemStack that was passed to this method.

writeStackToString

public static java.lang.String writeStackToString(net.minecraft.item.ItemStack stack)

Writes an ItemStack as a String. This method is intended for use in configuration files, and allows for a damage sensitive item to be represented as a String. The format looks like "itemid#damage". This method is not intended for actually saving an ItemStack.

Parameters:

stackThe - instance of ItemStack to write.

Returns:

StringA string which can be used to represent a damage sensitive item.

createStackFromString

public static net.minecraft.item.ItemStack createStackFromString(java.lang.String stackString)

Reads an ItemStack from a string This method is intended for use in reading information from a configuration file. The correct format is "itemid#damage". This method is intended for use with writeStackToString.

Parameters:

stackStringThe - string used to construct an ItemStack.

Returns:

ItemStackAn ItemStack representation of a damage sensitive item.

compareStackToOreName

public static boolean compareStackToOreName(net.minecraft.item.ItemStack stack,
                                            java.lang.String oreName)

Compares all ore dictionary names associated with an ItemStack, with the provided ore dictionary name.

Parameters:

stackThe - ItemStack to compare against.

oreNameThe - ore dictionary name to compare to.

Returns:

booleanTrue if any of the ore dictionary entries for the provided stack match the provided ore name.

doStacksShareOreName

public static boolean doStacksShareOreName(net.minecraft.item.ItemStack firstStack,
                                           net.minecraft.item.ItemStack secondStack)

Compares all applicable ore dictionary names for two item stacks, to see if either have a name in common.

Parameters:

firstStackThe - first ItemStack to compare.

secondStackThe - second ItemStack to compare.

Returns:

booleanTrue, if any of the ore dictionary names for either stack are the same.

areStacksSimilar

public static boolean areStacksSimilar(@Nonnull
                                       net.minecraft.item.ItemStack firstStack,
                                       @Nonnull
                                       net.minecraft.item.ItemStack secondStack)

Checks to see if two ItemStacks are similar. A similar stack has the same item, and the same damage.

Parameters:

firstStackThe - first stack to check.

secondStackThe - second stack to check.

Returns:

booleanTrue if stacks are similar, or if both are null.

areStacksSimilarWithSize

public static boolean areStacksSimilarWithSize(@Nonnull
                                               net.minecraft.item.ItemStack firstStack,
                                               @Nonnull
                                               net.minecraft.item.ItemStack secondStack)

Checks to see if two ItemStacks are similar. A similar stack has the same item, and the same damage and same size.

Parameters:

firstStackThe - first stack to check.

secondStackThe - second stack to check.

Returns:

booleanTrue if stacks are similar, or if both are null.

writePotionEffectsToStack

public static net.minecraft.item.ItemStack writePotionEffectsToStack(@Nonnull
                                                                     net.minecraft.item.ItemStack stack,
                                                                     net.minecraft.potion.PotionEffect[] effects)

writeStackToTag

public static void writeStackToTag(@Nonnull
                                   net.minecraft.item.ItemStack stack,
                                   net.minecraft.nbt.NBTTagCompound tag,
                                   java.lang.String tagName)

Writes an ItemStack as a sub NBTTagCompound on a larger NBTTagCompound.

Parameters:

stackThe - ItemStack to write to the tag.

tagThe - NBTTagCompound to write the stack to.

tagNameThe - name for this new NBTTagCompound entry.

decreaseStackSize

public static net.minecraft.item.ItemStack decreaseStackSize(net.minecraft.item.ItemStack stack,
                                                             int amount)

Safely decreases the amount of items held by an ItemStack.

Parameters:

stackThe - ItemStack to decrease the size of.

amountThe - amount to decrease the stack size by.

Returns:

ItemStackNull, if the stack size is smaller than 1.

areStacksEqual

public static boolean areStacksEqual(net.minecraft.item.ItemStack firstStack,
                                     net.minecraft.item.ItemStack secondStack,
                                     boolean checkNBT)

Checks if two given ItemStack are equal. For them to be equal, both must be null, or both must have a null item, or both must share a damage value. If either stack has a wild card damage value, they will also be considered the same. If the checkNBT parameter is true, they will also need the same item nbt.

Parameters:

firstStack - The first ItemStack to compare.

secondStack - The second ItemStack to compare.

checkNBT - Should NBT be checked as well?

Returns:

boolean Whether or not the items are close enough to be called the same.

isStackInArray

public static boolean isStackInArray(net.minecraft.item.ItemStack stack,
                                     boolean checkNBT,
                                     net.minecraft.item.ItemStack... stacks)

A check to see if an ItemStack exists within an array of other ItemStack.

Parameters:

stackThe - ItemStack you are searching for.

checkNBTShould - the stacks need the same NBT for them to be the same?

stacksThe - array of ItemStack to search through.

Returns:

booleanWhether or not the array contains the stack you are looking for.

copyStackWithSize

public static net.minecraft.item.ItemStack copyStackWithSize(net.minecraft.item.ItemStack stack,
                                                             int size)

Copies an ItemStack with a new size value.

Parameters:

stack - The ItemStack to copy.

size - The new size to set for the stack.

Returns:

ItemStack A new ItemStack with the same item and meta as the original, but with a new size.

getThingByName

public static java.lang.Object getThingByName(java.lang.String name)

A blend between the itemRegistry.getObject and bockRegistry.getObject methods. Used for grabbing something from an ID, when you have no clue what it might be.

Parameters:

name - The ID of the thing you're looking for. Domains are often preferred.

Returns:

Hopefully the thing you're looking for.

getBlockFromStack

public static net.minecraft.block.Block getBlockFromStack(net.minecraft.item.ItemStack stack)

Safely gets a block instance from an ItemStack. If the ItemStack is not valid, null will be returned. Null can also be returned if the Item does not have a block form.

Parameters:

stack - The ItemStack to get a block from.

Returns:

The block version of the item contained in the ItemStack.

consumeStack

public static net.minecraft.item.ItemStack consumeStack(net.minecraft.item.ItemStack stack)

Safely consumes an item from an ItemStack. Respects container items.

Parameters:

stack - The stack to use.

Returns:

The remaining/generated item.

dropStackInWorld

public static void dropStackInWorld(net.minecraft.world.World world,
                                    net.minecraft.util.math.BlockPos pos,
                                    net.minecraft.item.ItemStack stack)

Safely drops an ItemStack intot he world. Used for mob drops.

Parameters:

world - The world to drop the item in.

pos - The base pos to drop the item.

stack - The stack to drop.

createStackFromTileEntity

public static net.minecraft.item.ItemStack createStackFromTileEntity(net.minecraft.tileentity.TileEntity tile)

Creates an ItemStack which represents a TileEntity, and has all of the TileEntities properties stored.

Parameters:

tile - The TileEntity to turn into an ItemStack.

Returns:

The resulting ItemStack.

readTileEntityFromStack

public static void readTileEntityFromStack(net.minecraft.tileentity.TileEntity tile,
                                           net.minecraft.item.ItemStack stack)

Reads tile entity data from an ItemStack. Meant to be an inverse of createStackFromTileEntity(TileEntity).

Parameters:

tile - The tile to apply the changes to.

stack - The stack to read from.

getStackFromState

public static net.minecraft.item.ItemStack getStackFromState(net.minecraft.block.state.IBlockState state,
                                                             int size)

Creates an ItemStack representation of an IBlockState.

Parameters:

state - The state to use.

size - The stack size to create.

Returns:

An ItemStack which represents the passed state.