Terraria.ModLoader.ModBuff Class Reference

This class serves as a place for you to define a new buff and how that buff behaves. More...

Inheritance diagram for Terraria.ModLoader.ModBuff:

Collaboration diagram for Terraria.ModLoader.ModBuff:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
override void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed. This is where all buff related assignments go. For example: Main.debuff[Type] = true; Main.buffNoTimeDisplay[Type] = true; Main.pvpBuff[Type] = true; Main.vanityPet[Type] = true; Main.lightPet[Type] = true;
virtual void	Update (Player player, ref int buffIndex)
	Allows you to make this buff give certain effects to the given player. If you remove the buff from the player, make sure the decrement the buffIndex parameter by 1.
virtual void	Update (NPC npc, ref int buffIndex)
	Allows you to make this buff give certain effects to the given NPC. If you remove the buff from the NPC, make sure to decrement the buffIndex parameter by 1.
virtual bool	ReApply (Player player, int time, int buffIndex)
	Allows to you make special things happen when adding this buff to a player when the player already has this buff. Return true to block the vanilla re-apply code from being called; returns false by default. The vanilla re-apply code sets the buff time to the "time" argument if that argument is larger than the current buff time.
virtual bool	ReApply (NPC npc, int time, int buffIndex)
	Allows to you make special things happen when adding this buff to an NPC when the NPC already has this buff. Return true to block the vanilla re-apply code from being called; returns false by default. The vanilla re-apply code sets the buff time to the "time" argument if that argument is larger than the current buff time.
virtual void	ModifyBuffText (ref string buffName, ref string tip, ref int rare)
	Allows you to modify the name and tooltip that displays when the mouse hovers over the buff icon, as well as the color the buff's name is drawn in.
virtual bool	PreDraw (SpriteBatch spriteBatch, int buffIndex, ref BuffDrawParams drawParams)
	Allows you to draw things before the default draw code is ran. Return false to prevent drawing the buff. Returns true by default.
virtual void	PostDraw (SpriteBatch spriteBatch, int buffIndex, BuffDrawParams drawParams)
	Allows you to draw things after the buff has been drawn. skipped is true if you or another mod has skipped drawing the buff (possibly hiding it or in favor of new visuals).
virtual bool	RightClick (int buffIndex)
	Allows you to make things happen when the buff icon is right-clicked. Return false to prevent the buff from being cancelled.
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.
virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.
virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.
string	PrettyPrintName ()
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.
virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.
TEntity	CreateTemplateEntity ()

Properties
int	Type [get, set]
	The buff id of this buff.
virtual string	LocalizationCategory [get]
	The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom T:Terraria.ModLoader.ModType classes can utilize this.
virtual LocalizedText	DisplayName [get]
	The translations of this buff's display name.
virtual LocalizedText	Description [get]
	The translations of this buff's description.
virtual string	Texture [get]
	The file name of this type's texture file in the mod loader's file space.
Mod	Mod [get, set]
	The mod this belongs to.
virtual string	Name [get]
	The internal name of this.
string	FullName [get]
	The internal name of this, including the mod it is from.
TEntity	Entity [get, set]
virtual bool	IsCloneable [get]
	Whether or not this type is cloneable. Cloning is supported if all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference].
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

This class serves as a place for you to define a new buff and how that buff behaves.

Definition at line 12 of file ModBuff.cs.

---

The documentation for this class was generated from the following file:

• source/Terraria.ModLoader/ModBuff.cs