Background for Skyrim SE
Member of the SKI_ConfigBase script
intfunctionAddToggleOption(stringa_text, boola_checked, inta_flags=0)

Description

GitHub Wiki Description (SkyUI)

Adds a check box option that can be toggled on and off.

Context

OnPageReset

Documentation String

Adds a check box option that can be toggled on and off


Caveats


Parameters

stringa_text

GitHub Wiki Description (SkyUI)

The option text.

boola_checked

GitHub Wiki Description (SkyUI)

The initial state of the check box.

inta_flags=0


Examples

Auto-Generated Example

string myString__a_text
bool myBool__a_checked
int myInt__a_flags

int returnedValue = mySKI_ConfigBase__toCallFunctionOn.AddToggleOption(myString__a_text, myBool__a_checked, myInt__a_flags)

Additional References

View this function on the GitHub Wiki for SkyUI

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.