Difference between revisions of "SetINIBool - Utility"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus Debug Only Functions]]
'''Member of:''' [[Utility Script]]
'''Member of:''' [[Utility Script]]


Sets a boolean INI setting's value.
Sets a boolean value in the Fallout 4 [[Initialization File]]s (<code>.ini</code>).


== Syntax ==
== Syntax ==
Line 12: Line 9:


== Parameters ==
== Parameters ==
*ini: The ini setting to set
*ini: The <code>.ini</code setting name and section. For example, <code>bSettingName:SectionName</code>
*value: The value to give it
*value: The boolean value to assign the setting.


== Return Value ==
== Return Value ==
Line 25: Line 22:


== Notes ==
== Notes ==
This function can only change the values of pre-defined ini settings in Fallout4.ini and Fallout4Prefs.ini and only during the current game session. It cannot create new settings and does not save them to an ini file. There is also no guarantee the game will ever read the value again past initial load, so changing it may have no effect.
This function can only change the values of pre-defined ini settings in Fallout4.ini and Fallout4Prefs.ini and only during the current game session.  
It cannot create new settings and does not save them to an ini file.  
There is also no guarantee the game will ever read the value again past initial load, so changing it may have no effect.


== See Also ==
== See Also ==
Line 32: Line 31:
*[[SetINIInt - Utility]]
*[[SetINIInt - Utility]]
*[[SetINIString - Utility]]
*[[SetINIString - Utility]]
*[[Initialization File]]
*[[Papyrus Naming Conventions]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus Debug Only Functions]]

Revision as of 22:11, 21 December 2018

Member of: Utility Script

Sets a boolean value in the Fallout 4 Initialization Files (.ini).

Syntax

Function SetINIBool(string ini, bool value) native global debugOnly

Parameters

  • ini: The .ini</code setting name and section. For example, bSettingName:SectionName
  • value: The boolean value to assign the setting.

Return Value

None

Examples

; Set the "bRandomSetting" in the "[CoolSettings]" section to true
Utility.SetINIBool("bRandomSetting:CoolSettings", true)

Notes

This function can only change the values of pre-defined ini settings in Fallout4.ini and Fallout4Prefs.ini and only during the current game session. It cannot create new settings and does not save them to an ini file. There is also no guarantee the game will ever read the value again past initial load, so changing it may have no effect.

See Also