tModLoader v2022.09
A mod to make and play Terraria mods
Terraria.ModLoader.VanillaInfoDisplay Class Reference

Inherits Terraria.ModLoader.InfoDisplay.

Inherited by Terraria.ModLoader.CompassInfoDisplay, Terraria.ModLoader.DPSMeterInfoDisplay, Terraria.ModLoader.DepthMeterInfoDisplay, Terraria.ModLoader.DummyInfoDisplay, Terraria.ModLoader.FishFinderInfoDisplay, Terraria.ModLoader.LifeformAnalyzerInfoDisplay, Terraria.ModLoader.MetalDetectorInfoDisplay, Terraria.ModLoader.RadarInfoDisplay, Terraria.ModLoader.SextantInfoDisplay, Terraria.ModLoader.StopwatchInfoDisplay, Terraria.ModLoader.TallyCounterInfoDisplay, Terraria.ModLoader.WatchesInfoDisplay, and Terraria.ModLoader.WeatherRadioInfoDisplay.

Public Member Functions

override string DisplayValue ()
 This is the value that will show up when viewing this display in normal play, right next to the icon. More...
 
- Public Member Functions inherited from Terraria.ModLoader.InfoDisplay
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...
 
virtual TModType Clone (TEntity newEntity)
 Create a copy of this instanced global. Called when an entity is cloned. 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 TModType NewInstance (TEntity entity)
 Create a new instance of this ModType for a specific entity More...
 
virtual void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 
virtual bool IsLoadingEnabled (Mod mod)
 Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More...
 
abstract void Load (Mod mod)
 Called when loading the type. More...
 
abstract void Unload ()
 Called during unloading when needed. More...
 
virtual TModType Clone (TEntity newEntity)
 Create a copy of this instanced global. Called when an entity is cloned. 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 TModType NewInstance (TEntity entity)
 Create a new instance of this ModType for a specific entity More...
 
virtual void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Properties

override string DisplayNameInternal [get]
 
abstract string LangKey [get]
 
- Properties inherited from Terraria.ModLoader.InfoDisplay
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.
 
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.
 
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.
 
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.
 
- Properties inherited from Terraria.ModLoader.ModType< TEntity, TModType >
virtual bool CloneNewInstances [get]
 Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
 
TEntity Entity [get, set]
 
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
virtual bool IsCloneable [get]
 Whether or not this type is cloneable. Cloning is supported if
all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference]
 
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...
 
- Properties inherited from Terraria.ModLoader.ModType< TEntity >
virtual bool CloneNewInstances [get]
 Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
 
TEntity Entity [get, set]
 
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
virtual bool IsCloneable [get]
 Whether or not this type is cloneable. Cloning is supported if
all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference]
 
Mod Mod [get, set]
 The mod this belongs to. More...
 
virtual string Name [get]
 The internal name of this. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Terraria.ModLoader.InfoDisplay
sealed override void Register ()
 If you make a new ModType, seal this override. More...
 
- Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity, TModType >
abstract TEntity CreateTemplateEntity ()
 
virtual void InitTemplateInstance ()
 Create dummy objects for instanced mod-types More...
 
override void InitTemplateInstance ()
 Create dummy objects for instanced mod-types More...
 
abstract void Register ()
 If you make a new ModType, seal this override. More...
 
virtual void ValidateType ()
 Check for the correct overrides of different hook methods and fields and properties More...
 
- Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity >
abstract TEntity CreateTemplateEntity ()
 
virtual void InitTemplateInstance ()
 Create dummy objects for instanced mod-types More...
 
override void InitTemplateInstance ()
 Create dummy objects for instanced mod-types
 
abstract void Register ()
 If you make a new ModType, seal this override. More...
 
virtual void ValidateType ()
 Check for the correct overrides of different hook methods and fields and properties More...
 

Member Function Documentation

◆ DisplayValue()

override string Terraria.ModLoader.VanillaInfoDisplay.DisplayValue ( )
virtual

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

Implements Terraria.ModLoader.InfoDisplay.