![]() |
tModLoader v2024.07
A mod to make and play Terraria mods
|
Inherits VanillaInfoDisplay.
Public Member Functions | |
override bool | Active () |
This dictates whether or not this info display should be active.This is usually determined by player-specific values, typically set in ModItem.UpdateInventory. More... | |
![]() | |
override string | DisplayValue (ref Color displayColor, ref Color displayShadowColor) |
This is the value that will show up when viewing this display in normal play, right next to the icon. Set displayColor to InactiveInfoTextColor if your display value is "zero"/shows no valuable information. More... | |
![]() | |
virtual bool | Active () |
This dictates whether or not this info display should be active.This is usually determined by player-specific values, typically set in ModItem.UpdateInventory. More... | |
virtual string | DisplayValue (ref Color displayColor) |
virtual string | DisplayValue (ref Color displayColor, ref Color displayShadowColor) |
This is the value that will show up when viewing this display in normal play, right next to the icon. Set displayColor to InactiveInfoTextColor if your display value is "zero"/shows no valuable information. 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... | |
string | PrettyPrintName () |
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... | |
string | PrettyPrintName () |
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... | |
Properties | |
override string | LangKey [get] |
override string | Texture [get] |
![]() | |
override LocalizedText | DisplayName [get] |
override string | HoverTexture [get] |
abstract string | LangKey [get] |
![]() | |
static InfoDisplay | Compass = new CompassInfoDisplay() [get] |
static InfoDisplay | DepthMeter = new DepthMeterInfoDisplay() [get] |
virtual LocalizedText | DisplayName [get] |
This is the name that will show up when hovering over this info display. | |
static InfoDisplay | DPSMeter = new DPSMeterInfoDisplay() [get] |
static InfoDisplay | FishFinder = new FishFinderInfoDisplay() [get] |
static Color | GoldInfoTextColor [get] |
The golden color variant of the displays text. Used by the Lifeform Analyzer. | |
static Color | GoldInfoTextShadowColor [get] |
The golden color variant of the displays text shadow. Used by the Lifeform Analyzer. | |
virtual string | HoverTexture [get] |
The outline texture drawn when the icon is hovered and toggleable. By default a circular outline texture is used. Override this method and return Texture + "_Hover" or any other texture path to specify a custom outline texture for use with icons that are not circular. | |
static Color | InactiveInfoTextColor [get] |
The color when no valuable information is displayed. | |
static InfoDisplay | LifeformAnalyzer = new LifeformAnalyzerInfoDisplay() [get] |
virtual string | LocalizationCategory [get] |
The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom ModType classes can utilize this. More... | |
static InfoDisplay | MetalDetector = new MetalDetectorInfoDisplay() [get] |
static InfoDisplay | Radar = new RadarInfoDisplay() [get] |
static InfoDisplay | Sextant = new SextantInfoDisplay() [get] |
static InfoDisplay | Stopwatch = new StopwatchInfoDisplay() [get] |
static InfoDisplay | TallyCounter = new TallyCounterInfoDisplay() [get] |
int | Type [get, set] |
This is the internal ID of this InfoDisplay.Also serves as the index for Player.hideInfo. | |
static string | VanillaHoverTexture [get] |
The path to the texture vanilla info displays use when hovering over an info display. | |
static InfoDisplay | Watches = new WatchesInfoDisplay() [get] |
static InfoDisplay | WeatherRadio = new WeatherRadioInfoDisplay() [get] |
![]() | |
virtual string | Texture [get] |
The file name of this type's texture file in the mod loader's file space. | |
![]() | |
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... | |
![]() | |
abstract string | LocalizationCategory [get] |
The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom ModType classes can utilize this. More... | |
Additional Inherited Members | |
![]() | |
sealed override void | Register () |
If you make a new ModType, seal this override. More... | |
override void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
![]() | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
![]() | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
|
virtual |
This dictates whether or not this info display should be active.This is usually determined by player-specific values, typically set in ModItem.UpdateInventory.
Reimplemented from InfoDisplay.