-
Notifications
You must be signed in to change notification settings - Fork 4
MCM_Type
Inherited By: MCM_Category MCM_Value, MCM_String, MCM_Int, MCM_FLoat, MCM_Bool, MCM_Keycode, MCM_Color, MCM_Dropdown, MCM_Vector2, MCM_Vector3, MCM_Array, MCM_Dictionary, MCM_, MCM_Collections, MCM_Numbers, MCM_Vectors
MCMs base type to control config creation
The base type that all MCM values inherit and sets up properties that all values will use.
| Type | Name | Default Value |
|---|---|---|
| String | Section | "Value" |
| String | ID | "" |
| String | Name | "" |
| int | MenuPos | 0 |
| Return Value | Name and Parameters |
|---|---|
| MCM_Type | MCM_Type(section: String, id: String, name: String) |
| Return Value | Name and Parameters |
|---|---|
| MCM_Type | setMenuPos(menuPos: int) |
| Dictionary | createConfigObject() const |
| void | addToConfig(config: ConfigFile) const |
String | Section = "Value"
Defines the type of value this config setting will be. This tells MCM what kind of UI to use in the ingame menu.
String ID = ""
The unique ID for this value
String Name = ""
The friendly name of the value that will be displayed in the configuration menu.
int MenuPos = 0
Overrides the default alhpabetical sorting and places it in the given position in relation to other values with a menu_pos property.
Constructs an MCM_Type value and sets the Section, ID, and Name properties.
Set the position to be displayed within the MCM Menu. Lower number means it shows up earlier on the menu. For Categories it sets the position in relation to the other headers that are present.
Dictionary createConfigObject()
Internal Use Only. Do not call this method directly.
Creates the config object format and assigns set values that MCM will use to display settings.
void addToConfig(config: ConfigFile)
Internal Use Only. Do not call this method directly.
Assigns this values config object to the assigned Section and ID inside config