Terraria.ModLoader.InfoDisplay Class Reference

Represents an informational display toggle typically provided by informational accessories. More...

Inheritance diagram for Terraria.ModLoader.InfoDisplay:

Collaboration diagram for Terraria.ModLoader.InfoDisplay:

Public Member Functions
virtual bool	Active ()
	This dictates whether or not this info display should be active.
virtual string	DisplayValue (ref Color displayColor)
virtual string	DisplayValue (ref Color displayColor, ref Color displayShadowColor)
	This is the value that will show up when viewing this display in normal play, right next to the icon. Set displayColor to P:Terraria.ModLoader.InfoDisplay.InactiveInfoTextColor if your display value is "zero"/shows no valuable information.
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
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.
virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.
virtual void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.
virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.
string	PrettyPrintName ()
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.
virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.
override void	Register ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
TEntity	CreateTemplateEntity ()

Properties
static InfoDisplay	Watches = new WatchesInfoDisplay() [get, private set]
static InfoDisplay	WeatherRadio = new WeatherRadioInfoDisplay() [get, private set]
static InfoDisplay	Sextant = new SextantInfoDisplay() [get, private set]
static InfoDisplay	FishFinder = new FishFinderInfoDisplay() [get, private set]
static InfoDisplay	MetalDetector = new MetalDetectorInfoDisplay() [get, private set]
static InfoDisplay	LifeformAnalyzer = new LifeformAnalyzerInfoDisplay() [get, private set]
static InfoDisplay	Radar = new RadarInfoDisplay() [get, private set]
static InfoDisplay	TallyCounter = new TallyCounterInfoDisplay() [get, private set]
static InfoDisplay	Dummy = new DummyInfoDisplay() [get, private set]
static InfoDisplay	DPSMeter = new DPSMeterInfoDisplay() [get, private set]
static InfoDisplay	Stopwatch = new StopwatchInfoDisplay() [get, private set]
static InfoDisplay	Compass = new CompassInfoDisplay() [get, private set]
static InfoDisplay	DepthMeter = new DepthMeterInfoDisplay() [get, private set]
static Color	InactiveInfoTextColor [get]
	The color when no valuable information is displayed.
static Color	GoldInfoTextColor [get]
	The golden color variant of the displays text. Used by the Lifeform Analyzer.
static Color	GoldInfoTextShadowColor [get]
	The golden color variant of the displays text shadow. Used by the Lifeform Analyzer.
static string	VanillaHoverTexture [get]
	The path to the texture vanilla info displays use when hovering over an info display.
int	Type [get, set]
	This is the internal ID of this InfoDisplay.
virtual string	LocalizationCategory [get]
	The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom T:Terraria.ModLoader.ModType classes can utilize this.
virtual string	HoverTexture [get]
	The outline texture drawn when the icon is hovered and toggleable. By default a circular outline texture is used. Override this method and return Texture + "_Hover" or any other texture path to specify a custom outline texture for use with icons that are not circular.
virtual LocalizedText	DisplayName [get]
	This is the name that will show up when hovering over this info display.
virtual string	Texture [get]
	The file name of this type's texture file in the mod loader's file space.
Mod	Mod [get, set]
	The mod this belongs to.
virtual string	Name [get]
	The internal name of this.
string	FullName [get]
	The internal name of this, including the mod it is from.
TEntity	Entity [get, set]
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].
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
string	DisplayValue_Obsolete (ref Color displayColor)
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Static Private Attributes
static readonly MethodInfo	displayValueMethodOld = typeof(InfoDisplay).GetMethod("DisplayValue", new Type[1] { typeof(Color).MakeByRefType() })
static readonly MethodInfo	displayValueMethodNew

Detailed Description

Represents an informational display toggle typically provided by informational accessories

.

The M:Terraria.ModLoader.InfoDisplay.Active property determines if the InfoDisplay could be shown to the user. The game tracks the players desired visibility of active InfoDisplay through the F:Terraria.Player.hideInfo array.

Definition at line 14 of file InfoDisplay.cs.

---

The documentation for this class was generated from the following file:

• source/Terraria.ModLoader/InfoDisplay.cs