GetINIFloatOrDefault Cached
From GECK
A function added by the ShowOff NVSE Plugin version 1.45.
Contents
Description
Returns the float value of an INI key. If it does not exist or could not be found, defaultValue is returned.
Reads the INI file data from a memory cache.
- If the file was not previously cached, then it becomes cached.
- 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
(value:float) GetINIFloatOrDefault_Cached sectionAndKey:string iniPath:string{""} defaultValue:Float{0}
Or:
(value:float) GetINIFloat_Cached sectionAndKey:string iniPath:string{""} defaultValue:Float{0}
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.)
