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...

Inheritance diagram for Terraria.ModLoader.GlobalInfoDisplay:

Collaboration diagram for Terraria.ModLoader.GlobalInfoDisplay:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.

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.

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).

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.

virtual void	ModifyDisplayColor (InfoDisplay currentDisplay, ref Color displayColor, ref Color displayShadowColor)
	Allows you to modify the display color (the color of the text displayed next to the icon) of an InfoDisplay.

virtual void	ModifyDisplayParameters (InfoDisplay currentDisplay, ref string displayValue, ref string displayName, ref Color displayColor, ref Color displayShadowColor)
	Allows modifying the display value (the text displayed next to the icon), the display name (texxt shown when hovering over the InfoDisplay in-game), and the display colors of an InfoDisplay.

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	Register ()

virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.

TEntity	CreateTemplateEntity ()

Properties
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
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

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).

Definition at line 10 of file GlobalInfoDisplay.cs.

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

source/Terraria.ModLoader/GlobalInfoDisplay.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description