Terraria.ModLoader.GlobalBuff Class Reference

This class allows you to modify the behavior of any buff in the game. More...

Inheritance diagram for Terraria.ModLoader.GlobalBuff:

Collaboration diagram for Terraria.ModLoader.GlobalBuff:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
virtual void	Update (int type, Player player, ref int buffIndex)
	Allows you to make the buff with the given ID give certain effects to a player. If you remove the buff from the player, make sure the decrement the buffIndex parameter by 1.
virtual void	Update (int type, NPC npc, ref int buffIndex)
	Allows you to make the buff with the given ID give certain effects to an NPC. If you remove the buff from the NPC, make sure to decrement the buffIndex parameter by 1.
virtual bool	ReApply (int type, Player player, int time, int buffIndex)
	Allows to you make special things happen when adding the given type of buff to a player when the player already has that 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. (For Mana Sickness, the vanilla re-apply code adds the "time" argument to the current buff time.)
virtual bool	ReApply (int type, NPC npc, int time, int buffIndex)
	Allows to you make special things happen when adding the given buff type to an NPC when the NPC already has that 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 (int type, 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 void	CustomBuffTipSize (string buffTip, List< Vector2 > sizes)
	If you are using the DrawCustomBuffTip hook, then you must use this hook as well. Calculate the location (relative to the origin) of the bottom-right corner of everything you will draw, and add that location to the sizes parameter.
virtual void	DrawCustomBuffTip (string buffTip, SpriteBatch spriteBatch, int originX, int originY)
	Allows you to draw whatever you want when a buff tooltip is drawn. The originX and originY parameters are the top-left corner of everything that's drawn; you should add these to the position argument passed to SpriteBatch.Draw.
virtual bool	PreDraw (SpriteBatch spriteBatch, int type, 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 type, 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 type, 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	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.
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
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 allows you to modify the behavior of any buff in the game.

Definition at line 11 of file GlobalBuff.cs.

---

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

• source/Terraria.ModLoader/GlobalBuff.cs