Background for Skyrim SE

SKI_ConfigBase


Inheritance Tree
ScriptExtended By
—
Properties

mcmhelperskyui-sdk

stringmodname=NONE
string[]pages=NONE
stringcurrentpage=NONE
intoption_flag_none=0x0
intoption_flag_disabled=0x1
intoption_flag_hidden=0x2
intoption_flag_with_unmap=0x4
intleft_to_right=1
inttop_to_bottom=2
Events
Functions
intfunctionGetVersion()

Returns the static version of this script. Not to be mistaken for the mod version.

Override this function to return the current revision of your script if you want to use the built-in updating mechanism.
If an update has been detected, OnVersionUpdate is executed.

voidfunctionForcePageReset()

[DEV SERVER] Loading description...

voidfunctionSetTitleText(stringa_text)

Sets the title text of the control panel.
If the title is not set with this function, it defaults to the name of the current page, or the mod name if no pages are defined.

boolfunctionShowMessage(stringa_message, boola_withCancel=true, stringa_acceptLabel="Accept", stringa_cancelLabel="Cancel")

[DEV SERVER] Loading description...

stringfunctionGetCustomControl(inta_keyCode)

Returns the control mapped to the given keycode.

Override this function to check the given keycode against any custom controls you're using in your config menu. This enables other mods to react to keymap conflicts.

voidfunctionSetInfoText(stringa_text)

Sets the text for the info text field below the option panel.

Context

OnOptionHighlight

voidfunctionSetCursorPosition(inta_position)

[DEV SERVER] Loading description...

voidfunctionSetCursorFillMode(inta_fillMode)

[DEV SERVER] Loading description...

intfunctionAddEmptyOption()

Adds an empty option, which can be used for padding instead of manually re-positioning the cursor.

Context

OnPageReset

intfunctionAddHeaderOption(stringa_text, inta_flags=0)

Adds a header option to group several options together.

Context

OnPageReset

intfunctionAddTextOption(stringa_text, stringa_value, inta_flags=0)

Adds a generic text/value option.

Context

OnPageReset

intfunctionAddToggleOption(stringa_text, boola_checked, inta_flags=0)

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

Context

OnPageReset

intfunctionAddSliderOption(stringa_text, floata_value, stringa_formatString="0}", inta_flags=0)

Adds an option that opens a slider dialog when selected.

Context

OnPageReset

intfunctionAddMenuOption(stringa_text, stringa_value, inta_flags=0)

Adds an option that opens a menu dialog when selected.

Context

OnPageReset

intfunctionAddColorOption(stringa_text, inta_color, inta_flags=0)

Adds an option that opens a color swatch dialog when selected.

Context

OnPageReset

intfunctionAddKeyMapOption(stringa_text, inta_keyCode, inta_flags=0)

Adds a key mapping option.

Context

OnPageReset

intfunctionAddInputOption(stringa_text, stringa_value, inta_flags=0)

Adds an option that opens a text input dialog when selected.

Context

OnPageReset

voidfunctionAddTextOptionST(stringa_stateName, stringa_text, stringa_value, inta_flags=0)

Adds a generic text/value state option.

Context

OnPageReset

voidfunctionAddToggleOptionST(stringa_stateName, stringa_text, boola_checked, inta_flags=0)

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

Context

OnPageReset

voidfunctionAddSliderOptionST(stringa_stateName, stringa_text, floata_value, stringa_formatString="0}", inta_flags=0)

Adds a state option that opens a slider dialog when selected.

Context

OnPageReset

voidfunctionAddMenuOptionST(stringa_stateName, stringa_text, stringa_value, inta_flags=0)

Adds a state option that opens a menu dialog when selected.

Context

OnPageReset

voidfunctionAddColorOptionST(stringa_stateName, stringa_text, inta_color, inta_flags=0)

Adds a state option that opens a color swatch dialog when selected.

Context

OnPageReset

voidfunctionAddKeyMapOptionST(stringa_stateName, stringa_text, inta_keyCode, inta_flags=0)

Adds a key mapping state option.

Context

OnPageReset

voidfunctionAddInputOptionST(stringa_stateName, stringa_text, stringa_value, inta_flags=0)

Adds a state option that opens a text input dialog when selected.

Context

OnPageReset

voidfunctionLoadCustomContent(stringa_source, floata_x=0.0, floata_y=0.0)

[DEV SERVER] Loading description...

voidfunctionUnloadCustomContent()

Clears any custom content and re-enables the original option list.
Has to be called manually after SKI_ConfigBase.LoadCustomContent(...) was used.

Context

OnPageReset

voidfunctionSetOptionFlags(inta_option, inta_flags, boola_noUpdate=false)

[DEV SERVER] Loading description...

voidfunctionSetTextOptionValue(inta_option, stringa_value, boola_noUpdate=false)
voidfunctionSetToggleOptionValue(inta_option, boola_checked, boola_noUpdate=false)
voidfunctionSetSliderOptionValue(inta_option, floata_value, stringa_formatString="0}", boola_noUpdate=false)
voidfunctionSetMenuOptionValue(inta_option, stringa_value, boola_noUpdate=false)
voidfunctionSetColorOptionValue(inta_option, inta_color, boola_noUpdate=false)
voidfunctionSetKeyMapOptionValue(inta_option, inta_keyCode, boola_noUpdate=false)
voidfunctionSetInputOptionValue(inta_option, stringa_value, boola_noUpdate=false)
voidfunctionSetOptionFlagsST(inta_flags, boola_noUpdate=false, stringa_stateName="")

[DEV SERVER] Loading description...

voidfunctionSetTextOptionValueST(stringa_value, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetToggleOptionValueST(boola_checked, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetSliderOptionValueST(floata_value, stringa_formatString="0}", boola_noUpdate=false, stringa_stateName="")
voidfunctionSetMenuOptionValueST(stringa_value, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetColorOptionValueST(inta_color, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetKeyMapOptionValueST(inta_keyCode, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetInputOptionValueST(stringa_value, boola_noUpdate=false, stringa_stateName="")
voidfunctionSetSliderDialogStartValue(floata_value)
voidfunctionSetSliderDialogDefaultValue(floata_value)
voidfunctionSetSliderDialogRange(floata_minValue, floata_maxValue)
voidfunctionSetSliderDialogInterval(floata_value)
voidfunctionSetMenuDialogStartIndex(inta_value)
voidfunctionSetMenuDialogDefaultIndex(inta_value)
voidfunctionSetMenuDialogOptions(string[]a_options)
voidfunctionSetColorDialogStartColor(inta_color)
voidfunctionSetColorDialogDefaultColor(inta_color)
voidfunctionSetInputDialogStartText(stringa_text)
Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.