Package net.minecraft.block.cauldron

Interface CauldronBehavior

public interface CauldronBehavior
Cauldron behaviors control what happens when a player interacts with cauldrons using a specific item.

To register new cauldron behaviors, you can add them to the corresponding maps based on the cauldron type.

Behavior maps by cauldron type
Type Block Behavior map
Empty minecraft:cauldron EMPTY_CAULDRON_BEHAVIOR
Water minecraft:water_cauldron WATER_CAULDRON_BEHAVIOR
Lava minecraft:lava_cauldron LAVA_CAULDRON_BEHAVIOR
Powder snow minecraft:powder_snow_cauldron POWDER_SNOW_CAULDRON_BEHAVIOR
Mappings:
Namespace Name
named net/minecraft/block/cauldron/CauldronBehavior
intermediary net/minecraft/class_5620
official kg

  • Field Details

    • BEHAVIOR_MAPS

      static final Map<String,CauldronBehavior.CauldronBehaviorMap> BEHAVIOR_MAPS
      Mappings:
      Namespace Name Mixin selector
      named BEHAVIOR_MAPS Lnet/minecraft/block/cauldron/CauldronBehavior;BEHAVIOR_MAPS:Ljava/util/Map;
      intermediary field_46589 Lnet/minecraft/class_5620;field_46589:Ljava/util/Map;
      official a Lkg;a:Ljava/util/Map;

    • CODEC

      static final com.mojang.serialization.Codec<CauldronBehavior.CauldronBehaviorMap> CODEC
      Mappings:
      Namespace Name Mixin selector
      named CODEC Lnet/minecraft/block/cauldron/CauldronBehavior;CODEC:Lcom/mojang/serialization/Codec;
      intermediary field_46590 Lnet/minecraft/class_5620;field_46590:Lcom/mojang/serialization/Codec;
      official b Lkg;b:Lcom/mojang/serialization/Codec;

    • EMPTY_CAULDRON_BEHAVIOR

      static final CauldronBehavior.CauldronBehaviorMap EMPTY_CAULDRON_BEHAVIOR
      The cauldron behaviors for empty cauldrons.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named EMPTY_CAULDRON_BEHAVIOR Lnet/minecraft/block/cauldron/CauldronBehavior;EMPTY_CAULDRON_BEHAVIOR:Lnet/minecraft/block/cauldron/CauldronBehavior$CauldronBehaviorMap;
      intermediary field_27775 Lnet/minecraft/class_5620;field_27775:Lnet/minecraft/class_5620$class_8821;
      official c Lkg;c:Lkg$a;

    • WATER_CAULDRON_BEHAVIOR

      static final CauldronBehavior.CauldronBehaviorMap WATER_CAULDRON_BEHAVIOR
      The cauldron behaviors for water cauldrons.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named WATER_CAULDRON_BEHAVIOR Lnet/minecraft/block/cauldron/CauldronBehavior;WATER_CAULDRON_BEHAVIOR:Lnet/minecraft/block/cauldron/CauldronBehavior$CauldronBehaviorMap;
      intermediary field_27776 Lnet/minecraft/class_5620;field_27776:Lnet/minecraft/class_5620$class_8821;
      official d Lkg;d:Lkg$a;

    • LAVA_CAULDRON_BEHAVIOR

      static final CauldronBehavior.CauldronBehaviorMap LAVA_CAULDRON_BEHAVIOR
      The cauldron behaviors for lava cauldrons.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named LAVA_CAULDRON_BEHAVIOR Lnet/minecraft/block/cauldron/CauldronBehavior;LAVA_CAULDRON_BEHAVIOR:Lnet/minecraft/block/cauldron/CauldronBehavior$CauldronBehaviorMap;
      intermediary field_27777 Lnet/minecraft/class_5620;field_27777:Lnet/minecraft/class_5620$class_8821;
      official e Lkg;e:Lkg$a;

    • POWDER_SNOW_CAULDRON_BEHAVIOR

      static final CauldronBehavior.CauldronBehaviorMap POWDER_SNOW_CAULDRON_BEHAVIOR
      The cauldron behaviors for powder snow cauldrons.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named POWDER_SNOW_CAULDRON_BEHAVIOR Lnet/minecraft/block/cauldron/CauldronBehavior;POWDER_SNOW_CAULDRON_BEHAVIOR:Lnet/minecraft/block/cauldron/CauldronBehavior$CauldronBehaviorMap;
      intermediary field_28011 Lnet/minecraft/class_5620;field_28011:Lnet/minecraft/class_5620$class_8821;
      official f Lkg;f:Lkg$a;

    • FILL_WITH_WATER

      static final CauldronBehavior FILL_WITH_WATER
      A behavior that fills cauldrons with water.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named FILL_WITH_WATER Lnet/minecraft/block/cauldron/CauldronBehavior;FILL_WITH_WATER:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_27778 Lnet/minecraft/class_5620;field_27778:Lnet/minecraft/class_5620;
      official g Lkg;g:Lkg;

    • FILL_WITH_LAVA

      static final CauldronBehavior FILL_WITH_LAVA
      A behavior that fills cauldrons with lava.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named FILL_WITH_LAVA Lnet/minecraft/block/cauldron/CauldronBehavior;FILL_WITH_LAVA:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_27779 Lnet/minecraft/class_5620;field_27779:Lnet/minecraft/class_5620;
      official h Lkg;h:Lkg;

    • FILL_WITH_POWDER_SNOW

      static final CauldronBehavior FILL_WITH_POWDER_SNOW
      A behavior that fills cauldrons with powder snow.
      See Also:
      Mappings:
      Namespace Name Mixin selector
      named FILL_WITH_POWDER_SNOW Lnet/minecraft/block/cauldron/CauldronBehavior;FILL_WITH_POWDER_SNOW:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_28012 Lnet/minecraft/class_5620;field_28012:Lnet/minecraft/class_5620;
      official i Lkg;i:Lkg;

    • CLEAN_SHULKER_BOX

      static final CauldronBehavior CLEAN_SHULKER_BOX
      A behavior that cleans dyed shulker boxes.
      Mappings:
      Namespace Name Mixin selector
      named CLEAN_SHULKER_BOX Lnet/minecraft/block/cauldron/CauldronBehavior;CLEAN_SHULKER_BOX:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_27780 Lnet/minecraft/class_5620;field_27780:Lnet/minecraft/class_5620;
      official j Lkg;j:Lkg;

    • CLEAN_BANNER

      static final CauldronBehavior CLEAN_BANNER
      A behavior that cleans banners with patterns.
      Mappings:
      Namespace Name Mixin selector
      named CLEAN_BANNER Lnet/minecraft/block/cauldron/CauldronBehavior;CLEAN_BANNER:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_27781 Lnet/minecraft/class_5620;field_27781:Lnet/minecraft/class_5620;
      official k Lkg;k:Lkg;

    • CLEAN_DYEABLE_ITEM

      static final CauldronBehavior CLEAN_DYEABLE_ITEM
      A behavior that cleans dyeable items.
      Mappings:
      Namespace Name Mixin selector
      named CLEAN_DYEABLE_ITEM Lnet/minecraft/block/cauldron/CauldronBehavior;CLEAN_DYEABLE_ITEM:Lnet/minecraft/block/cauldron/CauldronBehavior;
      intermediary field_27782 Lnet/minecraft/class_5620;field_27782:Lnet/minecraft/class_5620;
      official l Lkg;l:Lkg;

  • Method Details

    • createMap

      static CauldronBehavior.CauldronBehaviorMap createMap(String name)
      Creates a mutable map from items to their corresponding cauldron behaviors.

      The default return value in the map is a cauldron behavior that returns ItemActionResult.PASS_TO_DEFAULT_BLOCK_INTERACTION for all items.

      Returns:
      the created map
      Mappings:
      Namespace Name Mixin selector
      named createMap Lnet/minecraft/block/cauldron/CauldronBehavior;createMap(Ljava/lang/String;)Lnet/minecraft/block/cauldron/CauldronBehavior$CauldronBehaviorMap;
      intermediary method_32206 Lnet/minecraft/class_5620;method_32206(Ljava/lang/String;)Lnet/minecraft/class_5620$class_8821;
      official a Lkg;a(Ljava/lang/String;)Lkg$a;

    • interact

      ItemActionResult interact(BlockState state, World world, BlockPos pos, PlayerEntity player, Hand hand, ItemStack stack)
      Called when a player interacts with a cauldron.
      Parameters:
      state - the current cauldron block state
      world - the world where the cauldron is located
      pos - the cauldron's position
      player - the interacting player
      hand - the hand interacting with the cauldron
      stack - the stack in the player's hand
      Returns:
      a successful action result if this behavior succeeds, ItemActionResult.PASS_TO_DEFAULT_BLOCK_INTERACTION otherwise
      Mappings:
      Namespace Name Mixin selector
      named interact Lnet/minecraft/block/cauldron/CauldronBehavior;interact(Lnet/minecraft/block/BlockState;Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;Lnet/minecraft/item/ItemStack;)Lnet/minecraft/util/ItemActionResult;
      intermediary interact Lnet/minecraft/class_5620;interact(Lnet/minecraft/class_2680;Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;Lnet/minecraft/class_1799;)Lnet/minecraft/class_9062;
      official interact Lkg;interact(Ldsl;Ldcg;Lja;Lcml;Lbqg;Lcud;)Lbqj;

    • registerBehavior

      static void registerBehavior()
      Registers the vanilla cauldron behaviors.
      Mappings:
      Namespace Name Mixin selector
      named registerBehavior Lnet/minecraft/block/cauldron/CauldronBehavior;registerBehavior()V
      intermediary method_32212 Lnet/minecraft/class_5620;method_32212()V
      official a Lkg;a()V

    • registerBucketBehavior

      static void registerBucketBehavior(Map<Item,CauldronBehavior> behavior)
      Registers the behavior for filled buckets in the specified behavior map.
      Mappings:
      Namespace Name Mixin selector
      named registerBucketBehavior Lnet/minecraft/block/cauldron/CauldronBehavior;registerBucketBehavior(Ljava/util/Map;)V
      intermediary method_34850 Lnet/minecraft/class_5620;method_34850(Ljava/util/Map;)V
      official a Lkg;a(Ljava/util/Map;)V

    • emptyCauldron

      static ItemActionResult emptyCauldron(BlockState state, World world, BlockPos pos, PlayerEntity player, Hand hand, ItemStack stack, ItemStack output, Predicate<BlockState> fullPredicate, SoundEvent soundEvent)
      Empties a cauldron if it's full.
      Parameters:
      state - the cauldron block state
      world - the world where the cauldron is located
      pos - the cauldron's position
      player - the interacting player
      hand - the hand interacting with the cauldron
      stack - the stack in the player's hand
      output - the item stack that replaces the interaction stack when the cauldron is emptied
      fullPredicate - a predicate used to check if the cauldron can be emptied into the output stack
      soundEvent - the sound produced by emptying
      Returns:
      a successful action result if emptied, ItemActionResult.PASS_TO_DEFAULT_BLOCK_INTERACTION otherwise
      Mappings:
      Namespace Name Mixin selector
      named emptyCauldron Lnet/minecraft/block/cauldron/CauldronBehavior;emptyCauldron(Lnet/minecraft/block/BlockState;Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/ItemStack;Ljava/util/function/Predicate;Lnet/minecraft/sound/SoundEvent;)Lnet/minecraft/util/ItemActionResult;
      intermediary method_32210 Lnet/minecraft/class_5620;method_32210(Lnet/minecraft/class_2680;Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;Ljava/util/function/Predicate;Lnet/minecraft/class_3414;)Lnet/minecraft/class_9062;
      official a Lkg;a(Ldsl;Ldcg;Lja;Lcml;Lbqg;Lcud;Lcud;Ljava/util/function/Predicate;Lavg;)Lbqj;

    • fillCauldron

      static ItemActionResult fillCauldron(World world, BlockPos pos, PlayerEntity player, Hand hand, ItemStack stack, BlockState state, SoundEvent soundEvent)
      Fills a cauldron from a bucket stack.

      The filled bucket stack will be replaced by an empty bucket in the player's inventory.

      Parameters:
      world - the world where the cauldron is located
      pos - the cauldron's position
      player - the interacting player
      hand - the hand interacting with the cauldron
      stack - the filled bucket stack in the player's hand
      state - the filled cauldron state
      soundEvent - the sound produced by filling
      Returns:
      a successful action result
      Mappings:
      Namespace Name Mixin selector
      named fillCauldron Lnet/minecraft/block/cauldron/CauldronBehavior;fillCauldron(Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/BlockState;Lnet/minecraft/sound/SoundEvent;)Lnet/minecraft/util/ItemActionResult;
      intermediary method_32207 Lnet/minecraft/class_5620;method_32207(Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;Lnet/minecraft/class_1799;Lnet/minecraft/class_2680;Lnet/minecraft/class_3414;)Lnet/minecraft/class_9062;
      official a Lkg;a(Ldcg;Lja;Lcml;Lbqg;Lcud;Ldsl;Lavg;)Lbqj;