MCM_Dictionary

Inherits: MCM_Collection < MCM_Value < MCM_Type

Description

Allows the player to set a dictionary of keys and values in MCM

Properties

Type	Name
String	KeyLabel
String	ValueLabel
bool	CanEditKeys

Constructors

Return Value	Name and Parameters
MCM_Dictionary	MCM_Dictionary(id: String, name: String, tooltip: String, default: Dictionary, valueType: MCM_Collection_Types, defaultItemValue: Dictionary)

Methods

Return Value	Name and Parameters
MCM_Dictionary	setKeyLabel(keyLabel: String)
MCM_Dictionary	setValueLabel(valueLabel: String)
MCM_Dictionary	setCanEditKeys(canEditKeys: bool)
Dictionary	createConfigObject() const

Property Descriptions

String KeyLabel

 The label text for the key column

---

String ValueLabel

 The label text for the value column

---

bool CanEditKeys

 Sets if the player can edit the keys in the dictionary value editor

Constructor Descriptions

MCM_Dictionary MCM_Dictionary(id: String, name: String, tooltip: String, default: Dictionary, valueType: MCM_Collection_Types, defaultItemValue: Dictionary)

 Constructs an MCM_Dictionary. And then sends section, id, name, tooltip, default, valueType, and defaultItemValue parameters to the inherited MCM_Collection constructor.

Method Descriptions

MCM_Dictionary setKeyLabel(keyLabel: String)

 Sets the label text for the key column

---

MCM_Dictionary setValueLabel(valueLabel: String)

 Sets the label text for the value column

---

MCM_Dictionary setCanEditKeys(canEditKeys: bool)

 Sets if the player can edit the keys in the dictionary value editor