SetINIFloat

From GECK
Jump to: navigation, search


A function added by the Lutana NVSE plugin, now part of the JIP NVSE Plugin.

Description

Sets the numerical value of an INI key.

Syntax

[help]
SetINIFloat keystring:string value:float filename:string 

Example

SetINIFloat "GamePlay:fMeleeDamageMultiplier" 2 "MyFolder\MyFile.ini"

Once this function is called it should automatically make an INI file (If not created already) named MyFile.ini in "Data\Config\MyFolder"

The INI file should now contain the following:

[GamePlay]
fMeleeDamageMultiplier=2

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.
  • A keystring is a string containing both the section and key in the format: "Section:Key" ('\' and '/' may also be used as the delimiter.)

See Also