Difference between revisions of "UI Script"
Jump to navigation
Jump to search
imported>CraftySentinel m (→SKSE Global Functions: Added SKSE Global Functions, also labelled Number functions as Depreciated) |
imported>Snakster |
||
| Line 37: | Line 37: | ||
|- | |- | ||
|[[SetNumber - UI|'''SetNumber'''(String ''menuName'', String ''target'', Float ''value'')]] '''( | |[[SetNumber - UI|'''SetNumber'''(String ''menuName'', String ''target'', Float ''value'')]] '''(DEPRECATED)''' | ||
|Sets numerical value at existing target location. | |Sets numerical value at existing target location. | ||
|- | |- | ||
| Line 57: | Line 57: | ||
|- | |- | ||
|[[GetNumber - UI|Float '''GetNumber'''(String ''menuName'', String ''target'')]] '''( | |[[GetNumber - UI|Float '''GetNumber'''(String ''menuName'', String ''target'')]] '''(DEPRECATED)''' | ||
|Gets numerical value at existing target location. | |Gets numerical value at existing target location. | ||
|- | |- | ||
| Line 81: | Line 81: | ||
|- | |- | ||
|[[InvokeNumber - UI|'''InvokeNumber'''(String ''menuName'', String ''target'', Float ''arg'')]] '''( | |[[InvokeNumber - UI|'''InvokeNumber'''(String ''menuName'', String ''target'', Float ''arg'')]] '''(DEPRECATED)''' | ||
|Invokes the numerical ActionScript function at given Target location. | |Invokes the numerical ActionScript function at given Target location. | ||
|- | |- | ||
| Line 101: | Line 101: | ||
|- | |- | ||
|[[InvokeNumberA - UI|'''InvokeNumberA'''(String ''menuName'', String ''target'', Float[] ''arg'')]] '''( | |[[InvokeNumberA - UI|'''InvokeNumberA'''(String ''menuName'', String ''target'', Float[] ''arg'')]] '''(DEPRECATED)''' | ||
|Invokes the numerical array of ActionScript function at given Target location. | |Invokes the numerical array of ActionScript function at given Target location. | ||
|- | |- | ||
Revision as of 15:53, 24 November 2013
Minimum required SKSE Version: 1.06.00
Menu related functions. (Requires SKSE)
Definition
ScriptName UI HiddenProperties
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. |
| 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. |
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