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

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

bool CanBeCleared = true [get, set]
 Whether or not it is always safe to call Player.DelBuff on this buff. Setting this to false will prevent the nurse from being able to remove this debuff. Defaults to true. More...
 
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...
 
bool LongerExpertDebuff [get, set]
 If this buff is a debuff, setting this to true will make this buff last twice as long on players in expert mode. Defaults to false. 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.

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

◆ 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

◆ CanBeCleared

bool Terraria.ModLoader.ModBuff.CanBeCleared = true
getset

Whether or not it is always safe to call Player.DelBuff on this buff. Setting this to false will prevent the nurse from being able to remove this debuff. Defaults to true.

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

◆ LongerExpertDebuff

bool Terraria.ModLoader.ModBuff.LongerExpertDebuff
getset

If this buff is a debuff, setting this to true will make this buff last twice as long on players in expert mode. Defaults to false.

◆ Type

int Terraria.ModLoader.ModBuff.Type
getset

The buff id of this buff.