This class serves as a place for you to customize how the vanilla resource displays (Classic, Fancy and Bars) are drawn.
For implementing your own resource displays, use T:Terraria.ModLoader.ModResourceDisplaySet. More...

Inheritance diagram for Terraria.ModLoader.ModResourceOverlay:

Collaboration diagram for Terraria.ModLoader.ModResourceOverlay:

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	PreDrawResource (ResourceOverlayDrawContext context)
	Allows you to draw below any resource (hearts, stars, bars or panels) in a display set.

virtual void	PostDrawResource (ResourceOverlayDrawContext context)
	Allows you to draw on top of any resource (hearts, stars, bars or panels) in a display set.

virtual bool	PreDrawResourceDisplay (PlayerStatsSnapshot snapshot, IPlayerResourcesDisplaySet displaySet, bool drawingLife, ref Color textColor, out bool drawText)
	Allows you to draw before the resources (hearts, stars, bars and/or panels) in a display set are drawn. If you want to implement your own display set, it is recommended to use T:Terraria.ModLoader.ModResourceDisplaySet instead of this hook.

virtual void	PostDrawResourceDisplay (PlayerStatsSnapshot snapshot, IPlayerResourcesDisplaySet displaySet, bool drawingLife, Color textColor, bool drawText)
	Allows you to draw after the resources (hearts, stars, bars and/or panels) in a display set are drawn.

virtual bool	DisplayHoverText (PlayerStatsSnapshot snapshot, IPlayerResourcesDisplaySet displaySet, bool drawingLife)
	Allows you to specify if the hover text for a resource (life or mana) should be displayed.

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
int	Type `[get, set]`

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

This class serves as a place for you to customize how the vanilla resource displays (Classic, Fancy and Bars) are drawn.
For implementing your own resource displays, use T:Terraria.ModLoader.ModResourceDisplaySet.

Definition at line 11 of file ModResourceOverlay.cs.

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

source/Terraria.ModLoader/ModResourceOverlay.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description