Table of Contents

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

IReadOnlyDictionary<string, string>

Class

Gets the Python class of the tunable (its class attribute)

public string? Class { get; }

Property Value

string

Default

Gets the tunable's default value, as written (its default attribute)

public string? Default { get; }

Property Value

string

Description

Gets the description of the tunable for tuners (its description attribute)

public string? Description { get; }

Property Value

string

Display

Gets the display name of the tunable (its display attribute)

public string? Display { get; }

Property Value

string

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

TuningDescriptionExportModes?

Group

Gets the group of the tunable in tuning editors (its group attribute)

public string? Group { get; }

Property Value

string

IsDeprecated

Gets whether the tunable is deprecated (its Deprecated attribute)

public bool IsDeprecated { get; }

Property Value

bool

Members

Gets the descriptions nested in this one, in document order

public IReadOnlyList<TunableDescription> Members { get; }

Property Value

IReadOnlyList<TunableDescription>

Muid

Gets the unique identifier Maxis assigns the tunable (its muid attribute)

public ulong? Muid { get; }

Property Value

ulong?

Name

Gets the name of the tunable (its name attribute), or null for the item of a list

public string? Name { get; }

Property Value

string

Methods

GetMember(string)

Gets the nested description with the specified name, or null if there is none

public TunableDescription? GetMember(string name)

Parameters

name string

Returns

TunableDescription