Animator (The Betweenlands)

Description

Converts an input item, Life amount from Life Crystals, and Fuel from Sulfur into an output itemstack, summoning an entity, a random item from a loottable, or summoning an entity and outputting an itemstack.

Identifier

Refer to this via any of the following:

mods.betweenlands.animator
mods.betweenlands.Animator
mods.thebetweenlands.animator/* Used as page default */
mods.thebetweenlands.Animator

Adding Recipes

• Add the given recipe to the recipe list:

  mods.thebetweenlands.animator.add(IAnimatorRecipe)

Recipe Builder

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

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

mods.thebetweenlands.animator.recipeBuilder()

• IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires exactly 1.

  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 fuel consumed. Requires greater than or equal to 0. (Default 0).

  fuel(int)

• int. Sets the life consumed from the life crystal. Requires greater than or equal to 0. (Default 0).

  life(int)

• Class<? extends Entity>. Sets the entity being spawned.

  entity(EntityEntry)
  entity(Class<? extends Entity>)

• ResourceLocation. Sets the entity to render, typically the same as the entity to be spawned.

  render(ResourceLocation)

• ResourceLocation. Sets the LootTable used to generate outputs.

  lootTable(ResourceLocation)

• 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 thebetweenlands.api.recipes.IAnimatorRecipe).

  register()

Example

mods.thebetweenlands.animator.recipeBuilder()
    .input(item('minecraft:clay'))
    .output(item('minecraft:diamond'))
    .life(1)
    .fuel(1)
    .register()

mods.thebetweenlands.animator.recipeBuilder()
    .input(item('minecraft:gold_ingot'))
    .lootTable(resource('minecraft:entities/zombie'))
    .life(5)
    .fuel(1)
    .register()

mods.thebetweenlands.animator.recipeBuilder()
    .input(item('minecraft:gold_block'))
    .entity(entity('minecraft:zombie').getEntityClass())
    .life(1)
    .fuel(5)
    .register()

mods.thebetweenlands.animator.recipeBuilder()
    .input(item('minecraft:diamond'))
    .entity(entity('minecraft:enderman'))
    .output(item('minecraft:clay'))
    .life(3)
    .fuel(10)
    .register()

Removing Recipes

• Removes the given recipe from the recipe list:

  mods.thebetweenlands.animator.remove(IAnimatorRecipe)

• Removes all entries that match the given entity:

  mods.thebetweenlands.animator.removeByEntity(Class<? extends Entity>)

• Removes all entries that match the given entity:

  mods.thebetweenlands.animator.removeByEntity(EntityEntry)

• Removes all recipes that match the given input:

  mods.thebetweenlands.animator.removeByInput(IIngredient)

• Removes all entries that output the given Loot Table:

  mods.thebetweenlands.animator.removeByLootTable(ResourceLocation)

• Removes all recipes that match the given output:

  mods.thebetweenlands.animator.removeByOutput(IIngredient)

• Removes all registered recipes:

  mods.thebetweenlands.animator.removeAll()

Example

mods.thebetweenlands.animator.removeByEntity(entity('thebetweenlands:sporeling'))
mods.thebetweenlands.animator.removeByInput(item('thebetweenlands:bone_leggings'))
mods.thebetweenlands.animator.removeByLootTable(resource('thebetweenlands:animator/scroll'))
mods.thebetweenlands.animator.removeByOutput(item('thebetweenlands:items_misc:46'))
mods.thebetweenlands.animator.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.thebetweenlands.animator.streamRecipes()

Contributors

Waiting Idly

Last edited about 22 hours ago

View full history

01c1a3f-update docs for GroovyScript 1.2.1 (#34)