Class default

Hierarchy

Constructors

constructor

Properties

item quantity type BASE

Methods

consumed getChangeInto getOutput getUsable isMet setBestItem setChangeInto setConsumed setDecayWeight setInheritQualityFrom setOutputIntermediate setPredicate

Constructors

constructor

Properties

Readonly item

item: ItemType | ItemTypeGroup

Readonly quantity

quantity: number = 1

Readonly type

type: Item

Static Readonly BASE

BASE: default = ...

Methods

consumed

  • Returns boolean

getChangeInto

  • Returns undefined | default

getOutput

  • Returns the ItemOutput that this requirement is used for.
    This is called internally, it should have no real use in recipe construction.

    Returns undefined | Intermediate

getUsable

isMet

  • Parameters

    • api: default
    • quantity: number = ...

    Returns boolean

setBestItem

  • Sets the "best" item to be used for this requirement. Used to display the efficacy of an actual input item.

    Parameters

    Returns default

setChangeInto

  • Sets this item requirement to be changed into another item on recipe completion.

    Parameters

    • item: ItemType

      The item to change into.

    • Optional initializer: ((output: default) => any)

      An initializer for configuring the item that the input will be changed into.

      Notes:

      • Using ChangeInto will ignore the Consumed setting
      • Configuring the quantity of the ItemOutput in the initializer will have no effect.

    Returns default

setConsumed

  • Item requirements are consumed by default, so this method should usually only be used to disable that.

    Parameters

    • consumed: boolean = true

    Returns default

setDecayWeight

  • Sets this items used for this item requirement to contribute their decay to the output items at the given weight.

    The default weight is 1, so if there is one item at default weight and one item at a weight of 2, the final decay would be 66% of the 2 weight item and 33% of the 1 weight item.

    Parameters

    • weight: number

    Returns default

setInheritQualityFrom

  • Sets the quality of the output items to use the quality of the highest-quality item passed to this requirement.
    Note: The output items will only use this quality by default, it can still be overridden by the item outputs.

    Returns default

setOutputIntermediate

  • Sets the ItemOutput that this requirement will be used for.
    This is called internally, it should have no real use in recipe construction.

    Parameters

    Returns default

setPredicate

  • Parameters

    • predicate: ((item: default, consumed: boolean) => boolean)
        • (item: default, consumed: boolean): boolean

        • Parameters

          Returns boolean

    Returns default

Settings

Member Visibility

Theme

Generated using TypeDoc