Item Stack Provider Bindings

Item stack providers are an item stack with attached data, known as item stack modifiers. There are several methods for creating them

These are available from the TFC.itemStackProvider and TFC.isp fields

Method Signatures

TFC.itemStackProvider.of(itemStack: ItemStack, modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>)): ItemStackProvider
TFC.isp.empty(modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>)): ItemStackProvider
TFC.itemStackProvider.copyInput(modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>)): ItemStackProvider

• .of(itemStack: ItemStack, modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>))

  : Returns an item stack provider with the given item and modifiers
  • 1st argument: An item stack, the item stack of the ISP
  • Optional 2nd argument: A string, json array, json object, of list of strings and/or json objects, the modifiers to add. If not provided, no modifiers will be applied to the ISP

• .empty(modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>))

  : Returns an item stack modifier with an empty item stack and the provided modifiers
  • Optional 1st argument: A string, json array, json object, of list of strings and/or json objects, the modifiers to add. If not provided, no modifiers will be applied to the ISP

• .copyInput(modifiers?: (String | JsonArray | JsonObject | List<(String | JsonObject)>))

  : Returns an empty ISP with the tfc:copy_input modifier and the provided modifiers
  • Optional 1st argument: A string, json array, json object, of list of strings and/or json objects, the modifiers to add. If not provided, only the copy input modifier will be applied to the ISP

These methods return an ItemStackProviderJS object which has several helper methods and is described below

Examples

TFC.itemStackProvider.of('3x minecraft:dirt', ['tfc:add_glass', {type: 'tfc:add_trait', trait: 'kubejs:my_cool_trait'}])
TFC.isp.of('5x minecraft:stone')
TFC.itemStackProvider.empty('tfc:add_powder')
TFC.isp.copyInput()
TFC.itemStackProvider.copyInput('tfc:copy_heat')

In json:

{
    "stack": {
        "item": "minecraft:dirt",
        "count": 3
    },
    "modifiers": [
        {
            "type": "tfc:add_glass"
        },
        {
            "type": "tfc:add_trait",
            "trait": "kubejs:my_cool_trait"
        }
    ]
}

{
    "item": "minecraft:stone",
    "count": 5
}

{
    "modifiers": [
        {
            "type": "tfc:add_powder"
        }
    ]
}

{
    "modifiers": [
        {
            "type": "tfc:copy_input"
        }
    ]
}

{
    "modifiers": [
        {
            "type": "tfc:copy_input"
        },
        {
            "type": "tfc:copy_heat"
        }
    ]
}

ItemStackProviderJS

An ItemStackProviderJS is an object which is meant to mirror an actual ItemStackProvider but be friendly to modify from JS and can be serialized into json.

Method Signatures

isp.stack(): ItemStack
isp.modifiers(): JsonArray
isp.isEmpty(): boolean
isp.isSimple(): boolean
isp.withCount(i: number): ItemStackProviderJS
isp.getCount(): number
isp.getJsonStack(): JsonObject
isp.getModifiersOfType(type: String): List<JsonObject>
isp.toJson(): JsonObject
isp.asCanonClass(): ItemStackProvider
isp.dependsOnInput(): boolean
isp.copy(): ItemStackProviderJS
isp.getTag(): @Nullable CompoundTag
isp.setTag(tag: CompoundTag): ItemStackProviderJS
isp.mergeTag(tag: CompoundTag): ItemStackProviderJS
isp.simpleModifier(type: String): ItemStackProviderJS
isp.jsonModifier(modifier: JsonObject): ItemStackProviderJS
isp.dyeLeather(color: DyeColor): ItemStackProviderJS
isp.addHeat(temperature: number): ItemStackProviderJS
isp.addPowder(): ItemStackProviderJS
isp.addTrait(trait: String): ItemStackProviderJS
isp.removeTrait(trait: String): ItemStackProviderJS
isp.addGlass(): ItemStackProviderJS
isp.copyFood(): ItemStackProviderJS
isp.copyForgingBonus(): ItemStackProviderJS
isp.copyHeat(): ItemStackProviderJS
isp.copyInput(): ItemStackProviderJS
isp.emptyBowl(): ItemStackProviderJS
isp.resetFood(): ItemStackProviderJS
isp.copyOldestFood(): ItemStackProviderJS
isp.addBait(): ItemStackProviderJS
isp.meal(food: Consumer<BuildFoodItemData>, portions?: Consumer<BuildPortionData>[]): ItemStackProviderJS
// The following are available if FirmaLife is installed
isp.firmaLifeAddPiePan(): ItemStackProviderJS
isp.firmaLifeCopyDynamicFood(): ItemStackProviderJS
isp.firmaLifeEmptyPan(): ItemStackProviderJS

• .stack()

  : Returns the ItemStack of the ISP

• .modifiers()

  : Returns a json array of all of the applied modifiers

• .isEmpty()

  : Returns true if the stack and modifier list is empty

• .withCount(i: number)

  : Sets the stacks count to the provided value

• .getCount()

  : Returns the stack’s count

• .getJsonStack()

  : Returns a json object representing the item stack

• .getModifiersOfType(type: String)

  : Returns a list of json objects which represent the applied modifiers with the given type

• .toJson()

  : Returns the json representation of the ISP

• .asCanonClass()

  : Returns the ISP as an ItemStackProvider object, TFC’s canonical class for this data

• .dependsOnInput()

  : Returns true if any of the applied modifiers is dependent on the recipe’s input

• .copy()

  : Returns a copy of the ISP

• .getTag()

  : Returns the item stack’s CompoundTag, may be null

• .setTag(tag: CompoundTag)

  : Sets the item stack’s CompoundTag

• .mergeTag(tag: CompoundTag)

  : Merges the provided CompoundTag into the item stack’s

• .simpleModifier(type: String)

  : Adds a modifier of the provided type

• .jsonModifier(modifier: JsonObject)

  : Adds the provided json modifier

• .dyeLeather(color: DyeColor)

  : Adds a tfc:dye_leather modifier with the provided color

• .addHeat(temperature: number)

  : Adds a tfc:add_heat with the provided temperature, allows negative values

• .addPowder()

  : Adds a tfc:add_powder modifier

• .addTrait(trait: String)

  : Adds a tfc:add_trait modifier with the provided trait value

• .removeTrait(trait: String)

  : Adds a tfc:remove_trait modifier with the provided trait value

• .addGlass()

  : Adds a tfc:add_glass modifier

• .copyFood()

  : Adds a tfc:copy_food modifier

• .copyForgingBonus()

  : Adds a tfc:copy_forging_bonus modifier

• .copyHeat()

  : Adds a tfc:copy_heat modifier

• .copyInput()

  : Adds a tfc:copy_input modifier

• .emptyBowl()

  : Adds a tfc:empty_bowl modifier

• .resetFood()

  : Adds a tfc:reset_food modifier

• .copyOldestFood()

  : Adds a tfc:copy_oldest_food modifier

• .addBait()

  : Adds a tfc:add_bait_to_rod modifier

• .meal(food: Consumer<BuildFoodItemData>, portions?: Consumer<BuildPortionData>[])

  : Adds a tfc:meal modifier
  • 1st argument: A consumer with the same methods as the 2nd argument of a food definition
  • Optional 2nd argument: An array of consumers specifying the portions of a meal
    • .ingredient(ingredient: Ingredient): Sets the portion’s ingredient
    • .nutrientModifier(modifier: number): Multiplies the nutrition from the ingredient, defaults to 1
    • .waterModifier(modifier: number): Multiplies the water from the ingredient, defaults to 1
    • .saturationModifier(modifier: number): Multiplies the saturation from the ingredient, defaults to 1

If FirmaLife is installed the following methods are available:

• .firmaLifeAddPiePan()

  : Adds a firmalife:add_pie_pan modifier

• .firmaLifeCopyDynamicFood()

  : Adds a firmalife:copy_dynamic_food modifier

• .firmaLifeEmptyPan()

  : Adds a firmalife:empty_pan modifier

Examples

TFC.itemStackProvider.copyInput().copyHeat().copyOldestFood()
TFC.itemStackProvider.of('5x minecraft:glass').addHeat(500)

In json:

{
    "modifiers": [
        {
            "type": "tfc:copy_input"
        },
        {
            "type": "tfc:copy_heat"
        },
        {
            "type": "tfc:copy_oldest_food"
        }
    ]
}

{
    "stack": {
        "item": "minecraft:glass",
        "count": 5
    },
    "modifiers": [
        {
            "type": "tfc:add_heat",
            "temperature": 500
        }
    ]
}