net.minecraftforge.fluids

Class UniversalBucket

java.lang.Object

net.minecraftforge.registries.ForgeRegistryEntry<Item>

net.minecraft.item.Item

net.minecraftforge.fluids.UniversalBucket

All Implemented Interfaces:

IItemProvider, IForgeItem, IForgeRegistryEntry<Item>

public class UniversalBucket
extends Item

A universal bucket that can hold any liquid

Nested Class Summary

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

Item.Properties

Field Summary

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER, ATTACK_SPEED_MODIFIER, BLOCK_TO_ITEM, canRepair, group, properties, random

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

delegate

Constructor Summary

Constructors

Constructor and Description
UniversalBucket(Item.Properties properties)
UniversalBucket(Item.Properties properties, int capacity, ItemStack empty, boolean nbtSensitive)

Method Summary

Modifier and Type	Method and Description
void	fillItemGroup(ItemGroup tab, NonNullList<ItemStack> subItems)
int	getCapacity()
ItemStack	getContainerItem(ItemStack itemStack) ItemStack sensitive version of getContainerItem.
java.lang.String	getCreatorModId(ItemStack itemStack) Called to get the Mod ID of the mod that *created* the ItemStack, instead of the real Mod ID that *registered* it.
ITextComponent	getDisplayName(ItemStack stack)
ItemStack	getEmpty()
FluidStack	getFluid(ItemStack container)
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(World world, EntityPlayer player, EnumHand hand)

Methods inherited from class net.minecraft.item.Item

addInformation, addPropertyOverride, asItem, canHarvestBlock, canPlayerBreakBlockWhileHolding, getAttributeModifiers, getContainerItem, getDefaultInstance, getDefaultTranslationKey, getDestroySpeed, getGroup, getHarvestLevel, getIdFromItem, getIsRepairable, getItemById, getItemEnchantability, getItemFromBlock, getMaxDamage, getMaxStackSize, getName, getPropertyGetter, getRarity, getShareTag, getTileEntityItemStackRenderer, getToolTypes, getTranslationKey, getTranslationKey, getUseAction, getUseDuration, hasContainerItem, hasCustomProperties, hasEffect, hitEntity, inventoryTick, isComplex, isDamageable, isEnchantable, isIn, isInGroup, isRepairable, itemInteractionForEntity, onBlockDestroyed, onCreated, onItemUse, onItemUseFinish, onPlayerStoppedUsing, rayTrace, register, registerItems, updateItemStackNBT

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.common.extensions.IForgeItem

canApplyAtEnchantingTable, canContinueUsing, canDisableShield, canEquip, canHarvestBlock, createEntity, doesSneakBypassUse, getAnimationParameters, getArmorModel, getArmorTexture, getAttributeModifiers, getBurnTime, getCreativeTabs, getDamage, getDurabilityForDisplay, getEntityLifespan, getEquipmentSlot, getFontRenderer, getHighlightTip, getHorseArmorType, getItem, getItemEnchantability, getItemStackLimit, getMaxDamage, getRGBDurabilityForDisplay, getShareTag, getSmeltingExperience, getXpRepairRatio, hasCustomEntity, isBeaconPayment, isBookEnchantable, isDamaged, isShield, onArmorTick, onBlockStartBreak, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onItemUseFirst, onLeftClickEntity, onUsingTick, readShareTag, renderHelmetOverlay, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, showDurabilityBar

Constructor Detail

UniversalBucket

public UniversalBucket(Item.Properties properties)

UniversalBucket

public UniversalBucket(Item.Properties properties,
                       int capacity,
                       @Nonnull
                       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(@Nonnull
                                ItemStack stack)

Description copied from interface: IForgeItem

ItemStack sensitive version of hasContainerItem

Parameters:

stack - The current item stack

Returns:

True if this item has a 'container'

getContainerItem

@Nonnull
public ItemStack getContainerItem(@Nonnull
                                           ItemStack itemStack)

Description copied from interface: IForgeItem

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

Parameters:

itemStack - The current ItemStack

Returns:

The resulting ItemStack

fillItemGroup

public void fillItemGroup(@Nullable
                          ItemGroup tab,
                          @Nonnull
                          NonNullList<ItemStack> subItems)

Overrides:

fillItemGroup in class Item

getDisplayName

@Nonnull
public ITextComponent getDisplayName(@Nonnull
                                              ItemStack stack)

Overrides:

getDisplayName in class Item

onItemRightClick

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

Overrides:

onItemRightClick in class Item

onFillBucket

public void onFillBucket(FillBucketEvent event)

getFluid

@Nullable
public FluidStack getFluid(@Nonnull
                                     ItemStack container)

getCapacity

public int getCapacity()

getEmpty

@Nonnull
public ItemStack getEmpty()

isNbtSensitive

public boolean isNbtSensitive()

getCreatorModId

@Nullable
public java.lang.String getCreatorModId(@Nonnull
                                                  ItemStack itemStack)

Description copied from interface: IForgeItem

Called to get the Mod ID of the mod that *created* the ItemStack, instead of the real Mod ID that *registered* it. For example the Forge Universal Bucket creates a subitem for each modded fluid, and it returns the modded fluid's Mod ID here. Mods that register subitems for other mods can override this. Informational mods can call it to show the mod that created the item.

Parameters:

itemStack - the ItemStack to check

Returns:

the Mod ID for the ItemStack, or null when there is no specially associated mod and #getRegistryName() would return null.

initCapabilities

public ICapabilityProvider initCapabilities(@Nonnull
                                            ItemStack stack,
                                            NBTTagCompound nbt)

Description copied from interface: IForgeItem

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.

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.