![]() |
tModLoader
0.12 Alpha
A mod to make and play Terraria mods
|
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:
| |
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... | |
![]() | |
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... | |
![]() | |
virtual string | Texture [get] |
The file name of this type's texture file in the mod loader's file space. More... | |
![]() | |
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... | |
![]() | |
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... | |
This class serves as a place for you to define a new buff and how that buff behaves.
|
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.
|
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).
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 |
|
virtual |
Allows you to draw things before the default draw code is ran. Return false to prevent drawing the buff. Returns true by default.
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 |
true
for allowing drawing, false
for preventing drawing
|
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.
|
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.
|
protectedvirtual |
If you make a new ModType, seal this override.
Implements Terraria.ModLoader.ModType.
|
virtual |
Allows you to make things happen when the buff icon is right-clicked. Return false to prevent the buff from being cancelled.
buffIndex | The index in Main.LocalPlayer.buffType and .buffTime of the buff |
true
for allowing the buff to be cancelled, false
to prevent the buff from being cancelled
|
virtual |
Allows you to modify the properties after initial loading has completed.
This is where all buff related assignments go.
For example:
Reimplemented from Terraria.ModLoader.ModType.
|
virtual |
If you make a new ModType, seal this override, and call SetStaticDefaults in it.
Reimplemented from Terraria.ModLoader.ModType.
|
virtual |
|
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.
|
getset |
The translations of this buff's description.
|
getset |
The translations of this buff's display name.
|
getset |
The buff id of this buff.