GetINIBool - Utility

From the CreationKit Wiki
Revision as of 12:39, 13 September 2018 by imported>DAb
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to 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[edit | edit source]

Function GetINIBool(String ini) Native Global

Parameters[edit | edit source]

ini: The ini setting to get

Return Value[edit | edit source]

Returns the value of the specified boolean INI setting.

Notes[edit | edit source]

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[edit | edit source]

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[edit | edit source]