UI Script

From the CreationKit Wiki
Revision as of 04:32, 4 October 2012 by imported>JustinOther (SKSE minimum version noted)
Jump to navigation Jump to search


Minimum required SKSE Version: 1.06.00

Menu related functions. (Requires SKSE)

Definition

ScriptName UI Hidden

Properties

None

SKSE Global Functions

Bool Function IsMenuOpen(String MenuName)

  • Returns if the menu is currently open.

Function SetBool(String MenuName, String Target, Bool Value)

  • Sets bool value at existing target location.

Function SetNumber(String MenuName, String Target, Float Value)

  • Sets numerical value at existing target location.

Function SetString(String MenuName, String Target, String Value)

  • Sets string value at existing target location.

Bool Function GetBool(String MenuName, String Target)

  • Sets bool value at existing target location.

Float Function GetNumber(String MenuName, String Target)

  • Sets numerical value at existing target location.

String Function GetString(String MenuName, String Target)

  • Sets string value at existing target location.

Function Invoke(String MenuName, String Target)

  • Invokes the ActionScript function at given Target location.

Function InvokeBool(String MenuName, String Target, Bool Arg)

  • Invokes the bool ActionScript function at given Target location.

Function InvokeNumber(String MenuName, String Target, Float Arg)

  • Invokes the numerical ActionScript function at given Target location.

Function InvokeString(String MenuName, String Target, String Arg)

  • Invokes the string ActionScript function at given Target location.

Function InvokeBoolA(String MenuName, String Target, Bool[] Arg)

  • Invokes the bool array of ActionScript function at given Target location.

Function InvokeNumberA(String MenuName, String Target, Float[] Arg)

  • Invokes the numerical array of ActionScript function at given Target location.

Function InvokeStringA(String MenuName, String Target, String[] Arg)

  • Invokes the string array of ActionScript function at given Target location.

Function InvokeForm(String MenuName, String Target, Form Arg)

  • Sends Form data to Scaleform as a Flash object, FormLists included.

Bool Function IsTextInputEnabled()

  • Returns if scaleform is in 'text input' mode.

Member Functions

None

Events

None

Valid Menu Names

  • BarterMenu
  • Book Menu
  • Console
  • Console Native UI Menu
  • ContainerMenu
  • Crafting Menu
  • Credits Menu
  • Cursor Menu
  • Debug Text Menu
  • Dialogue Menu
  • Fader Menu
  • FavoritesMenu
  • GiftMenu
  • HUD Menu
  • InventoryMenu
  • Journal Menu
  • Kinect Menu
  • LevelUp Menu
  • Loading Menu
  • Lockpicking Menu
  • MagicMenu
  • Main Menu
  • MapMenu
  • MessageBoxMenu
  • Mist Menu
  • Overlay Interaction Menu
  • Overlay Menu
  • Quantity Menu
  • RaceSex Menu
  • Sleep/Wait Menu
  • StatsMenu
  • TitleSequence Menu
  • Top Menu
  • Training Menu
  • Tutorial Menu
  • TweenMenu

Notes

  • The Target parameter requires one the following prefixes
  • For the default namespace: _Global
  • For the movie root: _root