Difference between revisions of "UI Script"
added short descriptions
imported>ShadeMe (Create UI Page) |
imported>Qazaaq (added short descriptions) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Incomplete Article}} | |||
'''Extends:''' [[ScriptObject Script]] | '''Extends:''' [[ScriptObject Script]] | ||
Script for the manipulation of scaleform | Script for the manipulation of scaleform user interface. | ||
== Definition == | == Definition == | ||
| Line 14: | Line 11: | ||
== Properties == | == Properties == | ||
None | None | ||
== F4SE Structs == | |||
*Struct [[MenuData Struct - UI|MenuData]] | |||
**A structure that holds information about a menu. | |||
== Global Functions == | == Global Functions == | ||
| Line 19: | Line 20: | ||
== F4SE Global Functions == | == F4SE Global Functions == | ||
*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) | |||
**Registers a custom menu to be opened later. | |||
*bool Function [[IsMenuRegistered - UI|IsMenuRegistered]](string menu) | |||
**Returns whether a custom menu is registered or not. | |||
*bool Function [[OpenMenu - UI|OpenMenu]](string menuName) | |||
**Opens a menu by its name. | |||
*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) | ||
**Returns a variable from AS3 to Papyrus. | **Returns a variable from AS3 to Papyrus. | ||
*var Function [[Invoke - UI|Invoke]](string asMenu, string asPath, var[] avArgs = | *var Function [[Invoke - UI|Invoke]](string asMenu, string asPath, var[] avArgs = none) | ||
**Invoke an AS3 function from Papyrus. | **Invoke an AS3 function from Papyrus. | ||
| Line 31: | Line 47: | ||
**Loads a child swf to the target. | **Loads a child swf to the target. | ||
*bool Function [[Set - UI|Set]](string asMenu, string asSource, string asPath, ScriptObject akReceiver = | *bool Function [[Set - UI|Set]](string asMenu, string asSource, string asPath, ScriptObject akReceiver = none, string asCallback = "") | ||
**Sets a variable in AS3 from Papyrus. | **Sets a variable in AS3 from Papyrus. | ||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:F4SE]] | |||
[[Category:User Interface]] | |||