Summon Creature (Roots 3)

Description

When running a Summon Creature Ritual, the input items placed on Catalyst Plate will summon the target entity.

Identifier

The identifier mods.roots.summon_creature will be used as the default on this page.

All Identifiers

Any of these can be used to refer to this compat:

mods.roots.summoncreature
mods.roots.summonCreature
mods.roots.SummonCreature
mods.roots.summon_creature/* Used as page default */

Adding Recipes

Recipe Builder

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

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

Recipe Builder

---

• Create the Recipe Builder.

  mods.roots.summon_creature.recipeBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

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

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

• Class<? extends EntityLivingBase>. Sets the target entity. Requires not null.

  entity(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 epicsquid.roots.recipe.SummonCreatureRecipe).

  register()

---

Example

mods.roots.summon_creature.recipeBuilder()
    .name('wither_skeleton_from_clay')
    .input(item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
    .entity(entity('minecraft:wither_skeleton'))
    .register()

Removing Recipes

• Removes the Summon Creature recipe with the given name:

  mods.roots.summon_creature.removeByName(ResourceLocation)

• Removes the Summon Creature recipe for the given Entity:

  mods.roots.summon_creature.removeByEntity(EntityEntry)

• Removes the Summon Creature recipe for the given Entity:

  mods.roots.summon_creature.removeByEntity(Class<? extends EntityLivingBase>)

• Removes all registered recipes:

  mods.roots.summon_creature.removeAll()

Example

mods.roots.summon_creature.removeByName(resource('roots:cow'))
mods.roots.summon_creature.removeByEntity(entity('minecraft:chicken'))
mods.roots.summon_creature.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.roots.summon_creature.streamRecipes()

Contributors

Waiting Idly Nullpinter

Last edited 10 minutes ago

View full history

044601a-update docs for GroovyScript 1.3.2 (#54)

80c153e-update docs for GroovyScript 1.2.4 (#38)

481224d-GroovyScript Improvements (#12)

70357c1-docs(en): migrate grs docs (#2)