Package net.minecraftforge.fluids.capability

Class ItemFluidContainer

java.lang.Object

net.minecraft.world.item.Item

net.minecraftforge.fluids.capability.ItemFluidContainer

All Implemented Interfaces:

FeatureElement, ItemLike, IForgeItem

public class ItemFluidContainer
extends Item

A simple fluid container, to replace the functionality of the old FluidContainerRegistry and IFluidContainerItem. This fluid container may be set so that is can only completely filled or empty. (binary) It may also be set so that it gets consumed when it is drained. (consumable)

Nested Class Summary

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

Item.Properties

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	capacity

Fields inherited from class net.minecraft.world.item.Item

BASE_ATTACK_DAMAGE_UUID, BASE_ATTACK_SPEED_UUID, BY_BLOCK, canRepair, EAT_DURATION, MAX_BAR_WIDTH, MAX_STACK_SIZE

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
ItemFluidContainer(Item.Properties properties, int capacity)

Method Summary

Modifier and Type	Method	Description
ICapabilityProvider	initCapabilities(@NotNull ItemStack stack, @Nullable CompoundTag nbt)	Called from ItemStack.setItem, will hold extra data for the life of this ItemStack.

Methods inherited from class net.minecraft.world.item.Item

appendHoverText, asItem, builtInRegistryHolder, byBlock, byId, canAttackBlock, canBeDepleted, canBeHurtBy, canFitInsideContainerItems, finishUsingItem, getBarColor, getBarWidth, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultInstance, getDescription, getDescriptionId, getDescriptionId, getDestroySpeed, getDrinkingSound, getEatingSound, getEnchantmentValue, getFoodProperties, getId, getMaxDamage, getMaxStackSize, getName, getOrCreateDescriptionId, getPlayerPOVHitResult, getRarity, getRenderPropertiesInternal, getTooltipImage, getUseAnimation, getUseDuration, hasCraftingRemainingItem, hurtEnemy, initializeClient, interactLivingEntity, inventoryTick, isBarVisible, isComplex, isCorrectToolForDrops, isEdible, isEnchantable, isFireResistant, isFoil, isRepairable, isValidRepairItem, mineBlock, onCraftedBy, onDestroyed, onUseTick, overrideOtherStackedOnMe, overrideStackedOnOther, releaseUsing, requiredFeatures, shouldOverrideMultiplayerNbt, toString, use, useOn, useOnRelease, verifyTagAfterLoad

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

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

canApplyAtEnchantingTable, canContinueUsing, canDisableShield, canElytraFly, canEquip, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getAllEnchantments, getArmorTexture, getAttributeModifiers, getBurnTime, getCraftingRemainingItem, getCreatorModId, getDamage, getDefaultTooltipHideFlags, getEnchantmentLevel, getEnchantmentValue, getEntityLifespan, getEquipmentSlot, getFoodProperties, getHighlightTip, getMaxDamage, getMaxStackSize, getShareTag, getSweepHitBox, getXpRepairRatio, hasCraftingRemainingItem, hasCustomEntity, isBookEnchantable, isCorrectToolForDrops, isDamageable, isDamaged, isEnderMask, isNotReplaceableByPickAction, isPiglinCurrency, makesPiglinsNeutral, onArmorTick, onBlockStartBreak, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onInventoryTick, onItemUseFirst, onLeftClickEntity, onStopUsing, readShareTag, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation

Field Details

capacity

protected final int capacity

Constructor Details

ItemFluidContainer

public ItemFluidContainer(Item.Properties properties,
 int capacity)

Parameters:

capacity - The maximum capacity of this fluid container.

Method Details

initCapabilities

public ICapabilityProvider initCapabilities(@NotNull
 @NotNull ItemStack stack,
 @Nullable
 @Nullable CompoundTag 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.