Recipes.WorkbenchRecipe

Object representing workbench recipe.

Hierarchy

• Object
  • WorkbenchRecipe
    • WorkbenchShapedRecipe
    • WorkbenchShapelessRecipe

Index

Methods

• addToVanillaWorkbench
• getCallback
• getEntry
• getEntryCodes
• getEntryCollection
• getPrefix
• getRecipeMask
• getRecipeUid
• getResult
• getSortedEntries
• isMatchingField
• isMatchingPrefix
• isMatchingResult
• isPossibleForInventory
• isValid
• isVanilla
• provideRecipe
• provideRecipeForPlayer
• putIntoTheField
• setCallback
• setEntries
• setPrefix
• setVanilla

Methods

addToVanillaWorkbench

• addToVanillaWorkbench(): void

• Returns void

getCallback

• getCallback(): CraftingFunction

• Returns CraftingFunction

  Current crafting function or null if no one was specified.

getEntry

• getEntry(c: string): RecipeEntry

• Parameters

  • c: string

    recipe entry character

  Returns RecipeEntry

  Recipe entry by entry character.

getEntryCodes

• getEntryCodes(): ArrayList<Long>

• Returns ArrayList<Long>

getEntryCollection

• getEntryCollection(): Collection<RecipeEntry>

• Returns Collection<RecipeEntry>

getPrefix

• getPrefix(): string

• Returns string

  Recipe prefix.

getRecipeMask

• getRecipeMask(): string

• Returns string

  Recipe unique mask identifier.

getRecipeUid

• getRecipeUid(): number

• Returns number

getResult

• getResult(): ItemInstance

• Returns ItemInstance

  Resulting item instance.

getSortedEntries

• getSortedEntries(): Array<RecipeEntry>

• Returns Array<RecipeEntry>

  All recipe's entries in a java array.

isMatchingField

• isMatchingField(field: WorkbenchField): boolean

• Parameters

  • field: WorkbenchField

    workbench field to compare with

  Returns boolean

  true if the field contains this recipe, false` otherwise.

isMatchingPrefix

• isMatchingPrefix(prefix: string): boolean

• Compares current recipe's prefix with given one.

  ---

  Parameters

  • prefix: string

    prefix value to compare with

  Returns boolean

  true, if current recipe's prefix is the same as given one, false otherwise.

isMatchingResult

• isMatchingResult(id: number, count: number, data: number): boolean

• Parameters

  • id: number

  • count: number

  • data: number

  Returns boolean

  true if specified item is recipe's result, false otherwise.

isPossibleForInventory

• isPossibleForInventory(inv: HashMap<Long, Integer>): boolean

• Parameters

  • inv: HashMap<Long, Integer>

  Returns boolean

isValid

• isValid(): boolean

• Returns boolean

  true, if the recipe is valid, false otherwise.

isVanilla

• isVanilla(): boolean

• Returns boolean

provideRecipe

• provideRecipe(field: WorkbenchField): ItemInstance

• Parameters

  • field: WorkbenchField

  Returns ItemInstance

provideRecipeForPlayer

• provideRecipeForPlayer(field: WorkbenchField, player: number): ItemInstance

• Parameters

  • field: WorkbenchField

  • player: number

  Returns ItemInstance

putIntoTheField

• putIntoTheField(field: WorkbenchField): void
• putIntoTheField(field: WorkbenchField, player: number): void

• Tries to fill workbench field with current recipe.

  ---

  Parameters

  • field: WorkbenchField

    workbench field to fill

  Returns void

setCallback

• setCallback(callback: CraftingFunction): void

• Sets craft function for the recipe.

  ---

  Parameters

  • callback: CraftingFunction

    function to be called on item craft

  Returns void

setEntries

• setEntries(entries: HashMap<Character, RecipeEntry>): void

• Parameters

  • entries: HashMap<Character, RecipeEntry>

  Returns void

setPrefix

• setPrefix(prefix: string): void

• Sets prefix value for the recipe.

  ---

  Parameters

  • prefix: string

    new prefix value

  Returns void

setVanilla

• setVanilla(isVanilla: boolean): WorkbenchRecipe

• Parameters

  • isVanilla: boolean

  Returns WorkbenchRecipe

  Reference to itself to be used in sequential calls.