tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.InfoDisplay Class Referenceabstract

Inherits Terraria.ModLoader.ModTexturedType.

Inherited by Terraria.ModLoader.VanillaInfoDisplay.

Public Member Functions

virtual bool Active ()
 This dictates whether or not this info display should be active. More...
 
abstract string DisplayValue ()
 This is the value that will show up when viewing this display in normal play, right next to the icon. 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...
 

Properties

static InfoDisplay Compass = new CompassInfoDisplay() [get]
 
static InfoDisplay DepthMeter = new DepthMeterInfoDisplay() [get]
 
string DisplayName [get]
 This is the name that will show up when hovering over this info display. More...
 
virtual string DisplayNameInternal [get]
 
static InfoDisplay DPSMeter = new DPSMeterInfoDisplay() [get]
 
static InfoDisplay FishFinder = new FishFinderInfoDisplay() [get]
 
ModTranslation InfoName [get, set]
 This is the translation that is used behind DisplayName. The translation will show up when hovering over this info display. More...
 
static InfoDisplay LifeformAnalyzer = new LifeformAnalyzerInfoDisplay() [get]
 
static InfoDisplay MetalDetector = new MetalDetectorInfoDisplay() [get]
 
static InfoDisplay Radar = new RadarInfoDisplay() [get]
 
static InfoDisplay Sextant = new SextantInfoDisplay() [get]
 
static InfoDisplay Stopwatch = new StopwatchInfoDisplay() [get]
 
static InfoDisplay TallyCounter = new TallyCounterInfoDisplay() [get]
 
int Type [get, set]
 This is the internal ID of this InfoDisplay. More...
 
static InfoDisplay Watches = new WatchesInfoDisplay() [get]
 
static InfoDisplay WeatherRadio = new WeatherRadioInfoDisplay() [get]
 
- 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...
 

Member Function Documentation

◆ Active()

◆ DisplayValue()

abstract string Terraria.ModLoader.InfoDisplay.DisplayValue ( )
pure virtual

This is the value that will show up when viewing this display in normal play, right next to the icon.

Implemented in Terraria.ModLoader.VanillaInfoDisplay.

◆ Register()

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

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

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

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

Reimplemented from Terraria.ModLoader.ModType.

Property Documentation

◆ DisplayName

string Terraria.ModLoader.InfoDisplay.DisplayName
get

This is the name that will show up when hovering over this info display.

◆ InfoName

ModTranslation Terraria.ModLoader.InfoDisplay.InfoName
getset

This is the translation that is used behind DisplayName. The translation will show up when hovering over this info display.

◆ Type

int Terraria.ModLoader.InfoDisplay.Type
getset

This is the internal ID of this InfoDisplay.