tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.GlobalBossBar Class Reference

A class that is used to modify existing boss health bars. To add them, use ModBossBar instead. More...

Inherits Terraria.ModLoader.ModType.

Public Member Functions

virtual void PostDraw (SpriteBatch spriteBatch, NPC npc, BossBarDrawParams drawParams)
 Allows you to draw things after the bar has been drawn. skipped is true if you or another mod has skipped drawing the bar (possibly hiding it or in favor of new visuals). More...
 
virtual bool PreDraw (SpriteBatch spriteBatch, NPC npc, ref BossBarDrawParams drawParams)
 Allows you to draw things before the default draw code is ran. Return false to prevent drawing the bar. Returns true by default. 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 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...
 

Additional Inherited Members

- 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 modify existing boss health bars. To add them, use ModBossBar instead.

Member Function Documentation

◆ PostDraw()

virtual void Terraria.ModLoader.GlobalBossBar.PostDraw ( SpriteBatch  spriteBatch,
NPC  npc,
BossBarDrawParams  drawParams 
)
virtual

Allows you to draw things after the bar has been drawn. skipped is true if you or another mod has skipped drawing the bar (possibly hiding it or in favor of new visuals).

Parameters
spriteBatchThe spriteBatch that is drawn on
npcThe NPC this bar is focused on
drawParamsThe draw parameters for the boss bar

◆ PreDraw()

virtual bool Terraria.ModLoader.GlobalBossBar.PreDraw ( SpriteBatch  spriteBatch,
NPC  npc,
ref BossBarDrawParams  drawParams 
)
virtual

Allows you to draw things before the default draw code is ran. Return false to prevent drawing the bar. Returns true by default.

Parameters
spriteBatchThe spriteBatch that is drawn on
npcThe NPC this bar is focused on
drawParamsThe draw parameters for the boss bar
Returns
true for allowing drawing, false for preventing drawing

◆ Register()

sealed override void Terraria.ModLoader.GlobalBossBar.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.GlobalBossBar.SetupContent ( )
virtual

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

Reimplemented from Terraria.ModLoader.ModType.