Background for Skyrim SE

UI


Inheritance Tree

No indexed scripts extend this script.

Properties
Events
Functions
boolfunctionIsMenuOpen(stringmenuName)NativeGlobal

Returns if the menu is currently open.

voidfunctionSetBool(stringmenuName, stringtarget, boolvalue)NativeGlobal

Sets bool/number/string value at target location.
Target value must already exist.

Examples:
UI.SetBool("InventoryMenu", "_root.Menu_mc._visible", false)
UI.SetString("FavoritesMenu", "_root.Menu_mc.panel.message.text", "My Text")

voidfunctionSetInt(stringmenuName, stringtarget, intvalue)NativeGlobal
voidfunctionSetFloat(stringmenuName, stringtarget, floatvalue)NativeGlobal
voidfunctionSetString(stringmenuName, stringtarget, stringvalue)NativeGlobal
voidfunctionSetNumber(stringmenuName, stringtarget, floatvalue)Global

DEPRECIATED

boolfunctionGetBool(stringmenuName, stringtarget)NativeGlobal

Gets bool/number/string from target location, or false/0/none if the value doesn't exist.

Examples:
bool visible = UI.GetBool("Inventory Menu", "_root.Menu_mc._visible")
float height = UI.GetNumber("Magic Menu", "_root.Menu_mc._height")

intfunctionGetInt(stringmenuName, stringtarget)NativeGlobal
floatfunctionGetFloat(stringmenuName, stringtarget)NativeGlobal
stringfunctionGetString(stringmenuName, stringtarget)NativeGlobal
floatfunctionGetNumber(stringmenuName, stringtarget)Global

DEPRECIATED

voidfunctionInvoke(stringmenuName, stringtarget)Global

Invokes the ActionScript function at given target location.

Examples:
UI.InvokeString("InventoryMenu", "_global.skse.Log", "Printed to logfile")
UI.InvokeStringA("InventoryMenu", "_global.myFunction", myArray)

voidfunctionInvokeBool(stringmenuName, stringtarget, boolarg)NativeGlobal
voidfunctionInvokeInt(stringmenuName, stringtarget, intarg)NativeGlobal
voidfunctionInvokeFloat(stringmenuName, stringtarget, floatarg)NativeGlobal
voidfunctionInvokeString(stringmenuName, stringtarget, stringarg)NativeGlobal
voidfunctionInvokeNumber(stringmenuName, stringtarget, floatarg)Global

DEPRECIATED

voidfunctionInvokeBoolA(stringmenuName, stringtarget, bool[]args)NativeGlobal
voidfunctionInvokeIntA(stringmenuName, stringtarget, int[]args)NativeGlobal
voidfunctionInvokeFloatA(stringmenuName, stringtarget, float[]args)NativeGlobal
voidfunctionInvokeStringA(stringmenuName, stringtarget, string[]args)NativeGlobal
voidfunctionInvokeNumberA(stringmenuName, stringtarget, float[]args)Global

DEPRECIATED

voidfunctionInvokeForm(stringmenuName, stringtarget, Formarg)NativeGlobal

Sends an object to target location in Flash in the form of:

{
   "formId" : xxxx,
   "formType"": xx
}

Both are integer values.

boolfunctionIsTextInputEnabled()NativeGlobal

returns if scaleform is in 'text input' mode
this is useful for ignoring keys that should get swallowed by an editable text box

voidfunctionOpenCustomMenu(stringswfPath, intflags=0)NativeGlobal

open a custom menu named "CustomMenu" by loading the given swf from the interface folder
(filename without extension)
there can only be a single custom menu open at the same time

voidfunctionCloseCustomMenu()NativeGlobal

close the custom menu if it's currently open.

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