Difference between revisions of "UI Script"
Jump to navigation
Jump to search
imported>Qazaaq (added link request for UI members) |
imported>Qazaaq (added short descriptions) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
== F4SE Global Functions == | == F4SE Global Functions == | ||
*bool Function [[RegisterCustomMenu - UI|RegisterCustomMenu]](string menuName, string menuPath, string rootPath, MenuData mData) | *bool Function [[RegisterCustomMenu - UI|RegisterCustomMenu]](string menuName, string menuPath, string rootPath, MenuData mData) | ||
** | **Registers a custom menu to be opened later. | ||
*bool Function [[RegisterBasicCustomMenu - UI|RegisterBasicCustomMenu]](string menuName, string menuPath, string rootPath) | *bool Function [[RegisterBasicCustomMenu - UI|RegisterBasicCustomMenu]](string menuName, string menuPath, string rootPath) | ||
** | **Registers a custom menu to be opened later. | ||
*bool Function [[IsMenuRegistered - UI|IsMenuRegistered]](string menu) | *bool Function [[IsMenuRegistered - UI|IsMenuRegistered]](string menu) | ||
** | **Returns whether a custom menu is registered or not. | ||
*bool Function [[OpenMenu - UI|OpenMenu]](string menuName) | *bool Function [[OpenMenu - UI|OpenMenu]](string menuName) | ||
** | **Opens a menu by its name. | ||
*bool Function [[CloseMenu - UI|CloseMenu]](string menuName) | *bool Function [[CloseMenu - UI|CloseMenu]](string menuName) | ||
** | **Closes a menu by its name. | ||
*var Function [[Get - UI|Get]](string asMenu, string asPath) | *var Function [[Get - UI|Get]](string asMenu, string asPath) | ||
| Line 58: | Line 58: | ||
[[Category:Script Objects]] | [[Category:Script Objects]] | ||
[[Category:F4SE]] | [[Category:F4SE]] | ||
[[Category:User Interface]] | |||
Latest revision as of 22:54, 11 February 2018
| This article has been flagged as incomplete. |
| Please help improve the wiki by learning how to contribute. |
Extends: ScriptObject Script
Script for the manipulation of scaleform user interface.
Definition[edit | edit source]
Scriptname UI Native HiddenProperties[edit | edit source]
None
F4SE Structs[edit | edit source]
- Struct MenuData
- A structure that holds information about a menu.
Global Functions[edit | edit source]
None
F4SE Global Functions[edit | edit source]
- bool Function RegisterCustomMenu(string menuName, string menuPath, string rootPath, MenuData mData)
- Registers a custom menu to be opened later.
- bool Function RegisterBasicCustomMenu(string menuName, string menuPath, string rootPath)
- Registers a custom menu to be opened later.
- bool Function IsMenuRegistered(string menu)
- Returns whether a custom menu is registered or not.
- bool Function OpenMenu(string menuName)
- Opens a menu by its name.
- bool Function CloseMenu(string menuName)
- Closes a menu by its name.
- var Function Get(string asMenu, string asPath)
- Returns a variable from AS3 to Papyrus.
- var Function Invoke(string asMenu, string asPath, var[] avArgs = none)
- Invoke an AS3 function from Papyrus.
- bool Function IsMenuOpen(string asMenu)
- Returns true if the given menu is open.
- var Function Load(string asMenu, string asPath)
- Loads a child swf to the target.
- bool Function Set(string asMenu, string asSource, string asPath, ScriptObject akReceiver = none, string asCallback = "")
- Sets a variable in AS3 from Papyrus.
Events[edit | edit source]
None