Difference between revisions of "UI Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
(Initial page creation)
 
imported>CraftySentinel
(→‎SKSE Global Functions: Added SKSE 1.7.0 Functions)
 
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
[[Category:SKSE]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
[[Category:SKSE Script Objects]]
{{SKSEFunction|1.06.00}}


Menu related functions. (Requires SKSE)
Menu related functions. (Requires SKSE)
Line 14: 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)'''
:'''Bool [[IsMenuOpen - UI|IsMenuOpen]](String ''menuName'')'''
*Sets bool value at existing target location.
:*Returns if the menu is currently open.
 
:'''[[SetBool - UI|SetBool]](String ''menuName'', String ''target'', Bool ''value'')'''
:*Sets bool value at existing target location.
 
:'''[[SetInt - UI|SetInt]](String ''menuName'', String ''target'', Int ''value'')'''
:*Sets the Integer value at existing target location.
 
:'''[[SetFloat - UI|SetFloat]](String ''menuName'', String ''target'', Float ''value'')'''
:*Sets the Float value at existing target location.
 
:'''[[SetNumber - UI|SetNumber]](String ''menuName'', String ''target'', Float ''value'') {DEPRECATED}'''
:*Sets numerical value at existing target location.
 
:'''[[SetString - UI|SetString]](String ''menuName'', String ''target'', String ''value'')'''
:*Sets string value at existing target location.
 
:'''Bool [[GetBool - UI|GetBool]](String ''menuName'', String ''target'')'''
:*Gets bool value at existing target location.
 
:'''Int [[GetInt - UI|GetInt]](String ''menuName'', String ''target'')'''
:*Gets the Integer value at existing target location.
 
:'''Float [[GetFloat - UI|GetFloat]](String ''menuName'', String ''target'')'''
:*Gets the Float value at existing target location.
 
:'''Float [[GetNumber - UI|GetNumber]](String ''menuName'', String ''target'') {DEPRECATED}'''
:*Gets numerical value at existing target location.
 
:'''String [[GetString - UI|GetString]](String ''menuName'', String ''target'')'''
:*Gets string value at existing target location.
 
:'''[[Invoke - UI|Invoke]](String ''menuName'', String ''target'')'''
:*Invokes the ActionScript function at given Target location.


'''Function [[SetNumber - UI|SetNumber]](String MenuName, String Target, Float Value)'''
:'''[[InvokeBool - UI|InvokeBool]](String ''menuName'', String ''target'', Bool ''arg'')'''
*Sets numerical value at existing target location.
:*Invokes the bool ActionScript function at given Target location.


'''Function [[SetString - UI|SetString]](String MenuName, String Target, String Value)'''
:'''[[InvokeInt - UI|InvokeInt]](String ''menuName'', String ''target'', Int ''arg'')'''
*Sets string value at existing target location.
:*Invokes the Integer ActionScript function at given Target location.  


'''Bool Function [[GetBool - UI|GetBool]](String MenuName, String Target)'''
:'''[[InvokeFloat- UI|InvokeFloat(]]String ''menuName'', String ''target'', Float ''arg'')'''
*Sets bool value at existing target location.
:*Invokes the Float ActionScript function at given Target location.  


'''Float Function [[GetNumber - UI|GetNumber]](String MenuName, String Target)'''
:'''[[InvokeNumber - UI|InvokeNumber]](String ''menuName'', String ''target'', Float ''arg'') {DEPRECATED}'''
*Sets numerical value at existing target location.
:*Invokes the numerical ActionScript function at given Target location.  


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


'''Function [[Invoke - UI|Invoke]](String MenuName, String Target)'''
:'''[[InvokeBoolA - UI|InvokeBoolA]](String ''menuName'', String ''target'', Bool[] ''arg'')'''
*Invokes the ActionScript function at given Target location.
:*Invokes the bool array of ActionScript function at given Target location.


'''Function [[InvokeBool - UI|InvokeBool]](String MenuName, String Target, Bool Arg)'''
:'''[[InvokeIntA - UI|InvokeIntA]](String ''menuName'', String ''target'', Int[] ''arg'')'''
*Invokes the bool ActionScript function at given Target location.
:*Invokes the Integer array of ActionScript function at given Target location.


'''Function [[InvokeNumber - UI|InvokeNumber]](String MenuName, String Target, Float Arg)'''
:'''[[InvokeFloatA - UI|InvokeFloatA]](String ''menuName'', String ''target'', Float[] ''arg'')'''
*Invokes the numerical ActionScript function at given Target location.
:*Invokes the Float array of ActionScript function at given Target location.


'''Function [[InvokeString - UI|InvokeString]](String MenuName, String Target, String Arg)'''
:'''[[InvokeNumberA - UI|InvokeNumberA]](String ''menuName'', String ''target'', Float[] ''arg'') {DEPRECATED}'''
*Invokes the string ActionScript function at given Target location.
:*Invokes the numerical array of ActionScript function at given Target location.


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


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


'''Function [[InvokeStringA - UI|InvokeStringA]](String MenuName, String Target, String[] Arg)'''
:'''Bool [[IsTextInputEnabled - UI|IsTextInputEnabled]]()'''
*Invokes the string array of ActionScript function at given Target location.
:*Returns if scaleform is in 'text input' mode.


'''Function [[InvokeForm - UI|InvokeForm]](String MenuName, String Target, Form Arg)'''
:'''[[OpenCustomMenu - UI|OpenCustomMenu]](String ''swfPath'', Int ''flag'')'''
*Sends Form data to Scaleform as a Flash object, FormLists included.
:*Open a Custom menu named "CustomMenu" by loading the given swf from the interface folder(file name without extension).


'''Bool Function [[IsTextInputEnabled - UI|IsTextInputEnabled]]()'''
:'''[[CloseCustomMenu - UI|CloseCustomMenu]]()'''
*Returns if scaleform is in 'text input' mode.
:*Closes the custom menu if it's currently open


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

Latest revision as of 02:34, 3 February 2014


Minimum required SKSE Version: 1.06.00

Menu related functions. (Requires SKSE)

Definition[edit | edit source]

ScriptName UI Hidden

Properties[edit | edit source]

None

SKSE Global Functions[edit | edit source]

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.
SetInt(String menuName, String target, Int value)
  • Sets the Integer value at existing target location.
SetFloat(String menuName, String target, Float value)
  • Sets the Float value at existing target location.
SetNumber(String menuName, String target, Float value) {DEPRECATED}
  • 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)
  • Gets bool value at existing target location.
Int GetInt(String menuName, String target)
  • Gets the Integer value at existing target location.
Float GetFloat(String menuName, String target)
  • Gets the Float value at existing target location.
Float GetNumber(String menuName, String target) {DEPRECATED}
  • Gets numerical value at existing target location.
String GetString(String menuName, String target)
  • Gets 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.
InvokeInt(String menuName, String target, Int arg)
  • Invokes the Integer ActionScript function at given Target location.
InvokeFloat(String menuName, String target, Float arg)
  • Invokes the Float ActionScript function at given Target location.
InvokeNumber(String menuName, String target, Float arg) {DEPRECATED}
  • 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.
InvokeIntA(String menuName, String target, Int[] arg)
  • Invokes the Integer array of ActionScript function at given Target location.
InvokeFloatA(String menuName, String target, Float[] arg)
  • Invokes the Float array of ActionScript function at given Target location.
InvokeNumberA(String menuName, String target, Float[] arg) {DEPRECATED}
  • 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.
OpenCustomMenu(String swfPath, Int flag)
  • Open a Custom menu named "CustomMenu" by loading the given swf from the interface folder(file name without extension).
CloseCustomMenu()
  • Closes the custom menu if it's currently open

Member Functions[edit | edit source]

None

Events[edit | edit source]

None

Valid Menu Names[edit | edit source]

  • 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[edit | edit source]

  • 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=17322"