Necronomicon Ritual (Abyssal Tweaker)

Description

Allows setting up rituals that can be executed with various tiers of Necronomicon.

Warning

For technical reasons the Ritual compatibility will not validate whether the ritual is set to execute in a valid dimension when it's registered. By default only Overworld and Abyssalcraft's dimensions are valid, and other dimensions have to be added through the config file.

Warning

The mob summoning rituals do not display in JEI (but do display in the Necronomicon).

Warning

The rituals in Necronomicon use the localization keys ac.ritual.ritualName (for the name) and ac.ritual.ritualName.desc (for the description, default empty). It is recommended to fill those through a language file.

Identifier

Refer to this via any of the following:

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

Adding Recipes

Recipe Builder

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

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

mods.abyssaltweaker.ritual.recipeBuilder()

• IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 9.

  input(IIngredient)
  input(IIngredient...)
  input(Collection<IIngredient>)

• ItemStackList. Sets the item outputs of the recipe. Requires exactly 1.

  output(ItemStack)
  output(ItemStack...)
  output(Collection<ItemStack>)

• int. Sets the amount of Potential Energy the ritual consumes. Requires greater than or equal to 1. (Default 0).

  pe(int)
  energy(int)

• String. Sets the ritual name, which has to be unique among all rituals. Requires not empty.

  name(String)
  name(ResourceLocation)

• int. Sets the minimum book tier that can execute this recipe. Requires greater than or equal to 0 and less than or equal to 4. (Default 0).

  bookTier(int)
  bookTier(String)

• int. Sets the particle ID that is emitted from pedestals while this recipe is being executed (see also: EnumRitualParticle). Requires greater than or equal to 0 and less than 8. (Default 0).

  particle(int)

• int. Sets the dimension that this ritual can be performed in. (Default any dimension).

  dimension(int)

• boolean. Sets whether the ritual requires a sacrifice. (Default false).

  sacrifice(boolean)
  requiresSacrifice()

• IIngredient. Sets the center item needed for the recipe. Not applicable for Summoning rituals.

  centerItem(IIngredient)

• EntityEntry. Sets the mob that will be summoned by the ritual.

  summonedMob(EntityEntry)

• 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 com.shinoow.abyssalcraft.api.ritual.NecronomiconRitual).

  register()

Example

mods.abyssaltweaker.ritual.recipeBuilder()
    .name('simpleRitual')
    .centerItem(item('minecraft:diamond'))
    .input(item('minecraft:diamond'))
    .output(item('minecraft:diamond_block'))
    .pe(100)
    .register()

mods.abyssaltweaker.ritual.recipeBuilder()
    .name('starInfusion')
    .centerItem(item('minecraft:clay'))
    .input(item('minecraft:diamond'), ore('ingotGold'), ore('ingotIron'))
    .output(item('minecraft:nether_star'))
    .pe(500)
    .requiresSacrifice()
    .bookTier(3)
    .dimension(50)
    .register()

mods.abyssaltweaker.ritual.recipeBuilder()
    .name('simpleCreation')
    .input(item('minecraft:iron_ingot'), item('minecraft:iron_ingot'), item('minecraft:iron_ingot'), item('minecraft:iron_ingot'))
    .output(item('minecraft:gold_ingot'))
    .pe(100)
    .register()

mods.abyssaltweaker.ritual.recipeBuilder()
    .name('zombieSummoning')
    .input(item('minecraft:rotten_flesh'), item('minecraft:iron_ingot'), item('minecraft:carrot'), item('minecraft:potato'))
    .summonedMob(entity('minecraft:zombie'))
    .pe(100)
    .register()

Removing Recipes

• Removes the ritual by its center item:

  mods.abyssaltweaker.ritual.removeByCenter(IIngredient)

• Removes the ritual by its name:

  mods.abyssaltweaker.ritual.removeByName(String)

• Removes all recipes that match the given output:

  mods.abyssaltweaker.ritual.removeByOutput(IIngredient)

• Removes the ritual by the mob it summons:

  mods.abyssaltweaker.ritual.removeBySummonedMob(EntityEntry)

• Removes all registered recipes:

  mods.abyssaltweaker.ritual.removeAll()

Example

mods.abyssaltweaker.ritual.removeByCenter(item('abyssalcraft:lifecrystal'))
mods.abyssaltweaker.ritual.removeByName('dreadInfusedGatewayKey')
mods.abyssaltweaker.ritual.removeByOutput(item('abyssalcraft:oc'))
mods.abyssaltweaker.ritual.removeBySummonedMob(entity('abyssalcraft:dragonboss'))
mods.abyssaltweaker.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:

  mods.abyssaltweaker.ritual.streamRecipes()

Contributors

Wizzerinus

Changelog

Last edited less than a minute ago

View full history

3c501df-Thu Oct 24 14:26:40 2024 +0300