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 ModResourceDisplaySet.
More...
|
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 More...
|
|
virtual void | PostDrawResource (ResourceOverlayDrawContext context) |
| Allows you to draw on top of any resource (hearts, stars, bars or panels) in a display set More...
|
|
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 More...
|
|
virtual bool | PreDrawResource (ResourceOverlayDrawContext context) |
| Allows you to draw below any resource (hearts, stars, bars or panels) in a display set More...
|
|
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 ModResourceDisplaySet instead of this hook. More...
|
|
sealed override void | SetupContent () |
| If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
|
|
virtual TModType | Clone (TEntity newEntity) |
| Create a copy of this instanced global. Called when an entity is cloned. More...
|
|
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 TModType | NewInstance (TEntity entity) |
| Create a new instance of this ModType for a specific entity More...
|
|
virtual void | SetStaticDefaults () |
| Allows you to modify the properties after initial loading has completed. More...
|
|
virtual void | SetupContent () |
| If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
|
|
virtual void | Unload () |
| Allows you to safely unload things you added in Load. More...
|
|
virtual bool | IsLoadingEnabled (Mod mod) |
| Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More...
|
|
abstract void | Load (Mod mod) |
| Called when loading the type. More...
|
|
abstract void | Unload () |
| Called during unloading when needed. More...
|
|
virtual TModType | Clone (TEntity newEntity) |
| Create a copy of this instanced global. Called when an entity is cloned. More...
|
|
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 TModType | NewInstance (TEntity entity) |
| Create a new instance of this ModType for a specific entity More...
|
|
virtual void | SetStaticDefaults () |
| Allows you to modify the properties after initial loading has completed. More...
|
|
virtual void | SetupContent () |
| If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
|
|
virtual void | Unload () |
| Allows you to safely unload things you added in Load. More...
|
|
|
int | Type [get, set] |
|
virtual bool | CloneNewInstances [get] |
| Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
|
|
TEntity | Entity [get, set] |
|
string | FullName [get] |
| The internal name of this, including the mod it is from. More...
|
|
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]
|
|
Mod | Mod [get, set] |
| The mod this belongs to. More...
|
|
virtual string | Name [get] |
| The internal name of this. More...
|
|
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...
|
|
virtual bool | CloneNewInstances [get] |
| Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
|
|
TEntity | Entity [get, set] |
|
string | FullName [get] |
| The internal name of this, including the mod it is from. More...
|
|
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]
|
|
Mod | Mod [get, set] |
| The mod this belongs to. More...
|
|
virtual string | Name [get] |
| The internal name of this. More...
|
|
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 ModResourceDisplaySet.