This class extends Terraria.Recipe, meaning you can use it in a similar manner to vanilla recipes. However, it provides methods that simplify recipe creation. Recipes are added by creating new instances of ModRecipe, then calling the AddRecipe method. More...

Inheritance diagram for Terraria.ModLoader.ModRecipe:

Collaboration diagram for Terraria.ModLoader.ModRecipe:

Public Member Functions
	ModRecipe (Mod mod)
	Constructor More...

void	AddIngredient (int itemID, int stack=1)
	Adds an ingredient to this recipe with the given item type and stack size. Ex: `recipe.AddIngredient(ItemID.IronAxe)` More...

void	AddIngredient (Mod mod, string itemName, int stack=1)
	Adds an ingredient to this recipe with the given item name from the given mod, and with the given stack stack. If the mod parameter is null, then it will automatically use an item from the mod creating this recipe. More...

void	AddIngredient (ModItem item, int stack=1)
	Adds an ingredient to this recipe of the given type of item and stack size. More...

void	AddRecipe ()
	Adds this recipe to the game. Call this after you have finished setting the result, ingredients, etc. More...

void	AddRecipeGroup (int recipeGroupID, int stack=1)
	Adds a recipe group ingredient to this recipe with the given RecipeGroupID and stack size. Vanilla recipe group IDs can be found in Terraria.ID.RecipeGroupID and modded recipe group IDs will be returned from RecipeGroup.RegisterGroup. More...

void	AddRecipeGroup (string name, int stack=1)
	Adds a recipe group ingredient to this recipe with the given RecipeGroup name and stack size. Vanilla recipe groups consist of "Wood", "IronBar", "PresurePlate", "Sand", and "Fragment". More...

void	AddTile (int tileID)
	Adds a required crafting station with the given tile type to this recipe. Ex: `recipe.AddTile(TileID.WorkBenches)` More...

void	AddTile (Mod mod, string tileName)
	Adds a required crafting station to this recipe with the given tile name from the given mod. If the mod parameter is null, then it will automatically use a tile from the mod creating this recipe. More...

void	AddTile (ModTile tile)
	Adds a required crafting station to this recipe of the given type of tile. More...

virtual int	ConsumeItem (int type, int numRequired)
	Allows you to determine how many of a certain ingredient is consumed when this recipe is used. Return the number of ingredients that will actually be consumed. By default returns numRequired. More...

virtual void	OnCraft (Item item)
	Allows you to make anything happen when the player uses this recipe. The item parameter is the item the player has just crafted. More...

virtual bool	RecipeAvailable ()
	Whether or not the conditions are met for this recipe to be available for the player to use. This hook can be used for conditions unrelated to items or tiles (for example, biome or time). More...

void	SetResult (int itemID, int stack=1)
	Sets the result of this recipe with the given item type and stack size. More...

void	SetResult (Mod mod, string itemName, int stack=1)
	Sets the result of this recipe with the given item name from the given mod, and with the given stack stack. If the mod parameter is null, then it will automatically use an item from the mod creating this recipe. More...

void	SetResult (ModItem item, int stack=1)
	Sets the result of this recipe to the given type of item and stack size. Useful in ModItem.AddRecipes. More...

Public Attributes
readonly Mod	mod

Properties
int	RecipeIndex `[get, private set]`
	The index of the recipe in the Main.recipe array. More...

Private Attributes
int	numIngredients = 0

int	numTiles = 0

Detailed Description

This class extends Terraria.Recipe, meaning you can use it in a similar manner to vanilla recipes. However, it provides methods that simplify recipe creation. Recipes are added by creating new instances of ModRecipe, then calling the AddRecipe method.

Definition at line 10 of file ModRecipe.cs.

Constructor & Destructor Documentation

◆ ModRecipe()

Terraria.ModLoader.ModRecipe.ModRecipe ( Mod mod )

Constructor

Parameters

mod	The mod the recipe originates from.

Definition at line 28 of file ModRecipe.cs.

                                  {
            if (!RecipeHooks.setupRecipes)
                throw new RecipeException("A ModRecipe can only be created inside recipe related methods");
            this.mod = mod;
        }

References Terraria.ModLoader.ModRecipe.mod.

Member Function Documentation

◆ AddIngredient() [1/3]

void Terraria.ModLoader.ModRecipe.AddIngredient	(	int	itemID,
		int	stack = `1`
	)

Adds an ingredient to this recipe with the given item type and stack size. Ex: recipe.AddIngredient(ItemID.IronAxe)

Parameters

itemID	The item identifier.
stack	The stack.

Definition at line 78 of file ModRecipe.cs.

                                                             {
            if (numIngredients == 14)
                throw new RecipeException("Recipe already has maximum number of ingredients. 14 is the max.");
            this.requiredItem[numIngredients].SetDefaults(itemID, false);
            this.requiredItem[numIngredients].stack = stack;
            numIngredients++;
        }

References Terraria.ModLoader.ModRecipe.numIngredients.

Referenced by Terraria.ModLoader.ModRecipe.AddIngredient(), and Terraria.ModLoader.ModRecipe.AddRecipeGroup().

Here is the caller graph for this function:

◆ AddIngredient() [2/3]

void Terraria.ModLoader.ModRecipe.AddIngredient	(	Mod	mod,
		string	itemName,
		int	stack = `1`
	)

Adds an ingredient to this recipe with the given item name from the given mod, and with the given stack stack. If the mod parameter is null, then it will automatically use an item from the mod creating this recipe.

Parameters

mod	The mod.
itemName	Name of the item.
stack	The stack.

Exceptions

RecipeException The item " + itemName + " does not exist in mod " + mod.Name + ". If you are trying to use a vanilla item, try removing the first argument.

Definition at line 93 of file ModRecipe.cs.

                                                                           {
            if (mod == null) {
                mod = this.mod;
            }
            int type = mod.ItemType(itemName);
            if (type == 0) {
                string message = "The item " + itemName + " does not exist in the mod " + mod.Name + "." + Environment.NewLine;
                message += "If you are trying to use a vanilla item, try removing the first argument.";
                throw new RecipeException(message);
            }
            this.AddIngredient(type, stack);
        }

References Terraria.ModLoader.ModRecipe.AddIngredient(), Terraria.ModLoader.Environment, Terraria.ModLoader.Mod.ItemType(), and Terraria.ModLoader.ModRecipe.mod.

Here is the call graph for this function:

◆ AddIngredient() [3/3]

void Terraria.ModLoader.ModRecipe.AddIngredient	(	ModItem	item,
		int	stack = `1`
	)

Adds an ingredient to this recipe of the given type of item and stack size.

Parameters

item	The item.
stack	The stack.

Definition at line 111 of file ModRecipe.cs.

                                                               {
            this.AddIngredient(item.item.type, stack);
        }

References Terraria.ModLoader.ModRecipe.AddIngredient(), and Terraria.ModLoader.ModItem.item.

Here is the call graph for this function:

◆ AddRecipe()

void Terraria.ModLoader.ModRecipe.AddRecipe ( )

Adds this recipe to the game. Call this after you have finished setting the result, ingredients, etc.

Exceptions

RecipeException A recipe without any result has been added.

Definition at line 221 of file ModRecipe.cs.

                                {
            if (this.createItem == null || this.createItem.type == 0) {
                throw new RecipeException("A recipe without any result has been added.");
            }
            if (this.numIngredients > 14 || this.numTiles > 14) {
                throw new RecipeException("A recipe with either too many tiles or too many ingredients has been added. 14 is the maximum amount.");
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (this.requiredTile[k] == TileID.Bottles) {
                    this.alchemy = true;
                    break;
                }
            }
            if (Recipe.numRecipes >= Recipe.maxRecipes) {
                Recipe.maxRecipes += 500;
                Array.Resize(ref Main.recipe, Recipe.maxRecipes);
                Array.Resize(ref Main.availableRecipe, Recipe.maxRecipes);
                Array.Resize(ref Main.availableRecipeY, Recipe.maxRecipes);
                for (int k = Recipe.numRecipes; k < Recipe.maxRecipes; k++) {
                    Main.recipe[k] = new Recipe();
                    Main.availableRecipeY[k] = 65f * k;
                }
            }
            Main.recipe[Recipe.numRecipes] = this;
            this.RecipeIndex = Recipe.numRecipes;
            mod.recipes.Add(this);
            Recipe.numRecipes++;
        }

References Terraria.ModLoader.ModRecipe.mod.

◆ AddRecipeGroup() [1/2]

void Terraria.ModLoader.ModRecipe.AddRecipeGroup	(	int	recipeGroupID,
		int	stack = `1`
	)

Adds a recipe group ingredient to this recipe with the given RecipeGroupID and stack size. Vanilla recipe group IDs can be found in Terraria.ID.RecipeGroupID and modded recipe group IDs will be returned from RecipeGroup.RegisterGroup.

Parameters

recipeGroupID	The RecipeGroupID.
stack	The stack.

Exceptions

RecipeException A recipe group with the ID " + recipeGroupID + " does not exist.

Definition at line 137 of file ModRecipe.cs.

        {
            if (!RecipeGroup.recipeGroups.ContainsKey(recipeGroupID)) {
                throw new RecipeException("A recipe group with the ID " + recipeGroupID + " does not exist.");
            }
            RecipeGroup rec = RecipeGroup.recipeGroups[recipeGroupID];
            AddIngredient(rec.ValidItems[rec.IconicItemIndex], stack);
            acceptedGroups.Add(recipeGroupID);
        }

References Terraria.ModLoader.ModRecipe.AddIngredient().

Here is the call graph for this function:

◆ AddRecipeGroup() [2/2]

void Terraria.ModLoader.ModRecipe.AddRecipeGroup	(	string	name,
		int	stack = `1`
	)

Adds a recipe group ingredient to this recipe with the given RecipeGroup name and stack size. Vanilla recipe groups consist of "Wood", "IronBar", "PresurePlate", "Sand", and "Fragment".

Parameters

name	The name.
stack	The stack.

Exceptions

RecipeException A recipe group with the name " + name + " does not exist.

Definition at line 121 of file ModRecipe.cs.

                                                               {
            if (!RecipeGroup.recipeGroupIDs.ContainsKey(name)) {
                throw new RecipeException("A recipe group with the name " + name + " does not exist.");
            }
            int id = RecipeGroup.recipeGroupIDs[name];
            RecipeGroup rec = RecipeGroup.recipeGroups[id];
            AddIngredient(rec.ValidItems[rec.IconicItemIndex], stack);
            acceptedGroups.Add(id);
        }

References Terraria.ModLoader.ModRecipe.AddIngredient().

Here is the call graph for this function:

◆ AddTile() [1/3]

void Terraria.ModLoader.ModRecipe.AddTile ( int tileID )

Adds a required crafting station with the given tile type to this recipe. Ex: recipe.AddTile(TileID.WorkBenches)

Parameters

tileID The tile identifier.

Exceptions

RecipeException No tile has ID " + tileID

Definition at line 152 of file ModRecipe.cs.

                                        {
            if (numTiles == 14)
                throw new RecipeException("Recipe already has maximum number of tiles. 14 is the max.");
            if (tileID < 0 || tileID >= TileLoader.TileCount) {
                throw new RecipeException("No tile has ID " + tileID);
            }
            this.requiredTile[numTiles] = tileID;
            numTiles++;
        }

References Terraria.ModLoader.ModRecipe.numTiles, and Terraria.ModLoader.TileLoader.TileCount.

Referenced by Terraria.ModLoader.ModRecipe.AddTile().

Here is the caller graph for this function:

◆ AddTile() [2/3]

void Terraria.ModLoader.ModRecipe.AddTile	(	Mod	mod,
		string	tileName
	)

Adds a required crafting station to this recipe with the given tile name from the given mod. If the mod parameter is null, then it will automatically use a tile from the mod creating this recipe.

Parameters

mod	The mod.
tileName	Name of the tile.

Exceptions

RecipeException The tile " + tileName + " does not exist in mod " + mod.Name + ". If you are trying to use a vanilla tile, try using ModRecipe.AddTile(tileID).

Definition at line 168 of file ModRecipe.cs.

                                                      {
            if (mod == null) {
                mod = this.mod;
            }
            int type = mod.TileType(tileName);
            if (type == 0) {
                string message = "The tile " + tileName + " does not exist in the mod " + mod.Name + "." + Environment.NewLine;
                message += "If you are trying to use a vanilla tile, try using ModRecipe.AddTile(tileID).";
                throw new RecipeException(message);
            }
            this.AddTile(type);
        }

References Terraria.ModLoader.ModRecipe.AddTile(), Terraria.ModLoader.Environment, Terraria.ModLoader.ModRecipe.mod, and Terraria.ModLoader.Mod.TileType().

Here is the call graph for this function:

◆ AddTile() [3/3]

void Terraria.ModLoader.ModRecipe.AddTile ( ModTile tile )

Adds a required crafting station to this recipe of the given type of tile.

Parameters

tile The tile.

Definition at line 185 of file ModRecipe.cs.

                                          {
            this.AddTile(tile.Type);
        }

References Terraria.ModLoader.ModRecipe.AddTile(), and Terraria.ModLoader.ModTile.Type.

Here is the call graph for this function:

◆ ConsumeItem()

virtual int Terraria.ModLoader.ModRecipe.ConsumeItem	(	int	type,
		int	numRequired
	)

virtual

Allows you to determine how many of a certain ingredient is consumed when this recipe is used. Return the number of ingredients that will actually be consumed. By default returns numRequired.

Parameters

type	The type.
numRequired	The number required.

Returns

Definition at line 213 of file ModRecipe.cs.

                                                                  {
            return numRequired;
        }

◆ OnCraft()

virtual void Terraria.ModLoader.ModRecipe.OnCraft ( Item item )

virtual

Allows you to make anything happen when the player uses this recipe. The item parameter is the item the player has just crafted.

Parameters

item The item.

Definition at line 201 of file ModRecipe.cs.

201 {

202 }

Referenced by Terraria.ModLoader.RecipeHooks.OnCraft().

Here is the caller graph for this function:

◆ RecipeAvailable()

virtual bool Terraria.ModLoader.ModRecipe.RecipeAvailable ( )

virtual

Whether or not the conditions are met for this recipe to be available for the player to use. This hook can be used for conditions unrelated to items or tiles (for example, biome or time).

Returns: Whether or not the conditions are met for this recipe to be available for the player to use.

Definition at line 193 of file ModRecipe.cs.

                                              {
            return true;
        }

Referenced by Terraria.ModLoader.RecipeHooks.RecipeAvailable().

Here is the caller graph for this function:

◆ SetResult() [1/3]

void Terraria.ModLoader.ModRecipe.SetResult	(	int	itemID,
		int	stack = `1`
	)

Sets the result of this recipe with the given item type and stack size.

Parameters

itemID	The item identifier.
stack	The stack.

Definition at line 39 of file ModRecipe.cs.

                                                         {
            this.createItem.SetDefaults(itemID, false);
            this.createItem.stack = stack;
        }

Referenced by Terraria.ModLoader.ModRecipe.SetResult().

Here is the caller graph for this function:

◆ SetResult() [2/3]

void Terraria.ModLoader.ModRecipe.SetResult	(	Mod	mod,
		string	itemName,
		int	stack = `1`
	)

Sets the result of this recipe with the given item name from the given mod, and with the given stack stack. If the mod parameter is null, then it will automatically use an item from the mod creating this recipe.

Parameters

mod	The mod the item originates from.
itemName	Name of the item.
stack	The stack.

Exceptions

RecipeException The item " + itemName + " does not exist in mod " + mod.Name + ". If you are trying to use a vanilla item, try removing the first argument.

Definition at line 51 of file ModRecipe.cs.

                                                                       {
            if (mod == null) {
                mod = this.mod;
            }
            int type = mod.ItemType(itemName);
            if (type == 0) {
                string message = "The item " + itemName + " does not exist in the mod " + mod.Name + "." + Environment.NewLine;
                message += "If you are trying to use a vanilla item, try removing the first argument.";
                throw new RecipeException(message);
            }
            this.SetResult(type, stack);
        }

References Terraria.ModLoader.Environment, Terraria.ModLoader.Mod.ItemType(), Terraria.ModLoader.ModRecipe.mod, and Terraria.ModLoader.ModRecipe.SetResult().

Here is the call graph for this function:

◆ SetResult() [3/3]

void Terraria.ModLoader.ModRecipe.SetResult	(	ModItem	item,
		int	stack = `1`
	)

Sets the result of this recipe to the given type of item and stack size. Useful in ModItem.AddRecipes.

Parameters

item	The item.
stack	The stack.

Definition at line 69 of file ModRecipe.cs.

                                                           {
            this.SetResult(item.item.type, stack);
        }

References Terraria.ModLoader.ModItem.item, and Terraria.ModLoader.ModRecipe.SetResult().

Here is the call graph for this function:

Member Data Documentation

◆ mod

readonly Mod Terraria.ModLoader.ModRecipe.mod

Definition at line 12 of file ModRecipe.cs.

Referenced by Terraria.ModLoader.ModRecipe.ModRecipe(), Terraria.ModLoader.ModRecipe.AddIngredient(), Terraria.ModLoader.ModRecipe.AddRecipe(), Terraria.ModLoader.ModRecipe.AddTile(), and Terraria.ModLoader.ModRecipe.SetResult().

◆ numIngredients

int Terraria.ModLoader.ModRecipe.numIngredients = 0

private

Definition at line 13 of file ModRecipe.cs.

Referenced by Terraria.ModLoader.ModRecipe.AddIngredient().

◆ numTiles

int Terraria.ModLoader.ModRecipe.numTiles = 0

private

Definition at line 14 of file ModRecipe.cs.

Referenced by Terraria.ModLoader.ModRecipe.AddTile().

Property Documentation

◆ RecipeIndex

int Terraria.ModLoader.ModRecipe.RecipeIndex

getprivate set

The index of the recipe in the Main.recipe array.

Definition at line 19 of file ModRecipe.cs.

                               {
            get;
            private set;
        }

Public Member Functions

Public Attributes

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ModRecipe()

Member Function Documentation

◆ AddIngredient() [1/3]

◆ AddIngredient() [2/3]

◆ AddIngredient() [3/3]

◆ AddRecipe()

◆ AddRecipeGroup() [1/2]

◆ AddRecipeGroup() [2/2]

◆ AddTile() [1/3]

◆ AddTile() [2/3]

◆ AddTile() [3/3]

◆ ConsumeItem()

◆ OnCraft()

◆ RecipeAvailable()

◆ SetResult() [1/3]

◆ SetResult() [2/3]

◆ SetResult() [3/3]

Member Data Documentation

◆ mod

◆ numIngredients

◆ numTiles

Property Documentation

◆ RecipeIndex