Table of Contents

Class TuningAnalysis

Namespace
LlamaLogic.TuningArchive
Assembly
LlamaLogic.TuningArchive.dll

Represents a tuning document understood through a set of tuning descriptions

public sealed class TuningAnalysis
Inheritance
TuningAnalysis
Inherited Members

Properties

Instance

Gets the instance description of the document, if it is instance tuning and its class was found

public TuningDescriptionInstance? Instance { get; }

Property Value

TuningDescriptionInstance

InstanceMembers

Gets the tunables the document's class has, including those it inherits, in the order the game collects them, if it is instance tuning and its class was found; otherwise, an empty list

public IReadOnlyList<TunableDescription> InstanceMembers { get; }

Property Value

IReadOnlyList<TunableDescription>

Module

Gets the module description of the document, if it is module tuning and its module was found

public TuningDescriptionModule? Module { get; }

Property Value

TuningDescriptionModule

Nodes

Gets the elements of the document, in document order

public IReadOnlyList<TuningNode> Nodes { get; }

Property Value

IReadOnlyList<TuningNode>

PythonModule

Gets the Python module the document's class is in (its m attribute), or the module of module tuning

public string? PythonModule { get; }

Property Value

string

References

Gets the references in the document

public IEnumerable<TuningNode> References { get; }

Property Value

IEnumerable<TuningNode>

UnrecognizedPaths

Gets the elements whose names the tuning descriptions do not recognize, by path (a large number suggests the descriptions are for another version of the game)

public IReadOnlyList<string> UnrecognizedPaths { get; }

Property Value

IReadOnlyList<string>

Methods

Analyze(string, TuningDescriptionCache)

Analyzes the specified tuning document text (canonical text, see TuningXml) with the tuning descriptions of the specified cache, which keeps the descriptions it reads for later analyses

public static TuningAnalysis Analyze(string text, TuningDescriptionCache cache)

Parameters

text string
cache TuningDescriptionCache

Returns

TuningAnalysis

Analyze(string, TuningDescriptionSet)

Analyzes the specified tuning document text (canonical text, see TuningXml) with the specified descriptions

public static TuningAnalysis Analyze(string text, TuningDescriptionSet descriptions)

Parameters

text string
descriptions TuningDescriptionSet

Returns

TuningAnalysis

GetReferenceResourceType(string)

Gets the resource type a tuning description's reference type name (such as buff or caspart) refers to

public static ResourceType GetReferenceResourceType(string typeName)

Parameters

typeName string

Returns

ResourceType

IsTuningReferenceType(string)

Gets whether a tuning description's reference type name refers to tuning (rather than another kind of resource)

public static bool IsTuningReferenceType(string typeName)

Parameters

typeName string

Returns

bool