UI Script

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)
  • 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

None