Table of Contents

Class TuningArchiveSnapshot

Namespace
LlamaLogic.TuningArchive
Assembly
LlamaLogic.TuningArchive.dll

Represents the state of the game's tuning at a point in time, as captured in a TuningArchiveFile

public sealed class TuningArchiveSnapshot
Inheritance
TuningArchiveSnapshot
Inherited Members

Properties

CapturedAt

Gets when the snapshot was captured

public DateTimeOffset CapturedAt { get; }

Property Value

DateTimeOffset

DisplayName

Gets the name to display for the snapshot: its label if it has one, otherwise its game version

public string DisplayName { get; }

Property Value

string

GameVersion

Gets the version of the game the snapshot represents

public string GameVersion { get; }

Property Value

string

Id

Gets the identifier of the snapshot within its archive

public long Id { get; }

Property Value

long

Kinds

Gets the kinds of resources the snapshot contains

public IReadOnlySet<TuningArchiveResourceKind> Kinds { get; }

Property Value

IReadOnlySet<TuningArchiveResourceKind>

Label

Gets the label the creator gave the snapshot, if any

public string? Label { get; }

Property Value

string

Locale

Gets the locale of the snapshot's strings, if it has any

public string? Locale { get; }

Property Value

string

Notes

Gets the notes the creator wrote about the snapshot, if any

public string? Notes { get; }

Property Value

string

Packs

Gets the packs that were present when the snapshot was taken

public IReadOnlyList<TuningArchiveSnapshotPack> Packs { get; }

Property Value

IReadOnlyList<TuningArchiveSnapshotPack>

Source

Gets where the contents of the snapshot came from

public TuningArchiveSnapshotSource Source { get; }

Property Value

TuningArchiveSnapshotSource

SourcePath

Gets the path of the installation or folder the snapshot came from, if it is known

public string? SourcePath { get; }

Property Value

string

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

IsCaptureOf(GameInstallation)

Gets whether the snapshot was captured from an installation of the same game version as the specified installation, with the same packs at the same versions

public bool IsCaptureOf(GameInstallation installation)

Parameters

installation GameInstallation

Returns

bool

Remarks

The kinds of resources the snapshot contains are not considered (see Kinds).

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.