Difference between revisions of "UI Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
m (SKSE minimum version noted)
imported>CraftySentinel
m (→‎SKSE Global Functions: Formatting Change)
Line 16: Line 16:


== SKSE Global Functions ==
== SKSE Global Functions ==
'''Bool Function [[IsMenuOpen - UI|IsMenuOpen]](String MenuName)'''
*Returns if the menu is currently open.


'''Function [[SetBool - UI|SetBool]](String MenuName, String Target, Bool Value)'''
{|class="wikitable" width =100%
*Sets bool value at existing target location.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[IsMenuOpen - UI|Bool '''IsMenuOpen'''(String ''MenuName'')]]
|Returns if the menu is currently open.
|-


'''Function [[SetNumber - UI|SetNumber]](String MenuName, String Target, Float Value)'''
|[[SetBool - UI|'''SetBool'''(String ''MenuName'', String ''Target'', Bool ''Value'')]]
*Sets numerical value at existing target location.
|Sets bool value at existing target location.
|-


'''Function [[SetString - UI|SetString]](String MenuName, String Target, String Value)'''
|[[SetNumber - UI|'''SetNumber'''(String ''MenuName'', String ''Target'', Float ''Value'')]]
*Sets string value at existing target location.
|Sets numerical value at existing target location.
|-


'''Bool Function [[GetBool - UI|GetBool]](String MenuName, String Target)'''
|[[SetString - UI|'''SetString'''(String ''MenuName'', String ''Target'', String ''Value'')]]
*Sets bool value at existing target location.
|Sets string value at existing target location.
|-


'''Float Function [[GetNumber - UI|GetNumber]](String MenuName, String Target)'''
|[[GetBool - UI|Bool '''GetBool'''(String ''MenuName'', String ''Target'')]]
*Sets numerical value at existing target location.
|Sets bool value at existing target location.
|-


'''String Function [[GetString - UI|GetString]](String MenuName, String Target)'''
|[[GetNumber - UI|Float '''GetNumber'''(String ''MenuName'', String ''Target'')]]
*Sets string value at existing target location.
|Sets numerical value at existing target location.
|-


'''Function [[Invoke - UI|Invoke]](String MenuName, String Target)'''
|[[GetString - UI|String '''GetString'''(String ''MenuName'', String ''Target'')]]
*Invokes the ActionScript function at given Target location.
|Sets string value at existing target location.
|-


'''Function [[InvokeBool - UI|InvokeBool]](String MenuName, String Target, Bool Arg)'''
|[[Invoke - UI|'''Invoke'''(String ''MenuName'', String ''Target'')]]
*Invokes the bool ActionScript function at given Target location.
|Invokes the ActionScript function at given Target location.
|-


'''Function [[InvokeNumber - UI|InvokeNumber]](String MenuName, String Target, Float Arg)'''
|[[InvokeBool - UI|'''InvokeBool'''(String ''MenuName'', String ''Target'', Bool ''Arg'')]]
*Invokes the numerical ActionScript function at given Target location.
|Invokes the bool ActionScript function at given Target location.
|-


'''Function [[InvokeString - UI|InvokeString]](String MenuName, String Target, String Arg)'''
|[[InvokeNumber - UI|'''InvokeNumber'''(String ''MenuName'', String ''Target'', Float ''Arg'')]]
*Invokes the string ActionScript function at given Target location.
|Invokes the numerical ActionScript function at given Target location.
|-


'''Function [[InvokeBoolA - UI|InvokeBoolA]](String MenuName, String Target, Bool[] Arg)'''
|[[InvokeString - UI|'''InvokeString'''(String ''MenuName'', String ''Target'', String ''Arg'')]]
*Invokes the bool array of ActionScript function at given Target location.
|Invokes the string ActionScript function at given Target location.
|-


'''Function [[InvokeNumberA - UI|InvokeNumberA]](String MenuName, String Target, Float[] Arg)'''
|[[InvokeBoolA - UI|'''InvokeBoolA'''(String ''MenuName'', String ''Target'', Bool[] ''Arg'')]]
*Invokes the numerical array of ActionScript function at given Target location.
|Invokes the bool array of ActionScript function at given Target location.
|-


'''Function [[InvokeStringA - UI|InvokeStringA]](String MenuName, String Target, String[] Arg)'''
|[[InvokeNumberA - UI|'''InvokeNumberA'''(String ''MenuName'', String ''Target'', Float[] ''Arg'')]]
*Invokes the string array of ActionScript function at given Target location.
|Invokes the numerical array of ActionScript function at given Target location.
|-


'''Function [[InvokeForm - UI|InvokeForm]](String MenuName, String Target, Form Arg)'''
|[[InvokeStringA - UI|'''InvokeStringA'''(String ''MenuName'', String ''Target'', String[] ''Arg'')]]
*Sends Form data to Scaleform as a Flash object, FormLists included.
|Invokes the string array of ActionScript function at given Target location.
|-


'''Bool Function [[IsTextInputEnabled - UI|IsTextInputEnabled]]()'''
|[[InvokeForm - UI|'''InvokeForm'''(String ''MenuName'', String ''Target'', Form ''Arg'')]]
*Returns if scaleform is in 'text input' mode.
|Sends Form data to Scaleform as a Flash object, FormLists included.
|-
 
|[[IsTextInputEnabled - UI|Bool '''IsTextInputEnabled'''()]]
|Returns if scaleform is in 'text input' mode.
|-
 
|}


== Member Functions ==
== Member Functions ==

Revision as of 05:40, 24 October 2013


Minimum required SKSE Version: 1.06.00

Menu related functions. (Requires SKSE)

Definition

ScriptName UI Hidden

Properties

None

SKSE Global Functions

Function Description
Bool IsMenuOpen(String MenuName) Returns if the menu is currently open.
SetBool(String MenuName, String Target, Bool Value) Sets bool value at existing target location.
SetNumber(String MenuName, String Target, Float Value) Sets numerical value at existing target location.
SetString(String MenuName, String Target, String Value) Sets string value at existing target location.
Bool GetBool(String MenuName, String Target) Sets bool value at existing target location.
Float GetNumber(String MenuName, String Target) Sets numerical value at existing target location.
String GetString(String MenuName, String Target) Sets string value at existing target location.
Invoke(String MenuName, String Target) Invokes the ActionScript function at given Target location.
InvokeBool(String MenuName, String Target, Bool Arg) Invokes the bool ActionScript function at given Target location.
InvokeNumber(String MenuName, String Target, Float Arg) Invokes the numerical ActionScript function at given Target location.
InvokeString(String MenuName, String Target, String Arg) Invokes the string ActionScript function at given Target location.
InvokeBoolA(String MenuName, String Target, Bool[] Arg) Invokes the bool array of ActionScript function at given Target location.
InvokeNumberA(String MenuName, String Target, Float[] Arg) Invokes the numerical array of ActionScript function at given Target location.
InvokeStringA(String MenuName, String Target, String[] Arg) Invokes the string array of ActionScript function at given Target location.
InvokeForm(String MenuName, String Target, Form Arg) Sends Form data to Scaleform as a Flash object, FormLists included.
Bool 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
Retrieved from "https://ck.uesp.net/w/index.php?title=UI_Script&oldid=17318"