Module state 

Per-session state, and the operations a session can run on it.

SessionState owns everything a session works with: the open packs, the selected game, its schema and its dependencies. The operations live in the submodules, split by domain, and return plain results instead of protocol messages. crate::api translates the requests of the API into these operations.

Modules

dependencies 🔒

Game selection and dependencies operations.

diagnostics 🔒

Diagnostics and Lua script operations.

files 🔒

File operations: create, add, delete, move, extract, decode and save files of the open packs, and read files from every data source.

packs 🔒

Pack lifecycle and metadata operations: open, create, save, close, flags, settings and notes.

schema 🔒

Schema operations: definitions, local patches, and updating the schema from the Assembly Kit.

search 🔒

Global search and replace operations.

tables 🔒

Table operations: merge, update, TSV import/export, key deletes, and lookups of table data and references across the open packs and the dependencies.

tools 🔒

Tool operations: optimizer, map packing, startpos and CEO building, translations, MyMods, animation ids, glTF export and plugin scripts.

Structs

ExtractOptions

Options for operations that write files of a pack to disk.

MyModOptions

Editor support to set up in a new MyMod folder.

PasteEntry 🔒

A file to paste. Only its path is stored: the file itself is cloned from its pack when pasting.

SaveOptions

Options for saving a pack.

SessionState

Everything a session owns. One instance lives in each session’s background loop.

Enums

DecodedFile

Result of decoding a file.

MergeOutcome

Result of merging tables.

Functions

cached_lua_api 🔒

Returns the Lua scripting API of a game, rebuilding the cached one if it’s outdated.

decode_tables 🔒

Decodes the DB and Loc files among files, so they’re in memory for the diagnostics to work.

encode_extra_data 🔒

Returns the data needed to encode files of a pack for the provided game.

load_schema 🔒

Loads the schema of a game, re-decoding the tables of every open pack with it.

loaded_schema 🔒

Returns the loaded schema, or an error if there is none.

loaded_schema_mut 🔒

Returns the loaded schema mutably, or an error if there is none.

optimizer_options_with

Returns optimizer options with some of them changed, by name.

pack 🔒

Returns the open pack with the provided key.

pack_mut 🔒

Returns the open pack with the provided key, mutably.

pack_summary 🔒

Returns the short description of an open pack.

parent_pack_names 🔒

Returns the names of the parent packs of every open pack.

plugin_scripts

Returns the paths of the plugin scripts in the config’s scripts folder.

Type Aliases

LuaApiCache 🔒

Cached Lua scripting API: the docs path and dependencies build date it was built from, and the API itself.

PathsByPack

Paths of files, by the key of their pack.