Cauldron (Inspirations)
Description
Converts up to 1 itemstack and up to 1 fluid into up to 1 itemstack or up to 1 fluid, with a boiling boolean and variable amount of fluid consumed or produced.
Note
Cauldrons have a cap of either 3 or 4 levels, depending on the config.
Identifier
Refer to this via any of the following:
mods.inspirations.cauldron/* Used as page default */
mods.inspirations.Cauldron
Adding Recipes
Recipe Builder
Just like other recipe types, the Cauldron also uses a recipe builder.
Don't know what a builder is? Check the builder info page out.
mods.inspirations.cauldron.recipeBuilder()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
FluidStackList
. Sets the fluid inputs of the recipe. Requires exactly 1.groovyfluidInput(FluidStack) fluidInput(FluidStack...) fluidInput(Collection<FluidStack>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
FluidStackList
. Sets the fluid outputs of the recipe. Requires exactly 1.groovyfluidOutput(FluidStack) fluidOutput(FluidStack...) fluidOutput(Collection<FluidStack>)
EnumDyeColor
. Sets the dye color fluid required for the input. Requires not null.groovydye(String) dye(EnumDyeColor)
Cauldron.RecipeBuilder.RecipeType
. Sets what type of recipe is being processed.groovydye() mix() fill() type(String) type(Cauldron.RecipeBuilder.RecipeType) potion() brewing() standard() transform()
SoundEvent
. Sets the sound played when the recipe is crafted. Requires not null.groovysound(String) sound(SoundEvent)
int
. Sets the level of fluid in the cauldron, where each bottle is a single level. Requires greater than or equal to 0 and less than or equal toInspirationsRegistry.getCauldronMax()
. (Default0
).groovylevels(int)
Boolean
. Sets if the cauldron must be boiling, requiring fire or another heat source beneath. (Defaultfalse
).groovyboiling() boiling(Boolean)
PotionType
. Sets the input potion type. Requires not null.groovyinputPotion(PotionType)
PotionType
. Sets the output potion type. Requires not null.groovyoutputPotion(PotionType)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilder()
.standard()
.input(item('minecraft:gold_ingot'))
.fluidInput(fluid('lava'))
.output(item('minecraft:clay'))
.boiling()
.sound(sound('minecraft:block.anvil.destroy'))
.levels(3)
.register()
mods.inspirations.cauldron.recipeBuilderBrewing()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
PotionType
. Sets the input potion type. Requires not null.groovyinputPotion(PotionType)
PotionType
. Sets the output potion type. Requires not null.groovyoutputPotion(PotionType)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderBrewing()
.input(item('minecraft:diamond_block'))
.inputPotion(potionType('minecraft:fire_resistance'))
.outputPotion(potionType('minecraft:strength'))
.register()
mods.inspirations.cauldron.recipeBuilderDye()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
EnumDyeColor
. Sets the dye color fluid required for the input. Requires not null.groovydye(String) dye(EnumDyeColor)
int
. Sets the level of fluid in the cauldron, where each bottle is a single level. Requires greater than or equal to 0 and less than or equal toInspirationsRegistry.getCauldronMax()
. (Default0
).groovylevels(int)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderDye()
.input(item('minecraft:gold_block'))
.output(item('minecraft:diamond_block'))
.dye('blue')
.levels(2)
.register()
mods.inspirations.cauldron.recipeBuilderFill()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
FluidStackList
. Sets the fluid inputs of the recipe. Requires exactly 1.groovyfluidInput(FluidStack) fluidInput(FluidStack...) fluidInput(Collection<FluidStack>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
SoundEvent
. Sets the sound played when the recipe is crafted. Requires not null.groovysound(String) sound(SoundEvent)
Boolean
. Sets if the cauldron must be boiling, requiring fire or another heat source beneath. (Defaultfalse
).groovyboiling() boiling(Boolean)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderFill()
.input(item('minecraft:gold_ingot'))
.output(item('minecraft:clay'))
.fluidInput(fluid('milk'))
.sound(sound('minecraft:block.anvil.destroy'))
.register()
mods.inspirations.cauldron.recipeBuilderMix()
FluidStackList
. Sets the fluid inputs of the recipe. Requires exactly 2.groovyfluidInput(FluidStack) fluidInput(FluidStack...) fluidInput(Collection<FluidStack>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderMix()
.output(item('minecraft:clay'))
.fluidInput(fluid('milk'), fluid('lava'))
.register()
mods.inspirations.cauldron.recipeBuilderPotion()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
int
. Sets the level of fluid in the cauldron, where each bottle is a single level. Requires greater than or equal to 0 and less than or equal toInspirationsRegistry.getCauldronMax()
. (Default0
).groovylevels(int)
Boolean
. Sets if the cauldron must be boiling, requiring fire or another heat source beneath. (Defaultfalse
).groovyboiling() boiling(Boolean)
PotionType
. Sets the input potion type. Requires exactly 0 and exactly 1.groovyinputPotion(PotionType)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderPotion()
.input(item('minecraft:gold_block'))
.output(item('minecraft:diamond_block'))
.inputPotion(potionType('minecraft:fire_resistance'))
.levels(2)
.register()
mods.inspirations.cauldron.recipeBuilderStandard()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
FluidStackList
. Sets the fluid inputs of the recipe. Requires exactly 1.groovyfluidInput(FluidStack) fluidInput(FluidStack...) fluidInput(Collection<FluidStack>)
ItemStackList
. Sets the item outputs of the recipe. Requires exactly 1.groovyoutput(ItemStack) output(ItemStack...) output(Collection<ItemStack>)
SoundEvent
. Sets the sound played when the recipe is crafted. Requires not null.groovysound(String) sound(SoundEvent)
int
. Sets the level of fluid in the cauldron, where each bottle is a single level. Requires greater than or equal to 0 and less than or equal toInspirationsRegistry.getCauldronMax()
. (Default0
).groovylevels(int)
Boolean
. Sets if the cauldron must be boiling, requiring fire or another heat source beneath. (Defaultfalse
).groovyboiling() boiling(Boolean)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderStandard()
.input(item('minecraft:diamond'))
.output(item('minecraft:clay'))
.fluidInput(fluid('lava'))
.levels(3)
.sound(sound('minecraft:block.anvil.destroy'))
.register()
mods.inspirations.cauldron.recipeBuilderTransform()
IngredientList<IIngredient>
. Sets the item inputs of the recipe. Requires exactly 1.groovyinput(IIngredient) input(IIngredient...) input(Collection<IIngredient>)
FluidStackList
. Sets the fluid inputs of the recipe. Requires exactly 1.groovyfluidInput(FluidStack) fluidInput(FluidStack...) fluidInput(Collection<FluidStack>)
FluidStackList
. Sets the fluid outputs of the recipe. Requires exactly 1.groovyfluidOutput(FluidStack) fluidOutput(FluidStack...) fluidOutput(Collection<FluidStack>)
SoundEvent
. Sets the sound played when the recipe is crafted. Requires not null.groovysound(String) sound(SoundEvent)
int
. Sets the level of fluid in the cauldron, where each bottle is a single level. Requires greater than or equal to 0 and less than or equal toInspirationsRegistry.getCauldronMax()
. (Default0
).groovylevels(int)
Boolean
. Sets if the cauldron must be boiling, requiring fire or another heat source beneath. (Defaultfalse
).groovyboiling() boiling(Boolean)
First validates the builder, returning
null
and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returnsnull
orknightminer.inspirations.library.recipe.cauldron.ICauldronRecipe
).groovyregister()
Example
mods.inspirations.cauldron.recipeBuilderTransform()
.input(item('minecraft:stone:3'))
.fluidInput(fluid('water'))
.fluidOutput(fluid('milk'))
.levels(2)
.register()
Removing Recipes
Removes all recipes with the given fluid input:
groovymods.inspirations.cauldron.removeByFluidInput(Fluid)
Removes all recipes with the given fluid input:
groovymods.inspirations.cauldron.removeByFluidInput(FluidStack)
Removes all recipes with the given fluid output:
groovymods.inspirations.cauldron.removeByFluidOutput(Fluid)
Removes all recipes with the given fluid output:
groovymods.inspirations.cauldron.removeByFluidOutput(FluidStack)
Removes all recipes with the given item input:
groovymods.inspirations.cauldron.removeByInput(IIngredient)
Removes all recipes with the given item output:
groovymods.inspirations.cauldron.removeByOutput(ItemStack)
Removes all registered recipes:
groovymods.inspirations.cauldron.removeAll()
Example
mods.inspirations.cauldron.removeByFluidInput(fluid('mushroom_stew'))
mods.inspirations.cauldron.removeByFluidOutput(fluid('beetroot_soup'))
mods.inspirations.cauldron.removeByInput(item('minecraft:ghast_tear'))
mods.inspirations.cauldron.removeByOutput(item('minecraft:piston'))
mods.inspirations.cauldron.removeAll()
Getting the value of recipes
Iterates through every entry in the registry, with the ability to call remove on any element to remove it:
groovymods.inspirations.cauldron.streamRecipes()