This class allows you to make any changes you want to a recipe, whether it be adding/removing ingredients, changing the result, or removing the recipe entirely. More...

Collaboration diagram for Terraria.ModLoader.RecipeEditor:

Public Member Functions
	RecipeEditor (Recipe recipe)
	Creates a recipe editor that acts on the given recipe. More...

bool	AcceptRecipeGroup (string groupName)
	Adds the recipe group with the given name to the recipe. Note that, unlike ModRecipe and RecipeFinder, this won't actually add an ingredient; it will only allow existing ingredients to be interchangeable with other items. Returns true if the operation was successful. Returns false if the recipe already accepts the given recipe group. Can also throw a RecipeException. More...

void	AddIngredient (int itemID, int stack=1)
	Adds an ingredient with the given item ID and stack size to the recipe. If the recipe already contains the ingredient, it will increase the stack requirement instead. Can also throw a RecipeException. More...

bool	AddTile (int tileID)
	Adds the crafting station with the given tile ID to the recipe. Returns true if the operation was successful. Returns false if the recipe already requires the given tile. Can also throw a RecipeException. More...

bool	DeleteIngredient (int itemID)
	Deletes the ingredient requirement with the given ID from the recipe. Returns true if the operation was successful. Returns false if the recipe did not contain the ingredient in the first place. Can also throw a RecipeException. More...

bool	DeleteRecipe ()
	Completely removes the recipe from the game, making it unusable. Returns true if the operation was successful. Returns false if the recipe was already not in the game. More...

bool	DeleteTile (int tileID)
	Removes the crafting station with the given tile ID as a requirement from the recipe. Returns true if the operation was successful. Returns false if the recipe did not require the tile in the first place. Can also throw a RecipeException. More...

bool	RejectRecipeGroup (string groupName)
	Removes the recipe group with the given name from the recipe. This is the opposite of AcceptRecipeGroup; while it won't remove ingredients, it will make existing ingredients no longer be interchangeable with other items. Returns true if the operation was successful. Returns false if the recipe did not contain the recipe group in the first place. Can also throw a RecipeException. More...

bool	SetIngredientStack (int itemID, int stack)
	Sets the stack requirement of the ingredient with the given item ID in the recipe. Returns true if the operation was successful. Returns false if the recipe does not contain the ingredient. Can also throw a RecipeException. More...

void	SetNeedHoney (bool needHoney)
	A convenience method for setting recipe.needHoney. More...

void	SetNeedLava (bool needLava)
	A convenience method for setting recipe.needLava. More...

void	SetNeedWater (bool needWater)
	A convenience method for setting recipe.needWater. More...

void	SetResult (int itemID, int stack=1)
	A convenience method for setting the result of the recipe. Similar to calling recipe.createItem.SetDefaults(itemID), followed by recipe.createItem.stack = stack. Can also throw a RecipeException. More...

Private Attributes
Recipe	recipe

Detailed Description

This class allows you to make any changes you want to a recipe, whether it be adding/removing ingredients, changing the result, or removing the recipe entirely.

Definition at line 8 of file RecipeEditor.cs.

Constructor & Destructor Documentation

◆ RecipeEditor()

Terraria.ModLoader.RecipeEditor.RecipeEditor ( Recipe recipe )

Creates a recipe editor that acts on the given recipe.

Parameters

recipe The recipe this RecipeEditor should focus on.

Definition at line 16 of file RecipeEditor.cs.

                                           {
            this.recipe = recipe;
        }

References Terraria.ModLoader.RecipeEditor.recipe.

Member Function Documentation

◆ AcceptRecipeGroup()

bool Terraria.ModLoader.RecipeEditor.AcceptRecipeGroup ( string groupName )

Adds the recipe group with the given name to the recipe. Note that, unlike ModRecipe and RecipeFinder, this won't actually add an ingredient; it will only allow existing ingredients to be interchangeable with other items. Returns true if the operation was successful. Returns false if the recipe already accepts the given recipe group. Can also throw a RecipeException.

Parameters

groupName The recipegroup name to accept.

Returns: Whether adding the recipegroup was successful.

Definition at line 88 of file RecipeEditor.cs.

                                                        {
            int groupID;
            if (!RecipeGroup.recipeGroupIDs.TryGetValue(groupName, out groupID)) {
                throw new RecipeException("No recipe group is named " + groupName);
            }
            if (recipe.acceptedGroups.Contains(groupID)) {
                return false;
            }
            recipe.acceptedGroups.Add(groupID);
            return true;
        }

References Terraria.ModLoader.RecipeEditor.recipe.

◆ AddIngredient()

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

Adds an ingredient with the given item ID and stack size to the recipe. If the recipe already contains the ingredient, it will increase the stack requirement instead. Can also throw a RecipeException.

Parameters

itemID	The required item (ingredient) ID
stack	The required item (ingredient) stack

Definition at line 25 of file RecipeEditor.cs.

                                                             {
            if (itemID <= 0 || itemID >= ItemLoader.ItemCount) {
                throw new RecipeException("No item has ID " + itemID);
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (recipe.requiredItem[k].type == 0) {
                    recipe.requiredItem[k].SetDefaults(itemID, false);
                    recipe.requiredItem[k].stack = stack;
                    return;
                }
                if (recipe.requiredItem[k].type == itemID) {
                    recipe.requiredItem[k].stack += stack;
                    return;
                }
            }
            throw new RecipeException("Recipe already has maximum number of ingredients");
        }

References Terraria.ModLoader.ItemLoader.ItemCount, and Terraria.ModLoader.RecipeEditor.recipe.

◆ AddTile()

bool Terraria.ModLoader.RecipeEditor.AddTile ( int tileID )

Adds the crafting station with the given tile ID to the recipe. Returns true if the operation was successful. Returns false if the recipe already requires the given tile. Can also throw a RecipeException.

Parameters

tileID The tile ID to add.

Returns: Whether the operation was successful

Definition at line 131 of file RecipeEditor.cs.

                                        {
            if (tileID < 0 || tileID >= TileLoader.TileCount) {
                throw new RecipeException("No tile has ID " + tileID);
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (recipe.requiredTile[k] == -1) {
                    recipe.requiredTile[k] = tileID;
                    return true;
                }
                if (recipe.requiredTile[k] == tileID) {
                    return false;
                }
            }
            throw new RecipeException("Recipe already has maximum number of tiles");
        }

References Terraria.ModLoader.RecipeEditor.recipe, and Terraria.ModLoader.TileLoader.TileCount.

◆ DeleteIngredient()

bool Terraria.ModLoader.RecipeEditor.DeleteIngredient ( int itemID )

Deletes the ingredient requirement with the given ID from the recipe. Returns true if the operation was successful. Returns false if the recipe did not contain the ingredient in the first place. Can also throw a RecipeException.

Parameters

itemID The item ID of the ingredient to delete.

Returns: Whether the operation was successful.

Definition at line 67 of file RecipeEditor.cs.

                                                 {
            if (itemID <= 0 || itemID >= ItemLoader.ItemCount) {
                throw new RecipeException("No item has ID " + itemID);
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (recipe.requiredItem[k].type == itemID) {
                    for (int j = k; j < Recipe.maxRequirements - 1; j++) {
                        recipe.requiredItem[j] = recipe.requiredItem[j + 1];
                    }
                    recipe.requiredItem[Recipe.maxRequirements - 1] = new Item();
                    return true;
                }
            }
            return false;
        }

References Terraria.ModLoader.Item, Terraria.ModLoader.ItemLoader.ItemCount, and Terraria.ModLoader.RecipeEditor.recipe.

◆ DeleteRecipe()

bool Terraria.ModLoader.RecipeEditor.DeleteRecipe ( )

Completely removes the recipe from the game, making it unusable. Returns true if the operation was successful. Returns false if the recipe was already not in the game.

Returns

Definition at line 196 of file RecipeEditor.cs.

                                   {
            for (int k = 0; k < Recipe.numRecipes; k++) {
                if (Main.recipe[k] == recipe) {
                    for (int j = k; j < Recipe.numRecipes - 1; j++) {
                        Main.recipe[j] = Main.recipe[j + 1];
                    }
                    Main.recipe[Recipe.numRecipes - 1] = new Recipe();
                    Recipe.numRecipes--;
                    return true;
                }
            }
            return false;
        }

References Terraria.ModLoader.RecipeEditor.recipe.

◆ DeleteTile()

bool Terraria.ModLoader.RecipeEditor.DeleteTile ( int tileID )

Removes the crafting station with the given tile ID as a requirement from the recipe. Returns true if the operation was successful. Returns false if the recipe did not require the tile in the first place. Can also throw a RecipeException.

Parameters

tileID The tile ID to remove.

Returns: Whether the operation was successful or not.

Definition at line 152 of file RecipeEditor.cs.

                                           {
            if (tileID < 0 || tileID >= TileLoader.TileCount) {
                throw new RecipeException("No tile has ID " + tileID);
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (recipe.requiredTile[k] == tileID) {
                    for (int j = k; j < Recipe.maxRequirements - 1; j++) {
                        recipe.requiredTile[j] = recipe.requiredTile[j + 1];
                    }
                    recipe.requiredTile[Recipe.maxRequirements - 1] = -1;
                    return true;
                }
            }
            return false;
        }

References Terraria.ModLoader.RecipeEditor.recipe, and Terraria.ModLoader.TileLoader.TileCount.

◆ RejectRecipeGroup()

bool Terraria.ModLoader.RecipeEditor.RejectRecipeGroup ( string groupName )

Removes the recipe group with the given name from the recipe. This is the opposite of AcceptRecipeGroup; while it won't remove ingredients, it will make existing ingredients no longer be interchangeable with other items. Returns true if the operation was successful. Returns false if the recipe did not contain the recipe group in the first place. Can also throw a RecipeException.

Parameters

groupName The recipegroup name to reject.

Returns: Whether removing the recipegroup was successful.

Definition at line 105 of file RecipeEditor.cs.

                                                        {
            int groupID;
            if (!RecipeGroup.recipeGroupIDs.TryGetValue(groupName, out groupID)) {
                throw new RecipeException("No recipe group is named " + groupName);
            }
            return recipe.acceptedGroups.Remove(groupID);
        }

References Terraria.ModLoader.RecipeEditor.recipe.

◆ SetIngredientStack()

bool Terraria.ModLoader.RecipeEditor.SetIngredientStack	(	int	itemID,
		int	stack
	)

Sets the stack requirement of the ingredient with the given item ID in the recipe. Returns true if the operation was successful. Returns false if the recipe does not contain the ingredient. Can also throw a RecipeException.

Parameters

itemID	The item ID of the ingredient to set the stack on.
stack	The new stack amount.

Returns: Whether the operation was successful.

Definition at line 49 of file RecipeEditor.cs.

                                                              {
            if (itemID <= 0 || itemID >= ItemLoader.ItemCount) {
                throw new RecipeException("No item has ID " + itemID);
            }
            for (int k = 0; k < Recipe.maxRequirements; k++) {
                if (recipe.requiredItem[k].type == itemID) {
                    recipe.requiredItem[k].stack = stack;
                    return true;
                }
            }
            return false;
        }

References Terraria.ModLoader.ItemLoader.ItemCount, and Terraria.ModLoader.RecipeEditor.recipe.

◆ SetNeedHoney()

void Terraria.ModLoader.RecipeEditor.SetNeedHoney ( bool needHoney )

A convenience method for setting recipe.needHoney.

Parameters

needHoney Whether the recipe needs honey.

Definition at line 188 of file RecipeEditor.cs.

                                                 {
            recipe.needHoney = needHoney;
        }

◆ SetNeedLava()

void Terraria.ModLoader.RecipeEditor.SetNeedLava ( bool needLava )

A convenience method for setting recipe.needLava.

Parameters

needLava Whether the recipe needs lava.

Definition at line 180 of file RecipeEditor.cs.

                                               {
            recipe.needLava = needLava;
        }

◆ SetNeedWater()

void Terraria.ModLoader.RecipeEditor.SetNeedWater ( bool needWater )

A convenience method for setting recipe.needWater.

Parameters

needWater Whether the recipe needs water.

Definition at line 172 of file RecipeEditor.cs.

                                                 {
            recipe.needWater = needWater;
        }

◆ SetResult()

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

A convenience method for setting the result of the recipe. Similar to calling recipe.createItem.SetDefaults(itemID), followed by recipe.createItem.stack = stack. Can also throw a RecipeException.

Parameters

itemID	The ID of the item to set as result.
stack	The stack of the item to set as result.

Definition at line 118 of file RecipeEditor.cs.

                                                         {
            if (itemID <= 0 || itemID >= ItemLoader.ItemCount) {
                throw new RecipeException("No item has ID " + itemID);
            }
            recipe.createItem.SetDefaults(itemID);
            recipe.createItem.stack = stack;
        }

References Terraria.ModLoader.ItemLoader.ItemCount, and Terraria.ModLoader.RecipeEditor.recipe.

Member Data Documentation

◆ recipe

Recipe Terraria.ModLoader.RecipeEditor.recipe

private

Definition at line 10 of file RecipeEditor.cs.

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RecipeEditor()

Member Function Documentation

◆ AcceptRecipeGroup()

◆ AddIngredient()

◆ AddTile()

◆ DeleteIngredient()

◆ DeleteRecipe()

◆ DeleteTile()

◆ RejectRecipeGroup()

◆ SetIngredientStack()

◆ SetNeedHoney()

◆ SetNeedLava()

◆ SetNeedWater()

◆ SetResult()

Member Data Documentation

◆ recipe