tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.GlobalRecipe Class Reference

This class provides hooks that control all recipes in the game. More...

Inherits Terraria.ModLoader.ModType.

Public Member Functions

virtual void ConsumeItem (Recipe recipe, int type, ref int amount)
 Allows to edit the amount of item the player uses in a recipe. More...
 
virtual void OnCraft (Item item, Recipe recipe)
 Allows you to make anything happen when the player uses the given recipe. The item parameter is the item the player has just crafted. More...
 
virtual bool RecipeAvailable (Recipe recipe)
 Whether or not the conditions are met for the given 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...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
- Public Member Functions inherited from Terraria.ModLoader.ModType
virtual bool IsLoadingEnabled (Mod mod)
 Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config. More...
 
virtual void Load ()
 Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated. More...
 
virtual void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

sealed override void Register ()
 If you make a new ModType, seal this override. More...
 

Additional Inherited Members

- Properties inherited from Terraria.ModLoader.ModType
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
Mod Mod [get, set]
 The mod this belongs to. More...
 
virtual string Name [get]
 The internal name of this. More...
 
- Properties inherited from Terraria.ModLoader.IModType
string FullName [get]
 => $"{Mod.Name}/{Name}" More...
 
Mod Mod [get]
 The mod this belongs to. More...
 
string Name [get]
 The internal name of this instance. More...
 

Detailed Description

This class provides hooks that control all recipes in the game.

Member Function Documentation

◆ ConsumeItem()

virtual void Terraria.ModLoader.GlobalRecipe.ConsumeItem ( Recipe  recipe,
int  type,
ref int  amount 
)
virtual

Allows to edit the amount of item the player uses in a recipe.

Parameters
recipeThe recipe used for the craft.
typeType of the ingredient.
amountModifiable amount of the item consumed.

◆ OnCraft()

virtual void Terraria.ModLoader.GlobalRecipe.OnCraft ( Item  item,
Recipe  recipe 
)
virtual

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

Parameters
itemThe item created.
recipeThe recipe used to create the item.

◆ RecipeAvailable()

virtual bool Terraria.ModLoader.GlobalRecipe.RecipeAvailable ( Recipe  recipe)
virtual

Whether or not the conditions are met for the given 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).

◆ Register()

sealed override void Terraria.ModLoader.GlobalRecipe.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.GlobalRecipe.SetupContent ( )
virtual

If you make a new ModType, seal this override, and call SetStaticDefaults in it.

Reimplemented from Terraria.ModLoader.ModType.