HomeCommandsExamplesGetting Started With ScriptsGlobal Keywords
Generic JSON Recipes

ItemStackProvider

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import mods.tfc.api.ingredient.ItemStackProvider;

Static Methods

Add Heat to the recipe input item

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.addInputHeat(heat as float) as ItemStackProvider
ItemStackProvider.addInputHeat(100);
ParameterTypeDescription
Parameter
heat
Type
float
Description
heat to add to the input

Add heat to the output

Returns: TFCItemStackProvider
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.addOutputHeat(output as IItemStack, heat as float) as ItemStackProvider
ItemStackProvider.addOutputHeat(<item:tfc:metal/ingot/copper>, 100);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
heat item
Parameter
heat
Type
float
Description
heat to add to the output

Add or remove a trait from the recipe input item

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.addRemoveTrait(trait as string, add as boolean) as ItemStackProvider
ItemStackProvider.addRemoveTrait("salted", false);
ParameterTypeDescription
Parameter
trait
Type
string
Description
name of the trait
Parameter
add
Type
boolean
Description
true to add the trait, false to remove it

Add or remove a trait to the output item

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.addRemoveTrait(output as IItemStack, trait as string, add as boolean) as ItemStackProvider
ItemStackProvider.addRemoveTrait(<item:tfc:food/banana>, "salted", true);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
item
Parameter
trait
Type
string
Description
name of the trait
Parameter
add
Type
boolean
Description
true to add the trait, false to remove it

Copy the input item food data to the output

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyFood(output as IItemStack) as ItemStackProvider
ItemStackProvider.copyFood(<item:tfc:food/banana>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
output item

Copy the input forging bonus.

Returns: TFCItemStackProvider
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyForgingBonus(output as IItemStack) as ItemStackProvider
ItemStackProvider.copyForgingBonus(<item:tfc:metal/ingot/bronze>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
output item

Copy the input heat to the output

Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyHeat() as ItemStackProvider
ItemStackProvider.copyHeat();

Copy the input item heat data to the output

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyHeat(output as IItemStack) as ItemStackProvider
ItemStackProvider.copyHeat(<item:tfc:metal/ingot/copper>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
output item

Return a copy of the input

Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyInput() as ItemStackProvider
ItemStackProvider.copyInput();

Copy the oldest food from the input and add it to the output item

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.copyOldestFood(output as IItemStack) as ItemStackProvider
ItemStackProvider.copyOldestFood(<item:tfc:food/banana>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
output item

Create an empty ItemStack provider

Returns: TFCItemStackProvider
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.empty() as ItemStackProvider
ItemStackProvider.empty();

Create an ItemStackProvider with no Modifier.

Returns: TFCItemStackProvider
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.none(output as IItemStack) as ItemStackProvider
ItemStackProvider.none(<item:tfc:metal/double_ingot/copper>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
item output

Reset the input food data.

Returns: TFCItemStackProvider
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.resetFood() as ItemStackProvider
ItemStackProvider.resetFood();

Reset the output Food data

Returns:
Return Type: ItemStackProvider

script.zs
// ItemStackProvider.resetFood(output as IItemStack) as ItemStackProvider
ItemStackProvider.resetFood(<item:tfc:food/banana>);
ParameterTypeDescription
Parameter
output
Type
IItemStack
Description
output item

Constructors

script.zs
new ItemStackProvider() as ItemStackProvider
new ItemStackProvider();