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 ModType< TEntity, TModType >.

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	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. 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	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 (text shown when hovering over the InfoDisplay in-game), and the display colors of an InfoDisplay. 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 ModType< TEntity, TModType >
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...

string	PrettyPrintName ()

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

Public Member Functions inherited from ModType< TEntity >
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...

string	PrettyPrintName ()

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

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

Protected Member Functions inherited from 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 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...

Additional Inherited Members
Properties inherited from 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 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 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...

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

currentDisplay The display you're deciding the active state for.

◆ ModifyDisplayColor()

virtual void GlobalInfoDisplay.ModifyDisplayColor	(	InfoDisplay	currentDisplay,
		ref Color	displayColor,
		ref Color	displayShadowColor
	)

virtual

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

Parameters

currentDisplay	The display you're modifying the display color for.
displayColor	The display color of the current display.
displayShadowColor	The text outline color of the current display.

◆ ModifyDisplayName()

virtual void 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

currentDisplay	The display you're modifying the display name for.
displayName	The display name of the current display.

◆ ModifyDisplayParameters()

virtual void GlobalInfoDisplay.ModifyDisplayParameters	(	InfoDisplay	currentDisplay,
		ref string	displayValue,
		ref string	displayName,
		ref Color	displayColor,
		ref Color	displayShadowColor
	)

virtual

Allows modifying the display value (the text displayed next to the icon), the display name (text shown when hovering over the InfoDisplay in-game), and the display colors of an InfoDisplay.

Parameters

currentDisplay	The display you're modifying the parameters for.
displayValue	The display value of the current display.
displayName	The display name of the current display.
displayColor	The display color of the current display.
displayShadowColor	The text outline color of the current display.

◆ ModifyDisplayValue()

virtual void 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

currentDisplay	The display you're modifying the display value for.
displayValue	The display value of the current display

◆ Register()

sealed override void GlobalInfoDisplay.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements ModType< TEntity >.

◆ SetupContent()

sealed override void GlobalInfoDisplay.SetupContent ( )

virtual

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

Reimplemented from ModType< TEntity >.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Active()

◆ ModifyDisplayColor()

◆ ModifyDisplayName()

◆ ModifyDisplayParameters()

◆ ModifyDisplayValue()

◆ Register()

◆ SetupContent()