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

A class that is used to modify existing info displays (i.e. the things that the Cell Phone uses to communicate information). All vanilla displays can be accessed using InfoDisplay.(name of item). More...

Inherits Terraria.ModLoader.ModType.

Public Member Functions

virtual ? bool Active (InfoDisplay currentDisplay)
 Allows you to modify whether or not a given InfoDisplay is active. Returns null (no change from default behavior) by default for all InfoDisplays. More...
 
virtual void ModifyDisplayName (InfoDisplay currentDisplay, ref string displayName)
 Allows you to modify the display name of an InfoDisplay (shown when hovering over said display in-game). More...
 
virtual void ModifyDisplayValue (InfoDisplay currentDisplay, ref string displayValue)
 Allows you to modify the display value (the text displayed next to the icon) of an InfoDisplay. More...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. 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 SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

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

Additional Inherited Members

- 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

A class that is used to modify existing info displays (i.e. the things that the Cell Phone uses to communicate information). All vanilla displays can be accessed using InfoDisplay.(name of item).

Member Function Documentation

◆ Active()

virtual ? bool Terraria.ModLoader.GlobalInfoDisplay.Active ( InfoDisplay  currentDisplay)
virtual

Allows you to modify whether or not a given InfoDisplay is active. Returns null (no change from default behavior) by default for all InfoDisplays.

Parameters
currentDisplayThe display you're deciding the active state for.

◆ ModifyDisplayName()

virtual void Terraria.ModLoader.GlobalInfoDisplay.ModifyDisplayName ( InfoDisplay  currentDisplay,
ref string  displayName 
)
virtual

Allows you to modify the display name of an InfoDisplay (shown when hovering over said display in-game).

Parameters
currentDisplayThe display you're modifying the display name for.
displayNameThe display name of the current display.

◆ ModifyDisplayValue()

virtual void Terraria.ModLoader.GlobalInfoDisplay.ModifyDisplayValue ( InfoDisplay  currentDisplay,
ref string  displayValue 
)
virtual

Allows you to modify the display value (the text displayed next to the icon) of an InfoDisplay.

Parameters
currentDisplayThe display you're modifying the display value for.
displayValueThe

◆ Register()

sealed override void Terraria.ModLoader.GlobalInfoDisplay.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.GlobalInfoDisplay.SetupContent ( )
virtual

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

Reimplemented from Terraria.ModLoader.ModType.