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

Inherited by Terraria.ModLoader.Default.DefaultBossBarStyle.

Public Member Functions
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 More...

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

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

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

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

Public Member Functions inherited from Terraria.ModLoader.ModType
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 void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed. 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...

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

bool	IsSelected `[get]`
	Checks if the selected style matches this ModBossBarStyle. More...

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

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

Properties inherited from Terraria.ModLoader.ModType
string	FullName `[get]`
	The internal name of this, including the mod it is from. More...

Mod	Mod `[get, set]`
	The mod this belongs to. More...

virtual string	Name `[get]`
	The internal name of this. More...

Properties inherited from Terraria.ModLoader.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...

Detailed Description

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

Member Function Documentation

◆ Draw()

virtual void Terraria.ModLoader.ModBossBarStyle.Draw	(	SpriteBatch	spriteBatch,
		IBigProgressBar	currentBar,
		BigProgressBarInfo	info
	)

virtual

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

Parameters

spriteBatch	The spriteBatch that is drawn on
currentBar	The boss bar that vanilla update code decided to draw. Can be null if skipped or if no suitable NPCs found. Can be casted to ModBossBar
info	Contains the index of the NPC the game decided to focus on

◆ OnDeselected()

virtual void Terraria.ModLoader.ModBossBarStyle.OnDeselected ( )

virtual

Called when this ModBossBarStyle is deselected

◆ OnSelected()

virtual void Terraria.ModLoader.ModBossBarStyle.OnSelected ( )

virtual

Called when this ModBossBarStyle is selected

◆ Register()

sealed override void Terraria.ModLoader.ModBossBarStyle.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.ModBossBarStyle.SetupContent ( )

virtual

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

Reimplemented from Terraria.ModLoader.ModType.

◆ Update()

virtual void Terraria.ModLoader.ModBossBarStyle.Update	(	IBigProgressBar	currentBar,
		ref BigProgressBarInfo	info
	)

virtual

Runs after update code for boss bars (skipped if PreventUpdate returns true), can be used to identify which NPCs to draw.

Parameters

currentBar	The boss bar that vanilla update code decided to draw. Can be null if skipped or if no suitable NPCs found. Can be casted to ModBossBar
info	Contains the index of the NPC the game decided to focus on

Property Documentation

◆ DisplayName

virtual string Terraria.ModLoader.ModBossBarStyle.DisplayName

get

Controls the name that shows up in the menu selection. If not overridden, it will use this mod's display name.

◆ IsSelected

bool Terraria.ModLoader.ModBossBarStyle.IsSelected

get

Checks if the selected style matches this ModBossBarStyle.

◆ PreventDraw

virtual bool Terraria.ModLoader.ModBossBarStyle.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.

◆ PreventUpdate

virtual bool Terraria.ModLoader.ModBossBarStyle.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.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Draw()

◆ OnDeselected()

◆ OnSelected()

◆ Register()

◆ SetupContent()

◆ Update()

Property Documentation

◆ DisplayName

◆ IsSelected

◆ PreventDraw

◆ PreventUpdate