API Documentation BepInEx.Configuration ConfigDescription

Class ConfigDescription

Metadata of a ConfigEntryBase.

Inheritance
System.Object ConfigDescription
Inherited Members
System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone()
Namespace: BepInEx.Configuration
Assembly: BepInEx.Core.dll
Syntax
public class ConfigDescription

Constructors

ConfigDescription(String, AcceptableValueBase, Object[])

Improve this Doc View Source

Create a new description.

Declaration
public ConfigDescription(string description, AcceptableValueBase acceptableValues = null, params object[] tags)
Parameters
Type Name Description
System.String description

Text describing the function of the setting and any notes or warnings.
AcceptableValueBase acceptableValues

Range of values that this setting can take. The setting's value will be automatically clamped.
System.Object[] tags

Objects that can be used by user-made classes to add functionality.

Properties

AcceptableValues

Improve this Doc View Source

Range of acceptable values for a setting.

Declaration
public AcceptableValueBase AcceptableValues { get; }
Property Value
Type Description
AcceptableValueBase

Description

Improve this Doc View Source

Text describing the function of the setting and any notes or warnings.

Declaration
public string Description { get; }
Property Value
Type Description
System.String

Empty

Improve this Doc View Source

An empty description.

Declaration
public static ConfigDescription Empty { get; }
Property Value
Type Description
ConfigDescription

Tags

Improve this Doc View Source

Objects that can be used by user-made classes to add functionality.

Declaration
public object[] Tags { get; }
Property Value
Type Description
System.Object[]