Difference between revisions of "UI Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(flagged incomplete)
imported>Qazaaq
(added link request for UI members)
Line 11: 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 16: Line 20:


== F4SE Global Functions ==
== F4SE Global Functions ==
*bool Function [[RegisterCustomMenu - UI|RegisterCustomMenu]](string menuName, string menuPath, string rootPath, MenuData mData)
**description
*bool Function [[RegisterBasicCustomMenu - UI|RegisterBasicCustomMenu]](string menuName, string menuPath, string rootPath)
**description
*bool Function [[IsMenuRegistered - UI|IsMenuRegistered]](string menu)
**description
*bool Function [[OpenMenu - UI|OpenMenu]](string menuName)
**description
*bool Function [[CloseMenu - UI|CloseMenu]](string menuName)
**description
*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.
Line 33: Line 52:
== Events ==
== Events ==
None
None


[[Category:Scripting]]
[[Category:Scripting]]

Revision as of 16:11, 26 January 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

Scriptname UI Native Hidden

Properties

None

F4SE Structs

  • Struct MenuData
    • A structure that holds information about a menu.

Global Functions

None

F4SE Global Functions

  • bool Function RegisterCustomMenu(string menuName, string menuPath, string rootPath, MenuData mData)
    • description
  • bool Function OpenMenu(string menuName)
    • description
  • bool Function CloseMenu(string menuName)
    • description
  • 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

None