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

Inherits Terraria.ModLoader.ModTexturedType.

Public Member Functions
virtual void	ModifyBuffTip (ref string tip, ref int rare)
	Allows you to modify the tooltip that displays when the mouse hovers over the buff icon, as well as the color the buff's name is drawn in. More...

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). More...

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. More...

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. More...

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. More...

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. More...

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; More...

sealed override void	SetupContent ()
	If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...

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. More...

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. 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	Unload ()
	Allows you to safely unload things you added in Load. More...

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

Properties
ModTranslation	Description `[get, set]`
	The translations of this buff's description. More...

ModTranslation	DisplayName `[get, set]`
	The translations of this buff's display name. More...

int	Type `[get, set]`
	The buff id of this buff. More...

Properties inherited from Terraria.ModLoader.ModTexturedType
virtual string	Texture `[get]`
	The file name of this type's texture file in the mod loader's file space. More...

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 serves as a place for you to define a new buff and how that buff behaves.

Member Function Documentation

◆ ModifyBuffTip()

virtual void Terraria.ModLoader.ModBuff.ModifyBuffTip	(	ref string	tip,
		ref int	rare
	)

virtual

Allows you to modify the tooltip that displays when the mouse hovers over the buff icon, as well as the color the buff's name is drawn in.

◆ PostDraw()

virtual void Terraria.ModLoader.ModBuff.PostDraw	(	SpriteBatch	spriteBatch,
		int	buffIndex,
		BuffDrawParams	drawParams
	)

virtual

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).

Parameters

spriteBatch	The spriteBatch that is drawn on
buffIndex	The index in Main.LocalPlayer.buffType and .buffTime of the buff
drawParams	The draw parameters for the buff

◆ PreDraw()

virtual bool Terraria.ModLoader.ModBuff.PreDraw	(	SpriteBatch	spriteBatch,
		int	buffIndex,
		ref BuffDrawParams	drawParams
	)

virtual

Allows you to draw things before the default draw code is ran. Return false to prevent drawing the buff. Returns true by default.

Parameters

spriteBatch	The spriteBatch that is drawn on
buffIndex	The index in Main.LocalPlayer.buffType and .buffTime of the buff
drawParams	The draw parameters for the buff

Returns: true for allowing drawing, false for preventing drawing

◆ ReApply() [1/2]

virtual bool Terraria.ModLoader.ModBuff.ReApply	(	NPC	npc,
		int	time,
		int	buffIndex
	)

virtual

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.

◆ ReApply() [2/2]

virtual bool Terraria.ModLoader.ModBuff.ReApply	(	Player	player,
		int	time,
		int	buffIndex
	)

virtual

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.

◆ Register()

override sealed void Terraria.ModLoader.ModBuff.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ RightClick()

virtual bool Terraria.ModLoader.ModBuff.RightClick ( int buffIndex )

virtual

Allows you to make things happen when the buff icon is right-clicked. Return false to prevent the buff from being cancelled.

Parameters

buffIndex The index in Main.LocalPlayer.buffType and .buffTime of the buff

Returns: true for allowing the buff to be cancelled, false to prevent the buff from being cancelled

◆ SetStaticDefaults()

override void Terraria.ModLoader.ModBuff.SetStaticDefaults ( )

virtual

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;

Reimplemented from Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.ModBuff.SetupContent ( )

virtual

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

Reimplemented from Terraria.ModLoader.ModType.

◆ Update() [1/2]

virtual void Terraria.ModLoader.ModBuff.Update	(	NPC	npc,
		ref int	buffIndex
	)

virtual

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.

◆ Update() [2/2]

virtual void Terraria.ModLoader.ModBuff.Update	(	Player	player,
		ref int	buffIndex
	)

virtual

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.

Property Documentation

◆ Description

ModTranslation Terraria.ModLoader.ModBuff.Description

getset

The translations of this buff's description.

◆ DisplayName

ModTranslation Terraria.ModLoader.ModBuff.DisplayName

getset

The translations of this buff's display name.

◆ Type

int Terraria.ModLoader.ModBuff.Type

getset

The buff id of this buff.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ModifyBuffTip()

◆ PostDraw()

◆ PreDraw()

◆ ReApply() [1/2]

◆ ReApply() [2/2]

◆ Register()

◆ RightClick()

◆ SetStaticDefaults()

◆ SetupContent()

◆ Update() [1/2]

◆ Update() [2/2]

Property Documentation

◆ Description

◆ DisplayName

◆ Type