Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
CTCauldronInteraction Cauldron Composter
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
CTCauldronInteraction Composter
Next

Cauldron

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.misc.Cauldron;

Description

Lets you add new Cauldron interactions.

Members

addEmptyInteraction
addEmptyInteraction(item as Item, interaction as CTCauldronInteraction)
Adds an interaction that will fire when an empty Cauldron is interacted with the given item.
script.zs
// CTCauldron.addEmptyInteraction(item as ItemDefinition, interaction as CTCauldronInteraction);
myCTCauldron.addEmptyInteraction(<item:minecraft:dirt>, (blockState, level, pos, player, hand, stack) => {
if !level.isClientSide {
player.give(<item:minecraft:diamond>);
}
return crafttweaker.api.world.InteractionResult.sidedSuccess(level.isClientSide);
});

Parameters:

item Type: ItemDefinition - The item to interact with.
interaction Type: CTCauldronInteraction - What happens when the item interacts with the cauldron.
addInteraction
addInteraction(cauldronBlock as Block, item as Item, interaction as CTCauldronInteraction)
Adds an interaction that will fire when the provided cauldron block is interacted with the given item.

This method is mainly provided to add support for non-vanilla cauldrons, thus the provided block needs to be a AbstractCauldronBlock.

script.zs
// CTCauldron.addInteraction(cauldronBlock as Block, item as ItemDefinition, interaction as CTCauldronInteraction);
myCTCauldron.addInteraction(<block:minecraft:lava_cauldron>, <item:minecraft:dirt>, (blockState, level, pos, player, hand, stack) => {
if !level.isClientSide {
player.give(<item:minecraft:diamond>);
}
return crafttweaker.api.world.InteractionResult.sidedSuccess(level.isClientSide);
});

Parameters:

cauldronBlock Type: Block - The cauldron block to add an interaction to.
item Type: ItemDefinition - The item to interact with.
interaction Type: CTCauldronInteraction - What happens when the item interacts with the cauldron.
addLavaInteraction
addLavaInteraction(item as Item, interaction as CTCauldronInteraction)
Adds an interaction that will fire when a Cauldron with lava inside is interacted with the given item.
script.zs
// CTCauldron.addLavaInteraction(item as ItemDefinition, interaction as CTCauldronInteraction);
myCTCauldron.addLavaInteraction(<item:minecraft:dirt>, (blockState, level, pos, player, hand, stack) => {
if !level.isClientSide {
player.give(<item:minecraft:diamond>);
}
return crafttweaker.api.world.InteractionResult.sidedSuccess(level.isClientSide);
});

Parameters:

item Type: ItemDefinition - The item to interact with.
interaction Type: CTCauldronInteraction - What happens when the item interacts with the cauldron.
addPowderSnowInteraction
addPowderSnowInteraction(item as Item, interaction as CTCauldronInteraction)
Adds an interaction that will fire when a Cauldron with powdered snow inside is interacted with the given item.
script.zs
// CTCauldron.addPowderSnowInteraction(item as ItemDefinition, interaction as CTCauldronInteraction);
myCTCauldron.addPowderSnowInteraction(<item:minecraft:dirt>, (blockState, level, pos, player, hand, stack) => {
if !level.isClientSide {
player.give(<item:minecraft:diamond>);
}
return crafttweaker.api.world.InteractionResult.sidedSuccess(level.isClientSide);
});

Parameters:

item Type: ItemDefinition - The item to interact with.
interaction Type: CTCauldronInteraction - What happens when the item interacts with the cauldron.
addWaterInteraction
addWaterInteraction(item as Item, interaction as CTCauldronInteraction)
Adds an interaction that will fire when a Cauldron with water inside is interacted with the given item.
script.zs
// CTCauldron.addWaterInteraction(item as ItemDefinition, interaction as CTCauldronInteraction);
myCTCauldron.addWaterInteraction(<item:minecraft:dirt>, (blockState, level, pos, player, hand, stack) => {
if !level.isClientSide {
player.give(<item:minecraft:diamond>);
}
return crafttweaker.api.world.InteractionResult.sidedSuccess(level.isClientSide);
});

Parameters:

item Type: ItemDefinition - The item to interact with.
interaction Type: CTCauldronInteraction - What happens when the item interacts with the cauldron.
fillLavaInteraction
Getter
Gets an interaction that fills a Cauldron with lava.
script.zs
// CTCauldron.fillLavaInteraction as CTCauldronInteraction
myCTCauldron.fillLavaInteraction

Return Type: CTCauldronInteraction

fillLavaInteraction() as CTCauldronInteraction
Gets an interaction that fills a Cauldron with lava.

Returns: An interaction that fills a Cauldron with lava.

script.zs
// CTCauldron.fillLavaInteraction() as CTCauldronInteraction;
myCTCauldron.fillLavaInteraction();

Return Type: CTCauldronInteraction

fillPowderSnowInteraction
Getter
Gets an interaction that fills a Cauldron with lava.
script.zs
// CTCauldron.fillPowderSnowInteraction as CTCauldronInteraction
myCTCauldron.fillPowderSnowInteraction

Return Type: CTCauldronInteraction

fillPowderSnowInteraction() as CTCauldronInteraction
Gets an interaction that fills a Cauldron with lava.

Returns: An interaction that fills a Cauldron with lava.

script.zs
// CTCauldron.fillPowderSnowInteraction() as CTCauldronInteraction;
myCTCauldron.fillPowderSnowInteraction();

Return Type: CTCauldronInteraction

fillWaterInteraction
Getter
Gets an interaction that fills a cauldron with water.
script.zs
// CTCauldron.fillWaterInteraction as CTCauldronInteraction
myCTCauldron.fillWaterInteraction

Return Type: CTCauldronInteraction

fillWaterInteraction() as CTCauldronInteraction
Gets an interaction that fills a cauldron with water.

Returns: An interaction that fills a cauldron with water.

script.zs
// CTCauldron.fillWaterInteraction() as CTCauldronInteraction;
myCTCauldron.fillWaterInteraction();

Return Type: CTCauldronInteraction

removeEmptyInteraction
removeEmptyInteraction(item as Item)
Removes the interaction for the given item from an empty Cauldron.
script.zs
// CTCauldron.removeEmptyInteraction(item as ItemDefinition);
myCTCauldron.removeEmptyInteraction(myItem);

Parameters:

item Type: ItemDefinition - The item to remove the interaction for.
removeInteraction
removeInteraction(cauldronBlock as Block, item as Item)
Removes the interaction that will fire when the provided cauldron block is interacted with the given item.

This method is mainly provided to add support for non-vanilla cauldrons, thus the provided block needs to be a AbstractCauldronBlock.

script.zs
// CTCauldron.removeInteraction(cauldronBlock as Block, item as ItemDefinition);
myCTCauldron.removeInteraction(<block:minecraft:lava_cauldron>, <item:minecraft:dirt>);

Parameters:

cauldronBlock Type: Block - The cauldron block to add an interaction to.
item Type: ItemDefinition - The item to interact with.
removeLavaInteraction
removeLavaInteraction(item as Item)
Removes the interaction for the given item from a lava filled Cauldron.
script.zs
// CTCauldron.removeLavaInteraction(item as ItemDefinition);
myCTCauldron.removeLavaInteraction(myItem);

Parameters:

item Type: ItemDefinition - The item to remove the interaction for.
removePowderSnowInteraction
removePowderSnowInteraction(item as Item)
Removes the interaction for the given item from a powdered snow filled Cauldron.
script.zs
// CTCauldron.removePowderSnowInteraction(item as ItemDefinition);
myCTCauldron.removePowderSnowInteraction(myItem);

Parameters:

item Type: ItemDefinition - The item to remove the interaction for.
removeWaterInteraction
removeWaterInteraction(item as Item)
Removes the interaction for the given item from a water filled Cauldron.
script.zs
// CTCauldron.removeWaterInteraction(item as ItemDefinition);
myCTCauldron.removeWaterInteraction(myItem);

Parameters:

item Type: ItemDefinition - The item to remove the interaction for.
Previous
CTCauldronInteraction Composter
Next