Properties and Metadata - Crynano/Mod-Configuration-Menu GitHub Wiki
Introduction
You can decorate your .ini file or provide metadata using ConfigValue
Note: If you are providing a list of ConfigValue through RegisterModConfig, there's a constructor that will help you through this process.
Properties
Name |
Valid Types |
Description |
Key |
string |
Key to identify the ConfigValue with. It's usually your variable name. Must be unique. |
Value |
object |
Value that the ConfigValue has. Will be displayed the first time the UI is created. It stores the underlying type, so assign any type you want. |
Header |
string |
Determines under which category does the ConfigValue go. Affects order in MCM UI. |
Metadata
Name |
Valid Types |
Description |
default |
object |
Default value for variable. Must be the same type as the Value property. |
min |
int, float, double |
Used for numerical variables only. Determines the minimum value for the range bar. |
max |
int, float, double |
Used for numerical variables only. Determines the minimum value for the range bar. |
label |
string |
Replaces variable name in UI. Used to beautify name. |
tooltip |
string |
Help message shown when hovering ConfigValue. |
type |
string |
Forced type casting or used to change behaviour. For example dropdown for int. |
Accepted entries for metadata
Name |
Valid Entries |
type |
int, float, dropdown |