Table of Contents

Class TuningDescriptionClass

Namespace
LlamaLogic.TuningDescriptions
Assembly
LlamaLogic.TuningDescriptions.dll

Represents a class described in a TuningDescriptionModule (a Class element): an enumeration, the holder of module tuning, or both (🔒)

public sealed class TuningDescriptionClass
Inheritance
TuningDescriptionClass
Inherited Members

Properties

Attributes

Gets all of the class's attributes, by name

public IReadOnlyDictionary<string, string> Attributes { get; }

Property Value

IReadOnlyDictionary<string, string>

Classes

Gets the classes nested in this one, in document order

public IReadOnlyList<TuningDescriptionClass> Classes { get; }

Property Value

IReadOnlyList<TuningDescriptionClass>

EnumItems

Gets the members of the enumeration the class is, in document order

public IReadOnlyList<TuningDescriptionEnumItem> EnumItems { get; }

Property Value

IReadOnlyList<TuningDescriptionEnumItem>

IsBitFlagEnum

Gets whether the class is an enumeration of bit flags (its enum_bit_flag attribute)

public bool IsBitFlagEnum { get; }

Property Value

bool

IsEnum

Gets whether the class is an enumeration

public bool IsEnum { get; }

Property Value

bool

IsLockedEnum

Gets whether the enumeration's members are fixed (its enum_locked attribute)

public bool IsLockedEnum { get; }

Property Value

bool

Members

Gets the module tuning the class declares, in document order

public IReadOnlyList<TunableDescription> Members { get; }

Property Value

IReadOnlyList<TunableDescription>

Module

Gets the module in which the class is described

public TuningDescriptionModule Module { get; }

Property Value

TuningDescriptionModule

Muid

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

public ulong? Muid { get; }

Property Value

ulong?

Name

Gets the name of the class (its name attribute)

public string Name { get; }

Property Value

string

Parent

Gets the class in which this one is nested, or null if it is not nested

public TuningDescriptionClass? Parent { get; }

Property Value

TuningDescriptionClass

StaticEntriesName

Gets the name by which a StaticEntries attribute refers to the class, such as sims-sim_info_types.Age

public string StaticEntriesName { get; }

Property Value

string

Methods

GetClass(string)

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

public TuningDescriptionClass? GetClass(string name)

Parameters

name string

Returns

TuningDescriptionClass

GetEnumValue(string)

Gets the value of the enumeration member with the specified name, or null if there is none

public long? GetEnumValue(string name)

Parameters

name string

Returns

long?