Table of Contents

Namespace LlamaLogic.TuningArchive

Classes

GameInstallation

Represents an installation of The Sims 4 from which a TuningArchiveFile can capture a snapshot (🔒)

GameInstallationPack

Represents the base game or a pack in a GameInstallation (🔒)

GameInstallationPackage

Represents a package file of a GameInstallationPack and the priority the game loads it with

Sims4StudioBatchImport

Names files the way Sims 4 Studio's batch import reads them

TuningAnalysis

Represents a tuning document understood through a set of tuning descriptions

TuningArchiveCaptureOptions

Represents the choices a creator makes when capturing a snapshot from an installation of the game

TuningArchiveCaptureResult

Represents the outcome of capturing or importing a snapshot into a TuningArchiveFile

TuningArchiveChange

Represents how a resource differs, if at all, between two snapshots

TuningArchiveDescriptions

Represents a set of tuning descriptions (TDESCs) imported into a TuningArchiveFile

TuningArchiveEntry

Represents a version of a resource in a TuningArchiveFile

TuningArchiveExportOptions

Represents the choices a creator makes when exporting a snapshot as files, the way Scumbumbo's XML Extractor extracts the game's tuning

TuningArchiveExportResult

Represents the outcome of exporting a snapshot as files

TuningArchiveFile

Represents an archive of The Sims 4's tuning across versions of the game, stored in a SQLite database file (🔒)

TuningArchiveHistoryItem

Represents a version of a resource and the snapshots that contain it

TuningArchiveImportOptions

Represents the choices a creator makes when importing a folder of tuning files extracted by another tool as a snapshot

TuningArchiveReference

Represents a reference from a tuning to another tuning or resource

TuningArchiveSnapshot

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

TuningArchiveSnapshotPack

Represents a pack that was present when a TuningArchiveSnapshot was taken

TuningArchiveStringChange

Represents how a string differs, if at all, between two snapshots

TuningArchiveUninstalledTuning

Represents a tuning of a pack that was not installed when a TuningArchiveSnapshot was captured, known only from the pack's patches in the game's Delta folder

TuningCommenter

Adds to tuning the comments XML Extractor adds, as a snapshot knows them: the text of each string after its key, and the class and name of the tuning or animation state machine each reference refers to

TuningCoreLibraryDraft

Drafts a Lot 51 Core Library tuning injector snippet (for Core Library 1.43) that makes changes to tuning without overriding it

TuningDescriptionCache

Keeps the documents of a TuningDescriptionSet that analysis has used, so that analyzing many tunings does not read and parse the same descriptions repeatedly (🔒)

TuningDraftDiagnostic

Represents what a draft does, or cannot do, about a change to a tunable

TuningDraftResult

Represents a draft that makes changes to tuning without overriding it: a script or a snippet

TuningDraftTarget

Represents a tuning a creator has changed in a draft: the tuning as the archive has it and as the creator wants it

TuningFolderUpdate

Finds the overrides of game tuning in every package in a folder and its subfolders, works out what a game version means for each, checks the SimData of the tuning the packages add against the game version's tuning descriptions, and writes updated copies of the packages with the changes that need no judgment from the creator, with a report of everything

TuningFolderUpdateOptions

Represents which changes a folder update makes beyond the merges that need no judgment from the creator

TuningFolderUpdatePackage

Represents a package in a folder being updated

TuningFolderUpdateReportRow

Represents a row of a folder update's report: an override, the SimData of a tuning a package adds, or a package that couldn't be read

TuningFolderUpdateResult

Represents what writing a folder update did

TuningFolderUpdateWrite

Represents what writing a folder update did for one of its packages

TuningMerge

Merges a mod's changes to a tuning onto the game's new version of it: a three-way merge of the version the mod was made from (the base), the mod's version, and the game's new version

TuningMergeConflict

Represents a place where a merge could not combine the mod's change with the game's

TuningMergeResult

Represents the result of a merge of a mod's changes onto the game's new version of a tuning

TuningNode

Represents an element of a tuning document, as understood through its tuning description

TuningPackageAddedSimData

Represents the SimData of tuning a package adds (rather than overrides), checked against SimData generated from the tuning with the tuning descriptions of the game version the package is being updated for

TuningPackageAddedSimDataPlan

Represents what a set of fixes does to the SimData of tuning a package adds, and to the tuning

TuningPackageOverride

Represents a mod's override of a game tuning, and what a game version means for it

TuningPackageUpdate

Finds a mod package's overrides of game tuning, works out what a game version means for each, and writes an updated copy of the package

TuningPackageUpdateChange

Represents what writing an updated package did to a resource

TuningPythonDraft

Drafts a Python script mod that makes changes to tuning as the game loads it, without overriding any tuning

TuningSemanticChange

Represents an element that differs between two versions of a tuning document

TuningSemanticDiff

Compares two versions of a tuning document element by element, matching elements by name and aligning list items, rather than line by line

TuningSimDataDraftResult

Represents the SimData an override of a tuning needs

TuningSimDataDrafter

Generates the SimData that overrides of a snapshot's tuning need, trusting the result only when the generator reproduces the game's own SimData for the original tuning

TuningXml

Provides the canonical text form in which a tuning archive stores tuning and SimData documents

TuningXmlInjectorDraft

Drafts an XML Injector snippet (for Scumbumbo's XML Injector, version 4) that makes changes to tuning without overriding it

Structs

TuningArchiveProgress

Represents the progress of a long-running TuningArchiveFile operation

Enums

TuningArchiveChangeKind

Specifies how a resource differs, if at all, between two snapshots

TuningArchiveExportAttributeOrder

Specifies the order in which ExportAsync(TuningArchiveSnapshot, string, TuningArchiveExportOptions?, IProgress<TuningArchiveProgress>?, CancellationToken) writes the n and t attributes of an element that has both

TuningArchiveExportExistingFiles

Specifies what ExportAsync(TuningArchiveSnapshot, string, TuningArchiveExportOptions?, IProgress<TuningArchiveProgress>?, CancellationToken) does when a file it would write already exists

TuningArchiveExportNaming

Specifies how ExportAsync(TuningArchiveSnapshot, string, TuningArchiveExportOptions?, IProgress<TuningArchiveProgress>?, CancellationToken) names the files it writes, following the conventions of Scumbumbo's XML Extractor

TuningArchiveResourceKind

Specifies the kind of a resource in a TuningArchiveFile

TuningArchiveSnapshotSource

Specifies where the contents of a TuningArchiveSnapshot came from

TuningDraftSeverity

Specifies what a draft can do about a change

TuningMergeChoice

Specifies which side of a merge conflict a merge takes

TuningMergeConflictKind

Specifies why a merge could not combine the mod's change with the game's

TuningPackageAddedSimDataFixes

Specifies which fixes writing an updated package makes to the SimData of tuning it adds, and to that tuning

TuningPackageAddedSimDataProblems

Specifies what is wrong with the SimData of tuning a package adds, by the tuning descriptions of the game version it is being updated for

TuningPackageOverrideOutcome

Specifies what a game version means for a mod's override of a tuning

TuningPackageSimDataChanges

Specifies which changes writing an updated package makes to its SimData

TuningPackageSimDataState

Specifies whether a mod's SimData for an override is what the override's tuning needs in the game's new version

TuningPackageUpdateChangeKind

Specifies what writing an updated package did to a resource

TuningSemanticChangeKind

Specifies how an element differs between two versions of a tuning document

TuningSimDataDraftKind

Specifies what an override of a tuning needs from its SimData

TuningValueKind

Specifies what the value of an element of a tuning document means, according to its tuning description