net.minecraftforge.fluids

Class UniversalBucket

java.lang.Object

net.minecraft.item.Item

net.minecraftforge.fluids.UniversalBucket

All Implemented Interfaces:

IFluidContainerItem

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

Field Summary

Fields

Modifier and Type	Field and Description
int	capacity
ItemStack	empty
boolean	nbtSensitive

Fields inherited from class net.minecraft.item.Item

bFull3D, canRepair, delegate, hasSubtypes, itemModifierUUID, itemRand, itemRegistry, maxStackSize

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(ItemStack container)
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) returns a list of items with the same ID, but different meta (eg: dye returns 16 items)
void	onFillBucket(FillBucketEvent event)
ItemStack	onItemRightClick(ItemStack itemstack, World world, EntityPlayer player) Called whenever this item is equipped and the right mouse button is pressed.
boolean	tryPlaceFluid(Block block, World worldIn, BlockPos pos)

Methods inherited from class net.minecraft.item.Item

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

Methods inherited from class java.lang.Object

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

Field Detail

capacity

public final int capacity

empty

public final ItemStack empty

nbtSensitive

public final boolean nbtSensitive

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

getSubItems

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

returns a list of items with the same ID, but different meta (eg: dye returns 16 items)

Overrides:

getSubItems in class Item

getItemStackDisplayName

public java.lang.String getItemStackDisplayName(ItemStack stack)

Overrides:

getItemStackDisplayName in class Item

onItemRightClick

public ItemStack onItemRightClick(ItemStack itemstack,
                                  World world,
                                  EntityPlayer player)

Called whenever this item is equipped and the right mouse button is pressed. Args: itemStack, world, entityPlayer

Overrides:

onItemRightClick in class Item

tryPlaceFluid

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

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.

Returns:

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