Difference between revisions of "UI Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Global Functions: Formatting Change)
imported>CraftySentinel
(→‎SKSE Global Functions: Added SKSE 1.7.0 Functions)
 
(3 intermediate revisions by 2 users not shown)
Line 17: Line 17:
== SKSE Global Functions ==
== SKSE Global Functions ==


{|class="wikitable" width =100%
:'''Bool [[IsMenuOpen - UI|IsMenuOpen]](String ''menuName'')'''
!style="text-align:left;"|Function
:*Returns if the menu is currently open.
!style="text-align:left;"|Description
|-
|[[IsMenuOpen - UI|Bool '''IsMenuOpen'''(String ''MenuName'')]]
|Returns if the menu is currently open.
|-


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


|[[SetNumber - UI|'''SetNumber'''(String ''MenuName'', String ''Target'', Float ''Value'')]]
:'''[[SetInt - UI|SetInt]](String ''menuName'', String ''target'', Int ''value'')'''
|Sets numerical value at existing target location.
:*Sets the Integer value at existing target location.
|-


|[[SetString - UI|'''SetString'''(String ''MenuName'', String ''Target'', String ''Value'')]]
:'''[[SetFloat - UI|SetFloat]](String ''menuName'', String ''target'', Float ''value'')'''
|Sets string value at existing target location.
:*Sets the Float value at existing target location.
|-


|[[GetBool - UI|Bool '''GetBool'''(String ''MenuName'', String ''Target'')]]
:'''[[SetNumber - UI|SetNumber]](String ''menuName'', String ''target'', Float ''value'') {DEPRECATED}'''
|Sets bool value at existing target location.
:*Sets numerical value at existing target location.
|-


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


|[[GetString - UI|String '''GetString'''(String ''MenuName'', String ''Target'')]]
:'''Bool [[GetBool - UI|GetBool]](String ''menuName'', String ''target'')'''
|Sets string value at existing target location.
:*Gets bool value at existing target location.
|-


|[[Invoke - UI|'''Invoke'''(String ''MenuName'', String ''Target'')]]
:'''Int [[GetInt - UI|GetInt]](String ''menuName'', String ''target'')'''
|Invokes the ActionScript function at given Target location.
:*Gets the Integer value at existing target location.
|-


|[[InvokeBool - UI|'''InvokeBool'''(String ''MenuName'', String ''Target'', Bool ''Arg'')]]
:'''Float [[GetFloat - UI|GetFloat]](String ''menuName'', String ''target'')'''
|Invokes the bool ActionScript function at given Target location.
:*Gets the Float value at existing target location.
|-


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


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


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


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


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


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


|[[IsTextInputEnabled - UI|Bool '''IsTextInputEnabled'''()]]
:'''[[InvokeNumber - UI|InvokeNumber]](String ''menuName'', String ''target'', Float ''arg'') {DEPRECATED}'''
|Returns if scaleform is in 'text input' mode.
:*Invokes the numerical ActionScript function at given Target location.  
|-


|}
:'''[[InvokeString - UI|InvokeString]](String ''menuName'', String ''target'', String ''arg'')'''
:*Invokes the string ActionScript function at given Target location.
 
:'''[[InvokeBoolA - UI|InvokeBoolA]](String ''menuName'', String ''target'', Bool[] ''arg'')'''
:*Invokes the bool array of ActionScript function at given Target location.
 
:'''[[InvokeIntA - UI|InvokeIntA]](String ''menuName'', String ''target'', Int[] ''arg'')'''
:*Invokes the Integer array of ActionScript function at given Target location.
 
:'''[[InvokeFloatA - UI|InvokeFloatA]](String ''menuName'', String ''target'', Float[] ''arg'')'''
:*Invokes the Float array of ActionScript function at given Target location.
 
:'''[[InvokeNumberA - UI|InvokeNumberA]](String ''menuName'', String ''target'', Float[] ''arg'') {DEPRECATED}'''
:*Invokes the numerical array of ActionScript function at given Target location.
 
:'''[[InvokeStringA - UI|InvokeStringA]](String ''menuName'', String ''target'', String[] ''arg'')'''
:*Invokes the string array of ActionScript function at given Target location.
 
:'''[[InvokeForm - UI|InvokeForm]](String ''menuName'', String ''target'', Form ''arg'')'''
:*Sends Form data to Scaleform as a Flash object, FormLists included.
 
:'''Bool [[IsTextInputEnabled - UI|IsTextInputEnabled]]()'''
:*Returns if scaleform is in 'text input' mode.
 
:'''[[OpenCustomMenu - UI|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 - UI|CloseCustomMenu]]()'''
:*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"