Class TunableDescription
- Namespace
- LlamaLogic.TuningDescriptions
- Assembly
- LlamaLogic.TuningDescriptions.dll
Represents the description of a tunable (🔒)
public abstract class TunableDescription
- Inheritance
-
TunableDescription
- Derived
- Inherited Members
Remarks
Every attribute of the description's XML element is available in Attributes, including those this library does not give properties of their own.
Properties
Attributes
Gets all of the description's attributes, by name
public IReadOnlyDictionary<string, string> Attributes { get; }
Property Value
Class
Gets the Python class of the tunable (its class attribute)
public string? Class { get; }
Property Value
Default
Gets the tunable's default value, as written (its default attribute)
public string? Default { get; }
Property Value
Description
Gets the description of the tunable for tuners (its description attribute)
public string? Description { get; }
Property Value
Display
Gets the display name of the tunable (its display attribute)
public string? Display { get; }
Property Value
ExportModes
Gets the destinations to which the tunable is exported (its export_modes attribute), or null if the description does not specify them
public TuningDescriptionExportModes? ExportModes { get; }
Property Value
Group
Gets the group of the tunable in tuning editors (its group attribute)
public string? Group { get; }
Property Value
IsDeprecated
Gets whether the tunable is deprecated (its Deprecated attribute)
public bool IsDeprecated { get; }
Property Value
Members
Gets the descriptions nested in this one, in document order
public IReadOnlyList<TunableDescription> Members { get; }
Property Value
Muid
Gets the unique identifier Maxis assigns the tunable (its muid attribute)
public ulong? Muid { get; }
Property Value
Name
Gets the name of the tunable (its name attribute), or null for the item of a list
public string? Name { get; }
Property Value
Methods
GetMember(string)
Gets the nested description with the specified name, or null if there is none
public TunableDescription? GetMember(string name)
Parameters
namestring