|
TModLoader v1.4.4.9
TModLoader source code documentation
|
A class that is used to modify existing boss health bars. To add them, use ModBossBar instead. More...
Inheritance diagram for Terraria.ModLoader.GlobalBossBar:
Collaboration diagram for Terraria.ModLoader.GlobalBossBar: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 | 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. | |
| 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). | |
| 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 | |
| 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 |
A class that is used to modify existing boss health bars. To add them, use ModBossBar instead.
Definition at line 9 of file GlobalBossBar.cs.