ConfigFile

public ConfigFile();

Creates an empty in-memory store of sections, keys and Variants. Does not itself open a file or load earlier data.

public void Clear();

Removes every section and value from this instance's memory only. Neither deletes a file nor saves the change to disk.

public string EncodeToText();

Creates a text representation of current values without writing a file. Does not preserve comments or original formatting. It is not guaranteed to match Save byte for byte: the current engine writes section a]b here as [a]b], whereas Save escapes the closing bracket. Use Save for files with such section names.

public void EraseSection(string section);

Removes the section and all its keys in memory. A missing section reports a native error rather than a guaranteed CLR exception. Check HasSection first when absence is expected. Does not change the disk file.

public void EraseSectionKey(string section, string key);

Removes a key from an in-memory section. Removing its last key also removes the section. A missing section or key reports a native error; use HasSectionKey before conditional removal. Persist the change with a separate Save.

public string[] GetSectionKeys(string section);

Returns key names from an existing section. A missing section reports a native error and returns an empty array. Use HasSection when absence is expected to avoid that error.

public string[] GetSections();

Returns an array of this instance's section names. It is neither a file listing nor the section values. Do not tie save-format logic to a name's position in the array.

public Variant GetValue(string section, string key, Variant @default = default);

Returns the specified key value. If the section or key is absent, returns the supplied default. A missing value with a Nil default also produces an engine error; this does not replace explicitly checking whether the key exists.

public bool HasSection(string section);

Checks in-memory section existence without loading a file or reporting a missing-section error. Does not establish that its values have the required types.

public bool HasSectionKey(string section, string key);

Checks whether an in-memory section/key pair exists. A missing section returns false without an error. Check the value type and range separately after GetValue.

public Error Load(string path);

Reads and parses a file into this ConfigFile. Matching values are replaced, but existing values absent from the file remain: Load does not clear the object. Use a new ConfigFile or call Clear() first for replacement. Check the returned Error.

public Error LoadEncrypted(string path, byte[] key);

Opens an encrypted file using the supplied 32-byte key, then parses values into this instance. Like Load, merges data without clearing earlier values. A wrong key, damaged file or parse error is not a successful load: check Error and apply data from a fresh object only after validation.

public Error LoadEncrypted(string path, ReadOnlySpan<byte> key);

Opens an encrypted file using the supplied 32-byte key, then parses values into this instance. Like Load, merges data without clearing earlier values. A wrong key, damaged file or parse error is not a successful load: check Error and apply data from a fresh object only after validation.

public Error LoadEncryptedPass(string path, string password);

Loads a SaveEncryptedPass file using the same password, then merges values into the current object. Neither clears earlier state nor establishes that gameplay data is valid: check Error, types and ranges.

public Error Parse(string data);

Parses text into this instance, adding values and replacing matching keys. Does not clear earlier data. Mutates the object while parsing: an error does not guarantee rollback of values already read. For independent loading, parse into a new ConfigFile and check Error before applying data to the game.

public Error Save(string path);

Writes the current ConfigFile values to a file with an INI-style structure. SetValue changes memory only; writing requires a separate Save. Missing parent directories are not created.

public Error SaveEncrypted(string path, byte[] key);

Writes current values using AES-256 and the supplied 32-byte key. Does not create parent directories or perform an atomic replacement with a backup. An error does not guarantee preservation of the old file: the destination is opened for writing before the operation finishes.

public Error SaveEncrypted(string path, ReadOnlySpan<byte> key);

Writes current values using AES-256 and the supplied 32-byte key. Does not create parent directories or perform an atomic replacement with a backup. An error does not guarantee preservation of the old file: the destination is opened for writing before the operation finishes.

public Error SaveEncryptedPass(string path, string password);

Saves values with encryption using the built-in password-derived key. This is a different key-input method from passing 32 bytes to SaveEncrypted. Does not back up or atomically replace an existing file.

public void SetValue(string section, string key, Variant value);

Assigns a value in memory, creating the section and key when needed. A Nil value, including default(Variant), removes the key and removes its section if empty. The file is not changed until Save.