net.minecraftforge.fluids

Class UniversalBucket

java.lang.Object

net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl<Item>

net.minecraft.item.Item

net.minecraftforge.fluids.UniversalBucket

All Implemented Interfaces:

IFluidContainerItem, IForgeRegistryEntry<Item>

public class UniversalBucket
extends Item
implements IFluidContainerItem

A universal bucket that can hold any liquid

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.item.Item

Item.ToolMaterial

Nested classes/interfaces inherited from interface net.minecraftforge.fml.common.registry.IForgeRegistryEntry

IForgeRegistryEntry.Impl<T extends IForgeRegistryEntry<T>>

Field Summary

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER, ATTACK_SPEED_MODIFIER, bFull3D, canRepair, hasSubtypes, itemRand, maxStackSize, REGISTRY

Fields inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl

delegate

Constructor Summary

Constructors

Constructor and Description
UniversalBucket()
UniversalBucket(int capacity, ItemStack empty, boolean nbtSensitive)

Method Summary

Modifier and Type	Method and Description
FluidStack	drain(ItemStack container, int maxDrain, boolean doDrain)
int	fill(ItemStack container, FluidStack resource, boolean doFill)
int	getCapacity()
int	getCapacity(ItemStack container)
ItemStack	getContainerItem(ItemStack itemStack) ItemStack sensitive version of getContainerItem.
ItemStack	getEmpty()
static ItemStack	getFilledBucket(UniversalBucket item, Fluid fluid)
FluidStack	getFluid(ItemStack container)
java.lang.String	getItemStackDisplayName(ItemStack stack)
void	getSubItems(Item itemIn, CreativeTabs tab, java.util.List<ItemStack> subItems)
boolean	hasContainerItem(ItemStack stack) ItemStack sensitive version of hasContainerItem
ICapabilityProvider	initCapabilities(ItemStack stack, NBTTagCompound nbt) Called from ItemStack.setItem, will hold extra data for the life of this ItemStack.
boolean	isNbtSensitive()
void	onFillBucket(FillBucketEvent event)
ActionResult<ItemStack>	onItemRightClick(ItemStack itemstack, World world, EntityPlayer player, EnumHand hand)
boolean	tryPlaceFluid(Block block, World worldIn, BlockPos pos) Deprecated.

Methods inherited from class net.minecraft.item.Item

addInformation, addPropertyOverride, canHarvestBlock, canHarvestBlock, canItemEditBlocks, createEntity, doesSneakBypassUse, getAnimationParameters, getArmorModel, getArmorTexture, getAttributeModifiers, getByNameOrId, getContainerItem, getCreativeTab, getCreativeTabs, getDamage, getDurabilityForDisplay, getEntityLifespan, getFontRenderer, getHarvestLevel, getHarvestLevel, getHasSubtypes, getHighlightTip, getIdFromItem, getIsRepairable, getItemAttributeModifiers, getItemById, getItemEnchantability, getItemEnchantability, getItemFromBlock, getItemStackLimit, getItemStackLimit, getItemUseAction, getMaxDamage, getMaxDamage, getMaxItemUseDuration, getMetadata, getMetadata, getNBTShareTag, getPropertyGetter, getRarity, getShareTag, getSmeltingExperience, getStrVsBlock, getToolClasses, getUnlocalizedName, getUnlocalizedName, getUnlocalizedNameInefficiently, hasContainerItem, hasCustomEntity, hasCustomProperties, hasEffect, hitEntity, isBeaconPayment, isBookEnchantable, isDamageable, isDamaged, isFull3D, isItemTool, isMap, isRepairable, isValidArmor, itemInteractionForEntity, onArmorTick, onBlockDestroyed, onBlockStartBreak, onCreated, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onItemUse, onItemUseFinish, onItemUseFirst, onLeftClickEntity, onPlayerStoppedUsing, onUpdate, onUsingTick, rayTrace, registerItemBlock, registerItems, renderHelmetOverlay, setContainerItem, setCreativeTab, setDamage, setFull3D, setHarvestLevel, setHasSubtypes, setMaxDamage, setMaxStackSize, setNoRepair, setUnlocalizedName, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, shouldRotateAroundWhenRendering, showDurabilityBar, updateItemStackNBT

Methods inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

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

Constructor Detail

UniversalBucket

public UniversalBucket()

UniversalBucket

public UniversalBucket(int capacity,
                       ItemStack empty,
                       boolean nbtSensitive)

Parameters:

capacity - Capacity of the container

empty - Item used for filling with the bucket event and returned when emptied

nbtSensitive - Whether the empty item is NBT sensitive (usually true if empty and full are the same items)

Method Detail

hasContainerItem

public boolean hasContainerItem(ItemStack stack)

Description copied from class: Item

ItemStack sensitive version of hasContainerItem

Overrides:

hasContainerItem in class Item

Parameters:

stack - The current item stack

Returns:

True if this item has a 'container'

getContainerItem

public ItemStack getContainerItem(ItemStack itemStack)

Description copied from class: Item

ItemStack sensitive version of getContainerItem. Returns a full ItemStack instance of the result.

Overrides:

getContainerItem in class Item

Parameters:

itemStack - The current ItemStack

Returns:

The resulting ItemStack

getSubItems

public void getSubItems(Item itemIn,
                        CreativeTabs tab,
                        java.util.List<ItemStack> subItems)

Overrides:

getSubItems in class Item

getItemStackDisplayName

public java.lang.String getItemStackDisplayName(ItemStack stack)

Overrides:

getItemStackDisplayName in class Item

onItemRightClick

public ActionResult<ItemStack> onItemRightClick(ItemStack itemstack,
                                                World world,
                                                EntityPlayer player,
                                                EnumHand hand)

Overrides:

onItemRightClick in class Item

tryPlaceFluid

@Deprecated
public boolean tryPlaceFluid(Block block,
                                          World worldIn,
                                          BlockPos pos)

Deprecated.

onFillBucket

public void onFillBucket(FillBucketEvent event)

getFilledBucket

public static ItemStack getFilledBucket(UniversalBucket item,
                                        Fluid fluid)

getFluid

public FluidStack getFluid(ItemStack container)

Specified by:

getFluid in interface IFluidContainerItem

Parameters:

container - ItemStack which is the fluid container.

Returns:

FluidStack representing the fluid in the container, null if the container is empty.

getCapacity

public int getCapacity(ItemStack container)

Specified by:

getCapacity in interface IFluidContainerItem

Parameters:

container - ItemStack which is the fluid container.

Returns:

Capacity of this fluid container.

fill

public int fill(ItemStack container,
                FluidStack resource,
                boolean doFill)

Specified by:

fill in interface IFluidContainerItem

Parameters:

container - ItemStack which is the fluid container.

resource - FluidStack attempting to fill the container.

doFill - If false, the fill will only be simulated.

Returns:

Amount of fluid that was (or would have been, if simulated) filled into the container.

drain

public FluidStack drain(ItemStack container,
                        int maxDrain,
                        boolean doDrain)

Specified by:

drain in interface IFluidContainerItem

Parameters:

container - ItemStack which is the fluid container.

maxDrain - Maximum amount of fluid to be removed from the container.

doDrain - If false, the drain will only be simulated.

Returns:

Amount of fluid that was (or would have been, if simulated) drained from the container.

getCapacity

public int getCapacity()

getEmpty

public ItemStack getEmpty()

isNbtSensitive

public boolean isNbtSensitive()

initCapabilities

public ICapabilityProvider initCapabilities(ItemStack stack,
                                            NBTTagCompound nbt)

Description copied from class: Item

Called from ItemStack.setItem, will hold extra data for the life of this ItemStack. Can be retrieved from stack.getCapabilities() The NBT can be null if this is not called from readNBT or if the item the stack is changing FROM is different then this item, or the previous item had no capabilities. This is called BEFORE the stacks item is set so you can use stack.getItem() to see the OLD item. Remember that getItem CAN return null.

Overrides:

initCapabilities in class Item

Parameters:

stack - The ItemStack

nbt - NBT of this item serialized, or null.

Returns:

A holder instance associated with this ItemStack where you can hold capabilities for the life of this item.