GetINIBool - Utility

From Creation Kit
Jump to: navigation, search

SKSE Member of: UI Script

Minimum required SKSE Version: 1.04.02 Member of: Utility Script

Gets a boolean INI setting's value.

Syntax

Function GetINIBool(String ini) Native Global

Parameters

ini: The ini setting to get

Return Value

Returns the value of the specified boolean INI setting.

Notes

This works for Bethesda created settings only, whether in Skyrim.ini, SkyrimPrefs.ini, or YourLoadedPlugin.ini. Note that, in that order, each INI will override the setting(s) of the previous INI file(s).

Examples

Utility.GetINIBool("bEnableLogging:Papyrus") ; Get the value of "bEnableLogging" in the "[Papyrus]" section
  • Toggle setting:
Utility.SetINIBool("bShowCompass:Interface", !Utility.GetINIBool("bShowCompass:Interface"))

See Also