A class that is used to swap out the entire boss bar display system with your own implementation. More...

Inheritance diagram for Terraria.ModLoader.ModBossBarStyle:

Collaboration diagram for Terraria.ModLoader.ModBossBarStyle:

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 void	Update (IBigProgressBar currentBar, ref BigProgressBarInfo info)
	Runs after update code for boss bars (skipped if PreventUpdate returns true), can be used to identify which NPCs to draw.

virtual void	OnSelected ()
	Called when this ModBossBarStyle is selected.

virtual void	OnDeselected ()
	Called when this ModBossBarStyle is deselected.

virtual void	Draw (SpriteBatch spriteBatch, IBigProgressBar currentBar, BigProgressBarInfo info)
	Runs after draw code for boss bars (skipped if PreventDraw returns true), can be used to draw your own bars, or reinvoke draw for currently selected-to-draw bar.

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
bool	IsSelected `[get]`
	Checks if the selected style matches this ModBossBarStyle.

virtual string	DisplayName `[get]`
	Controls the name that shows up in the menu selection. If not overridden, it will use this mod's display name.

virtual bool	PreventUpdate `[get]`
	Return true to skip update code for boss bars. Useful if you want to use your own code for finding out which NPCs to track. Returns false by default.

virtual bool	PreventDraw `[get]`
	Return true to skip draw code for boss bars. Useful if you want to use your own code for drawing boss bars. Returns false by default.

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 swap out the entire boss bar display system with your own implementation.

Definition at line 9 of file ModBossBarStyle.cs.

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

source/Terraria.ModLoader/ModBossBarStyle.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description