ConfigDescription Class
Definition
Section titled “Definition”Metadata of a ConfigEntryBase.
public class ConfigDescriptionInheritance object
Constructors
Section titled “Constructors”ConfigDescription(string, AcceptableValueBase, params object[])
Section titled “ConfigDescription(string, AcceptableValueBase, params object[])”Create a new description.
public ConfigDescription(string description, AcceptableValueBase acceptableValues = null, params object[] tags)Parameters
Section titled “Parameters”description string
Text describing the function of the setting and any notes or warnings.
acceptableValues AcceptableValueBase
Range of values that this setting can take. The setting’s value will be automatically
clamped.
tags object[]
Objects that can be used by user-made classes to add functionality.
Properties
Section titled “Properties”Description
Section titled “Description”Text describing the function of the setting and any notes or warnings.
public string Description { get; }AcceptableValues
Section titled “AcceptableValues”Range of acceptable values for a setting.
public AcceptableValueBase AcceptableValues { get; }Objects that can be used by user-made classes to add functionality.
public object[] Tags { get; }An empty description.
public static ConfigDescription Empty { get; }