This class serves as a place for you to define your own logic for drawing the player's life and mana resources.
For modifying parts of the vanilla display sets, use ModResourceOverlay. More...

Inherits ModType< TEntity, TModType >, IPlayerResourcesDisplaySet, IConfigKeyHolder, and ILocalizedModType.

Public Member Functions
void	Draw ()

virtual void	DrawLife (SpriteBatch spriteBatch)
	Draw the life resources for your display set here More...

virtual void	DrawMana (SpriteBatch spriteBatch)
	Draw the mana resources for your display set here More...

virtual void	PreDrawResources (PlayerStatsSnapshot snapshot)
	Allows you to initialize fields, textures, etc. before drawing occurs More...

virtual bool	PreHover (out bool hoveringLife)
	Allows you to specify if the vanilla life/mana hover text should display More...

sealed override void	SetupContent ()
	If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...

void	TryToHover ()

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

void	Draw ()

void	TryToHover ()

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

Properties
string	ConfigKey `[get]`
	The name used to get this resource display set. Returns ModType.FullName More...

string	DisplayedName `[get]`
	Gets the name for this resource display set based on its DisplayName and the current culture More...

virtual LocalizedText	DisplayName `[get]`
	The translations for the display name of this item.

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 ModType classes can utilize this. More...

string	NameKey `[get]`
	Included only for completion's sake. Returns DisplayName.Key More...

static PlayerStatsSnapshot	PlayerStats `[get]`
	The current snapshot of the life and mana stats for Main.LocalPlayer

bool	Selected `[get]`

int	Type `[get, set]`

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

Properties inherited from IPlayerResourcesDisplaySet
string	DisplayedName `[get]`

Properties inherited from IConfigKeyHolder
string	ConfigKey `[get]`

string	NameKey `[get]`

Properties inherited from ILocalizedModType
abstract 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 ModType classes can utilize this. More...

Detailed Description

This class serves as a place for you to define your own logic for drawing the player's life and mana resources.
For modifying parts of the vanilla display sets, use ModResourceOverlay.

Member Function Documentation

◆ Draw()

void ModResourceDisplaySet.Draw ( )

Implements IPlayerResourcesDisplaySet.

◆ DrawLife()

virtual void ModResourceDisplaySet.DrawLife ( SpriteBatch spriteBatch )

virtual

Draw the life resources for your display set here

Parameters

spriteBatch

◆ DrawMana()

virtual void ModResourceDisplaySet.DrawMana ( SpriteBatch spriteBatch )

virtual

Draw the mana resources for your display set here

Parameters

spriteBatch

◆ PreDrawResources()

virtual void ModResourceDisplaySet.PreDrawResources ( PlayerStatsSnapshot snapshot )

virtual

Allows you to initialize fields, textures, etc. before drawing occurs

Parameters

snapshot A copy of PlayerStats

◆ PreHover()

virtual bool ModResourceDisplaySet.PreHover ( out bool hoveringLife )

virtual

Allows you to specify if the vanilla life/mana hover text should display

Parameters

hoveringLife Whether the hover text should be for life (true) or mana (false)

◆ Register()

sealed override void ModResourceDisplaySet.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements ModType< TEntity >.

◆ SetupContent()

sealed override void ModResourceDisplaySet.SetupContent ( )

virtual

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

Reimplemented from ModType< TEntity >.

◆ TryToHover()

void ModResourceDisplaySet.TryToHover ( )

Implements IPlayerResourcesDisplaySet.

Property Documentation

◆ ConfigKey

string ModResourceDisplaySet.ConfigKey

get

The name used to get this resource display set. Returns ModType.FullName

Implements IConfigKeyHolder.

◆ DisplayedName

string ModResourceDisplaySet.DisplayedName

get

Gets the name for this resource display set based on its DisplayName and the current culture

Implements IPlayerResourcesDisplaySet.

◆ LocalizationCategory

virtual string ModResourceDisplaySet.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 ModType classes can utilize this.

Implements ILocalizedModType.

◆ NameKey

string ModResourceDisplaySet.NameKey

get

Included only for completion's sake. Returns DisplayName.Key

Implements IConfigKeyHolder.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Draw()

◆ DrawLife()

◆ DrawMana()

◆ PreDrawResources()

◆ PreHover()

◆ Register()

◆ SetupContent()

◆ TryToHover()

Property Documentation

◆ ConfigKey

◆ DisplayedName

◆ LocalizationCategory

◆ NameKey