Namespace BepInEx.Configuration
Classes
AcceptableValueBase
Base type of all classes representing and enforcing acceptable values of config settings.
AcceptableValueList<T>
Specify the list of acceptable values for a setting.
AcceptableValueRange<T>
Specify the range of acceptable values for a setting.
ConfigDefinition
Section and key of a setting. Used as a unique key for identification within a ConfigFile. The same definition can be used in multiple config files, it will point to different settings then.
ConfigDescription
Metadata of a ConfigEntryBase.
ConfigEntry<T>
Provides access to a single setting inside of a ConfigFile.
ConfigEntryBase
Container for a single setting of a ConfigFile. Each config entry is linked to one config file.
ConfigFile
A helper class to handle persistent data. All public methods are thread-safe.
ConfigWrapper<T>
Provides access to a single setting inside of a ConfigFile.
SettingChangedEventArgs
Arguments for events concerning a change of a setting.
TomlTypeConverter
Serializer/deserializer used by the config system.
TypeConverter
A serializer/deserializer combo for some type(s). Used by the config system.
Structs
KeyboardShortcut
A keyboard shortcut that can be used in Update method to check if user presses a key combo. The shortcut is only
triggered when the user presses the exact combination. For example, F + LeftCtrl
will trigger only if user
presses and holds only LeftCtrl, and then presses F. If any other keys are pressed, the shortcut will not trigger.
Can be used as a value of a setting in Bind<T>(ConfigDefinition, T, ConfigDescription) to allow user to change this shortcut and have the changes saved.
How to use: Use IsDown() in this class instead of UnityEngine.Input.GetKeyDown(UnityEngine.KeyCode) in the Update loop.