The SKI_ConfigBase script is a part of Skyrim SE’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like MCM Helper (MCM Helper).
For this script, the Papyrus index knows about:
- 30 events
- 52 functions
- 9 properties
Inheritance Tree
| Script | Extended 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
- Found in:
- MCM Helper
- SkyUI
eventOnConfigInit()Called when this config menu is initialized
- Found in:
- MCM Helper
- SkyUI
eventOnConfigOpen()Called when this config menu is opened
- Found in:
- MCM Helper
- SkyUI
eventOnConfigClose()Called when this config menu is closed
- Found in:
- MCM Helper
- SkyUI
eventOnVersionUpdate(intaVersion)Called when aVersion update of this script has been detected
- Found in:
- SkyUI
eventOnConfigRegister()Called when this config menu registered at the control panel
- Found in:
- SkyUI
eventOnPageReset(stringa_page)Called when a new page is selected, including the initial empty page.
Position the cursor and add options to the current page. Each added option is assigned a unique option ID.
- Found in:
- SkyUI
eventOnOptionHighlight(inta_option)Called when highlighting an option.
Use SKI_ConfigBase.SetInfoText(...) to show information about the currently highlighted option.
- Found in:
- SkyUI
eventOnOptionSelect(inta_option)Called when a non-interactive option has been selected.
Modify the internal state of the selected option then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnOptionDefault(inta_option)Called when resetting an option to its default value.
Reset any internal state of the selected option to its default value, then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnOptionSliderOpen(inta_option)Called when a slider option has been selected.
Set the slider parameters for the selected option.
- Found in:
- SkyUI
eventOnOptionSliderAccept(inta_option, floata_value)Called when a new slider value has been accepted.
Modify the internal state of the selcted option, then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnOptionMenuOpen(inta_option)Called when a menu option has been selected.
Set the menu parameters for the selected option.
- Found in:
- SkyUI
eventOnOptionMenuAccept(inta_option, inta_index)Called when a menu entry has been accepted.
Modify the internal state of the selected option, then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnOptionColorOpen(inta_option)Called when a color option has been selected.
Set the color swatch parameters for the selected option.
- Found in:
- SkyUI
eventOnOptionColorAccept(inta_option, inta_color)Called when a new color has been accepted.
Modify the internal state of the selected option, then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnOptionKeyMapChange(inta_option, inta_keyCode, stringa_conflictControl, stringa_conflictName)Called when a key has been remapped.
Modify the internal state of the selected option, then use the option setters to apply the changes to the active page.
It's up to you to react to any conflicts by checkingconflictControlandconflictName.- Found in:
- SkyUI
eventOnOptionInputOpen(inta_option)Called when a color option has been selected.
Since version 4.
Set the input dialog parameters for the selected option.
- Found in:
- SkyUI
eventOnOptionInputAccept(inta_option, stringa_input)Called when a new input has been accepted.
Since version 4.
Modify the internal state of the selected option, then use the option setters to apply the changes to the active page.
- Found in:
- SkyUI
eventOnHighlightST()Called when highlighting a state option
- Found in:
- SkyUI
eventOnSelectST()Called when a non-interactive state option has been selected
- Found in:
- SkyUI
eventOnDefaultST()Called when resetting a state option to its default value
- Found in:
- SkyUI
eventOnSliderOpenST()Called when a slider state option has been selected
- Found in:
- SkyUI
eventOnSliderAcceptST(floata_value)Called when a new slider state value has been accepted
- Found in:
- SkyUI
eventOnMenuOpenST()Called when a menu state option has been selected
- Found in:
- SkyUI
eventOnMenuAcceptST(inta_index)Called when a menu entry has been accepted for this state option
- Found in:
- SkyUI
eventOnColorOpenST()Called when a color state option has been selected
- Found in:
- SkyUI
eventOnColorAcceptST(inta_color)Called when a new color has been accepted for this state option
- Found in:
- SkyUI
eventOnKeyMapChangeST(inta_keyCode, stringa_conflictControl, stringa_conflictName)Called when a key has been remapped for this state option
- Found in:
- SkyUI
eventOnInputOpenST()Called when a text input state option has been selected
- Found in:
- SkyUI
eventOnInputAcceptST(stringa_input)Called when a new text input has been accepted for this state option
Functions
- Found in:
- MCM Helper
- SkyUI
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.- Found in:
- MCM Helper
- SkyUI
Forces OnPageReset to be executed again after the current event has completed.
Context
OnOptionSelect, OnOptionSliderAccept, OnOptionMenuAccept, OnOptionColorAccept, OnOptionKeyMapChange, OnOptionDefault
- Found in:
- MCM Helper
- SkyUI
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.- Found in:
- MCM Helper
- SkyUI
boolfunctionShowMessage(stringa_message, boola_withCancel=true, stringa_acceptLabel="Accept", stringa_cancelLabel="Cancel")Shows a message dialog.
This function works similar to
Message.Show, so it will pause the script and wait until the user closed the dialog. The return value indicates whether the dialog was accepted or canceled.Context
OnOptionSelect, OnOptionSliderAccept, OnOptionMenuAccept, OnOptionColorAccept, OnOptionKeyMapChange, OnOptionDefault
- Found in:
- SkyUI
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.
- Found in:
- SkyUI
- Found in:
- SkyUI
Sets the position of the cursor used for the option setters.
The options are displayed in a grid with 2 columns and 64 rows, with a total of 128 cells. They are indexed 0 to 127, left-to-right, top-to-bottom.
Default cursor position is 0 (top-left).Context
- Found in:
- SkyUI
Sets the fill direction of the cursor used for the option setters.
Accepted values areLEFT_TO_RIGHTandTOP_TO_BOTTOM.
ForLEFT_TO_RIGHT, the fill order is n, n+1, n+2, ..., i.e. fill up the current row, then move to the next one.
ForTOP_TO_BOTTOM, the fill order is n, n+2, n+4, ..., i.e. fill the next entry in the current column.Context
- Found in:
- SkyUI
Adds an empty option, which can be used for padding instead of manually re-positioning the cursor.
Context
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
voidfunctionAddSliderOptionST(stringa_stateName, stringa_text, floata_value, stringa_formatString="0}", inta_flags=0)- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
- Found in:
- SkyUI
Loads an external file.
Once custom content has been loaded, it's shown in the option panel and the option list is hidden.
To clear the custom content and show the option list again, use SKI_ConfigBase.UnloadCustomContent().Context
- Found in:
- SkyUI
Clears any custom content and re-enables the original option list.
Has to be called manually after SKI_ConfigBase.LoadCustomContent(...) was used.Context
- Found in:
- SkyUI
Sets the option flags.
Accepted flags are
OPTION_FLAG_NONE, to clear the flags;OPTION_FLAG_DISABLED, to grey out and disable the option.OPTION_FLAG_HIDDEN, to hide an option. It'll behave like an empty option.OPTION_FLAG_WITH_UNMAP, to enable the unmap button for keymap options.
Context
OnOptionSelect, OnOptionSliderAccept, OnOptionMenuAccept, OnOptionColorAccept, OnOptionKeyMapChange, OnOptionDefault
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
voidfunctionSetSliderOptionValue(inta_option, floata_value, stringa_formatString="0}", boola_noUpdate=false)Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Sets the option flags of a state option.
Context
OnSelectST, OnSliderAcceptST, OnMenuAcceptST, OnColorAcceptST, OnKeyMapChangeST, OnDefaultST
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
voidfunctionSetSliderOptionValueST(floata_value, stringa_formatString="0}", boola_noUpdate=false, stringa_stateName="")Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context
- Found in:
- SkyUI
Context