tModLoader v2024.03
A mod to make and play Terraria mods
TooltipKeyAttribute Class Reference

A tooltip is the text shown to the user in the ModConfig UI next to the cursor when they hover over the annotated member (property, field, or class). This can be longer and more descriptive than the Label.
This attribute sets a custom localization key for the tooltip of the annotated property, field, or class.
The provided localization key must start with "$".
Without this attribute, the localization key "Mods.{ModName}.Configs.{ConfigName}.{MemberName}.Tooltip" will be assumed for members of ModConfig classes.
Annotations on members of non-ModConfig classes need to supply a custom localization key using this attribute to be localized, no localization key is assumed. If the translation value of a property or field that is an object is an empty string, the tooltip of the class will be used instead. Passing in just "$" will result in no tooltip entry being added to the localization files.
Values can be interpolated into the resulting label text using TooltipArgsAttribute.
More...

Inherits ConfigKeyAttribute.

Public Member Functions

 TooltipKeyAttribute (string key)
 
- Public Member Functions inherited from ConfigKeyAttribute
 ConfigKeyAttribute (string key)
 

Detailed Description

A tooltip is the text shown to the user in the ModConfig UI next to the cursor when they hover over the annotated member (property, field, or class). This can be longer and more descriptive than the Label.
This attribute sets a custom localization key for the tooltip of the annotated property, field, or class.
The provided localization key must start with "$".
Without this attribute, the localization key "Mods.{ModName}.Configs.{ConfigName}.{MemberName}.Tooltip" will be assumed for members of ModConfig classes.
Annotations on members of non-ModConfig classes need to supply a custom localization key using this attribute to be localized, no localization key is assumed. If the translation value of a property or field that is an object is an empty string, the tooltip of the class will be used instead. Passing in just "$" will result in no tooltip entry being added to the localization files.
Values can be interpolated into the resulting label text using TooltipArgsAttribute.