Ritual (Arcane World)

Description

Converts up to 5 input itemstacks into a wide number of possible effects, including spawning entities, opening a portal to a dungeon dimension to fight a mob, awarding an output itemstack, running commands, and even entirely customized effects.

Identifier

Refer to this via any of the following:

groovy

mods.arcaneworld.ritual/* Used as page default */
mods.arcaneworld.Ritual

Adding Recipes

Adds the recipe:
groovy
```
mods.arcaneworld.ritual.add(Ritual)
```

Recipe Builder

Just like other recipe types, the Ritual also uses a recipe builder.

Don't know what a builder is? Check the builder info page out.

Standard Recipe Builder

Create a Recipe Builder for any type of recipe, always requiring up to 5 input itemstacks and a translation key.
groovy
```
mods.arcaneworld.ritual.recipeBuilder()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
ItemStackList. Sets the item outputs of the recipe. Requires exactly 1.
groovy
```
output(ItemStack)
output(ItemStack...)
output(Collection<ItemStack>)
```
int. Sets the amount of time that is passed when the Time Ritual is activated. Requires greater than or equal to 1. (Default 0).
groovy
```
time(int)
```
Class<? extends Entity>. Sets the entity spawned when the Arena or Summon Rituals are activated. Requires not null.
groovy
```
entity(EntityEntry)
entity(Class<? extends Entity>)
```
List<String>. Sets the commands that will be run when the Command Ritual is activated. Requires not null.
groovy
```
command(String)
command(String...)
command(List<String>)
```
Closure<Void>. Sets the effect that will happen when the Custom Ritual is run, with the Closure taking 4 parameters, World world, BlockPos blockPos, EntityPlayer player, and ItemStack... itemStacks. Requires not null.
groovy
```
onActivate(Closure<Void>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.CUSTOM).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

RitualWeather.WeatherType. Sets the type of weather the world will change to when the Weather Ritual is activated. Requires not null.
groovy
```
weatherRain()
weatherClear()
weatherThunder()
weatherType(RitualWeather.WeatherType)
```

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilder()
    .ritualCreateItem()
    .input(item('minecraft:stone') * 5, item('minecraft:diamond'), item('minecraft:clay'))
    .output(item('minecraft:clay'))
    .translationKey('groovyscript.demo_output')
    .name('groovyscript:custom_name')
    .register()

Arena Recipe Builder

Create a Recipe Builder for an arena recipe, with the basic values and an entity. Teleports the player to a custom dimension to fight the entity when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderArena()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
Class<? extends Entity>. Sets the entity spawned when the Arena or Summon Rituals are activated. Requires not null.
groovy
```
entity(EntityEntry)
entity(Class<? extends Entity>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.ARENA).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderArena()
    .input(item('minecraft:stone'), item('minecraft:stone'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_arena')
    .entity(entity('minecraft:chicken'))
    .register()

Command Recipe Builder

Create a Recipe Builder for a command recipe, with the basic values and an number of commands. Runs those commands when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderCommand()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
List<String>. Sets the commands that will be run when the Command Ritual is activated. Requires not null.
groovy
```
command(String)
command(String...)
command(List<String>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.COMMAND).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderCommand()
    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_command')
    .command('say hi',
             'give @p minecraft:coal 5')
    .register()

CreateItem Recipe Builder

Create a Recipe Builder for a create item recipe, with the basic values and an output itemstack. Spawns the itemstack in-world when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderCreateItem()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
ItemStackList. Sets the item outputs of the recipe. Requires exactly 1.
groovy
```
output(ItemStack)
output(ItemStack...)
output(Collection<ItemStack>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.CREATE_ITEM).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderCreateItem()
    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:diamond'))
    .translationKey('groovyscript.demo_create_item')
    .output(item('minecraft:diamond'))
    .register()

Custom Recipe Builder

Create a Recipe Builder for a custom recipe, with the basic values and a closure. Runs the closure when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderCustom()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
Closure<Void>. Sets the effect that will happen when the Custom Ritual is run, with the Closure taking 4 parameters, World world, BlockPos blockPos, EntityPlayer player, and ItemStack... itemStacks. Requires not null.
groovy
```
onActivate(Closure<Void>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.CUSTOM).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderCustom()
    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_custom')
    .onActivate({ World world, BlockPos blockPos, EntityPlayer player, ItemStack... itemStacks -> { log.info blockPos } })
    .register()

DragonBreath Recipe Builder

Create a Recipe Builder for a dragon breath recipe, with only the basic values. Summons Dragons Breath when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderDragonBreath()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.DRAGON_BREATH).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderDragonBreath()
    .input(item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_dragon_breath')
    .register()

Dungeon Recipe Builder

Create a Recipe Builder for a dungeon recipe, with only the basic values. Teleports the player to a custom dimension with a dungeon when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderDungeon()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.DUNGEON).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderDungeon()
    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_dungeon')
    .register()

Summon Recipe Builder

Create a Recipe Builder for a summon recipe, with the basic values and an entity. Spawns that entity when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderSummon()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
Class<? extends Entity>. Sets the entity spawned when the Arena or Summon Rituals are activated. Requires not null.
groovy
```
entity(EntityEntry)
entity(Class<? extends Entity>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.SUMMON).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderSummon()
    .input(item('minecraft:stone'), item('minecraft:clay'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_summon')
    .entity(entity('minecraft:chicken'))
    .register()

Time Recipe Builder

Create a Recipe Builder for a time recipe, with the basic values and a time integer. Rapidly changes the time of day to the set time when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderTime()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```
int. Sets the amount of time that is passed when the Time Ritual is activated. Requires greater than or equal to 1. (Default 0).
groovy
```
time(int)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.TIME).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderTime()
    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_time')
    .time(5000)
    .register()

Weather Recipe Builder

Create a Recipe Builder for a weather recipe, with the basic values and a weather value. Changes the weather type to the given value when completed.
groovy
```
mods.arcaneworld.ritual.recipeBuilderWeather()
```

ResourceLocation. Sets the Resource Location of the recipe.
groovy
```
name(String)
name(ResourceLocation)
```
String. Sets the translation key used to localize the name of the ritual. Requires not null.
groovy
```
translationKey(String)
```
IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 5.
groovy
```
input(IIngredient)
input(IIngredient...)
input(Collection<IIngredient>)
```

RitualWrapper.RitualType. Sets the mode of the ritual, different modes will require different values. (Default RitualType.WEATHER).

groovy

ritualTime()
ritualArena()
ritualCustom()
ritualSummon()
ritualCommand()
ritualDungeon()
ritualWeather()
ritualCreateItem()
ritualDragonBreath()
ritualType(RitualWrapper.RitualType)

RitualWeather.WeatherType. Sets the type of weather the world will change to when the Weather Ritual is activated. Requires not null.
groovy
```
weatherRain()
weatherClear()
weatherThunder()
weatherType(RitualWeather.WeatherType)
```

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. (returns null or party.lemons.arcaneworld.crafting.ritual.Ritual).
groovy
```
register()
```

Example

groovy

mods.arcaneworld.ritual.recipeBuilderWeather()
    .input(item('minecraft:diamond'), item('minecraft:gold_ingot'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_weather_clear')
    .weatherClear()
    .register()

mods.arcaneworld.ritual.recipeBuilderWeather()
    .input(item('minecraft:gold_ingot'), item('minecraft:diamond'), item('minecraft:clay'))
    .translationKey('groovyscript.demo_weather_rain')
    .weatherRain()
    .register()

mods.arcaneworld.ritual.recipeBuilderWeather()
    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:gold_ingot'))
    .translationKey('groovyscript.demo_weather_thunder')
    .weatherThunder()
    .register()

Removing Recipes

Removes the recipe with the given Resource Location:
groovy
```
mods.arcaneworld.ritual.remove(ResourceLocation)
```
Removes the recipe with the given String as its Resource Location:
groovy
```
mods.arcaneworld.ritual.remove(String)
```
Removes the recipe:
groovy
```
mods.arcaneworld.ritual.remove(Ritual)
```
Removes all recipes that match the given input:
groovy
```
mods.arcaneworld.ritual.removeByInput(IIngredient)
```
Removes all recipes that match the given output:
groovy
```
mods.arcaneworld.ritual.removeByOutput(IIngredient)
```
Removes all registered recipes:
groovy
```
mods.arcaneworld.ritual.removeAll()
```

Example

groovy

mods.arcaneworld.ritual.removeByInput(item('minecraft:gold_nugget'))
mods.arcaneworld.ritual.removeByOutput(item('arcaneworld:biome_crystal'))
mods.arcaneworld.ritual.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:
groovy
```
mods.arcaneworld.ritual.streamRecipes()
```

Contributors

Waiting Idly

Last edited 21 minutes ago

View full history

IIngredient

Registries

Commands

Events

Biome Event

Block Event

Chunk Data Event

Chunk Event

Chunk Generator Event

Chunk Watch Event

Decorate Biome Event

Entity Event

Explosion Event

Living Entity Use Item Event

Living Event

Living Spawn Event

Note Block Event

Ore Gen Event

Player Container Event

Player Event

Player Interact Event

Populate Chunk Event

Potion Event

Projectile Impact Event

Registry Event

World Event

World Type Event

Zombie Event

Abyssal Tweaker

AcademyCraft

Actually Additions

Advanced Mortars

Advanced Rocketry

Aether Legacy

Aetherworks

Alchemistry

Applied Energistics 2

Arcane Archives

Arcane World

Astral Sorcery

Atum 2

Avaritia

Better With Addons

Better With Mods

Blood Arsenal

Blood Magic: Alchemical Wizardry

Botania

Botania Tweaks

Botanic Additions

Calculator

Chisel

Compact Machines 3

Cyclic

Draconic Evolution

Embers

Ender IO

EssentialCraft 4

EvilCraft

Extended Crafting

Extra Botany

Extra Utilities 2

Factory Tech

Future MC

GregTech Community Edition Unofficial

Materials

Harken Scythe: Resharpened

Horse Power

Ice And Fire

Immersive Engineering

Immersive Petroleum

Immersive Technology

Industrial Foregoing

Inspirations

Integrated Dynamics

Just Enough Items

Magneticraft

Mekanism

Modern Warfare Cubed

Mystical Agriculture

Nature's Aura

Ritual (Arcane World)

Description

Identifier

Adding Recipes

Recipe Builder

Removing Recipes

Getting the value of recipes