Namespace Recipes

Module used to manipulate crafting recipes for vanilla and custom workbenches.

Classes

WorkbenchUIHandler

Functions

addFurnace addFurnaceFuel addShaped addShaped2 addShapedGeneric addShapedVanilla addShapeless addShapelessGeneric addShapelessVanilla deleteRecipe getAllFurnaceRecipes getAllWorkbenchRecipes getFuelBurnDuration getFurnaceRecipeResult getFurnaceRecipesByResult getRecipeByField getRecipeResult getWorkbenchRecipesByIngredient getWorkbenchRecipesByResult provideRecipe removeFurnaceFuel removeFurnaceRecipe removeWorkbenchRecipe

Interfaces

CraftingFunction FurnaceRecipe RecipeEntry WorkbenchField WorkbenchFieldAPI WorkbenchRecipe WorkbenchShapedRecipe WorkbenchShapelessRecipe

Functions

addFurnace

  • addFurnace(sourceId, sourceData, resultId, resultData, prefix?): void

  • Adds new furnace recipe.

    Parameters

    • sourceId: number

      source item ID

    • sourceData: number

      source item data

    • resultId: number

      resulting item ID

    • resultData: number

      resulting item data

    • Optionalprefix: string

      prefix, used to create recipes for non-vanilla furnaces

    Returns void

  • addFurnace(sourceId, resultId, resultData, prefix?): void

  • Adds new furnace recipe with no need to manually specify input item data (it defaults to -1).

    Parameters

    • sourceId: number

      source item ID

    • resultId: number

      result item ID

    • resultData: number

      resulting item data

    • Optionalprefix: string

      prefix, used to create recipes for non-vanilla furnaces; if the prefix is not empty and some recipes for this source exist for vanilla furnace, they are removed

    Returns void

addFurnaceFuel

  • addFurnaceFuel(id, data, time): void

  • Adds fuel that can be used in the furnace.

    Parameters

    • id: number

      fuel item ID

    • data: number

      fuel item data

    • time: number

      burning time in ticks

    Returns void

addShaped

  • addShaped(result, mask, data, func?, prefix?): WorkbenchShapedRecipe

  • Adds new shaped crafting recipe.

    Parameters

    • result: ItemInstance

      recipe result item

    • mask: string[]

      recipe shape, up to three string corresponding to the three crafting field rows; each character means one item in the field

    • data: (string | number)[]

      an array explaining the meaning of each character within mask. The array should contain three values for each symbol: the symbol itself, item ID and item data.

    • Optionalfunc: CraftingFunction

      function to be called when the craft is processed

    • Optionalprefix: string

      recipe prefix. Use a non-empty values to register recipes for custom workbenches

    Returns WorkbenchShapedRecipe

    Example

    Recipes.addShaped({ id: 264, count: 1, data: 0 }, [
        "ax", 
        "xa", 
        "ax"
    ], ['x', 265, 0, 'a', 266, 0]);

    Remarks

    Pickaxe recipe should look like this:

    "+++"
" | "
" | "

    Do not use empty lines or line endings, if the recipe can be placed within less then three rows or cols; e.g., to craft plates, you can use a shape like this:

    "--"

addShaped2

addShapedGeneric

addShapedVanilla

addShapeless

  • addShapeless(result, data, func?, prefix?): WorkbenchShapelessRecipe

  • Adds new shapeless crafting recipe.

    Parameters

    • result: ItemInstance

      recipe result item

    • data: {
          data: number;
          id: number;
      }[]

      crafting ingredients, an array of objects representing item ID and data

    • Optionalfunc: CraftingFunction

      function to be called when the craft is processed

    • Optionalprefix: string

      recipe prefix; use a non-empty values to register recipes for custom workbenches

    Returns WorkbenchShapelessRecipe

    Example

    Recipes.addShapeless({ id: 264, count: 1, data: 0 }, [
        { id: 265, data: 0 }, { id: 265, data: 0 }, { id: 265, data: 0 },
        { id: 266, data: 0 }, { id: 266, data: 0 }, { id: 266, data: 0 }
    ]);

addShapelessGeneric

addShapelessVanilla

deleteRecipe

  • deleteRecipe(result): void

  • Deletes recipe by it's result.

    Parameters

    Returns void

getAllFurnaceRecipes

getAllWorkbenchRecipes

getFuelBurnDuration

  • getFuelBurnDuration(id, data): number

  • Parameters

    • id: number
    • data: number

    Returns number

    Fuel burn duration by fuel item ID and data.

getFurnaceRecipeResult

  • getFurnaceRecipeResult(id, data, prefix?): ItemInstance

  • Parameters

    • id: number
    • data: number
    • Optionalprefix: string

      recipe prefix used for non-vanilla furnaces

    Returns ItemInstance

    Furnace recipe resulting item.

getFurnaceRecipesByResult

  • getFurnaceRecipesByResult(resultId, resultData, prefix): java.util.Collection<FurnaceRecipe>

  • Gets furnace recipes by result and custom prefix.

    Parameters

    • resultId: number

      result item ID

    • resultData: number

      result item data

    • prefix: string

      recipe prefix used for non-vanilla furnaces

    Returns java.util.Collection<FurnaceRecipe>

    Collection object with all furnace recipes found by given params.

getRecipeByField

getRecipeResult

getWorkbenchRecipesByIngredient

getWorkbenchRecipesByResult

provideRecipe

removeFurnaceFuel

  • removeFurnaceFuel(id, data): void

  • Removes furnace fuel by fuel item ID and data.

    Parameters

    • id: number
    • data: number

    Returns void

removeFurnaceRecipe

  • removeFurnaceRecipe(sourceId, sourceData): void

  • Removes furnace recipes by source item.

    Parameters

    • sourceId: number

      source item ID

    • sourceData: number

      source item data

    Returns void

removeWorkbenchRecipe

  • removeWorkbenchRecipe(id, count, data): void

  • Removes recipe by result ID, count and data.

    Parameters

    • id: number
    • count: number
    • data: number

    Returns void

Settings

Member Visibility

On This Page

Functions

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.