Class ConfigDescription
Metadata of a ConfigEntryBase.
Namespace: BepInEx.Configuration
Assembly: BepInEx.dll
Syntax
public class ConfigDescription
Constructors
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
Range of acceptable values for a setting.
Declaration
public AcceptableValueBase AcceptableValues { get; }
Property Value
Type | Description |
---|---|
AcceptableValueBase |
Text describing the function of the setting and any notes or warnings.
Declaration
public string Description { get; }
Property Value
Type | Description |
---|---|
System.String |
An empty description.
Declaration
public static ConfigDescription Empty { get; }
Property Value
Type | Description |
---|---|
ConfigDescription |
Objects that can be used by user-made classes to add functionality.
Declaration
public object[] Tags { get; }
Property Value
Type | Description |
---|---|
System.Object[] |