SaveCachedIniFile
From GECK
(Redirected from SaveCachedIni)
A function added by the ShowOff NVSE Plugin version 1.45.
Contents
Description
Saves (writes) the contents of a cached INI file to the actual file. This recreates it entirely, and as such can be a bit costly to do constantly; one should only call this function after finishing consecutive changes.
Details on caching INI files:
- Caching eats memory, but allows faster access to the data.
- Once the cache is no longer needed, ClearFileCacheShowOff should be called to free the memory.
Syntax
(success:bool) SaveCachedIniFile iniPath:string{""}
Or:
(success:bool) SaveCachedIni iniPath:string{""}
Notes
- INI files are read from and written to in the Data\config\ folder (as in MCM's INI functions). Format Example
- If no filename is specified, the name of the mod the function is called from is used. Subdirectories can be defined in the path, e.g. "subDir\nameOfFile"
- It is likely that if you include a subdirectory, you will go over the parser limit. If this occurs, the script will compile but will not work in-game. This can be solved by passing a string variable instead.
- Writing to an INI file that does not exist will create it along with any non-existent subdirectories in its path.
- sectionAndKey is a string containing both the section and key in the format: "Section:Key" ('\' and '/' may also be used as the delimiter.)
