Background for Fallout 4

The UI Script

    The UI script is a part of Fallout 4’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like Fallout 4 Script Extender (F4SE).

    For this script, the Papyrus index knows about:

    • 10 functions
    • 1 struct


    Inheritance Tree

    No indexed scripts extend this script.

    Structs

    The Papyrus Index is still under construction. Structs have not been implemented yet.

      Properties

      No properties found.

        Events

          No events found.

        Functions

        • boolfunctionIsMenuOpen(stringmenu)NativeGlobal

          Returns true if the given menu is open.

        • boolfunctionIsMenuRegistered(stringmenu)NativeGlobal

          Returns whether a custom menu is registered or not.

        • boolfunctionRegisterBasicCustomMenu(stringmenuName, stringmenuPath, stringrootPath)Global

          Registers a custom menu to be opened later.

        • boolfunctionRegisterCustomMenu(stringmenuName, stringmenuPath, stringrootPath, UI:MenuDatamData)NativeGlobal

          Registers a custom menu to be opened later.

        • boolfunctionOpenMenu(stringmenuName)NativeGlobal

          Opens a menu by its name.

        • boolfunctionCloseMenu(stringmenuName)NativeGlobal

          Closes a menu by its name.

        • boolfunctionSet(stringmenu, stringpath, vararg)NativeGlobal

          Sets a variable in AS3 from Papyrus.

        • varfunctionGet(stringmenu, stringpath)NativeGlobal

          Returns a variable from AS3 to Papyrus.

        • varfunctionInvoke(stringmenu, stringpath, var[]args=NONE)NativeGlobal

          Invoke an AS3 function from Papyrus.

        • boolfunctionLoad(stringmenu, stringsourceVar, stringassetPath, ScriptObjectreceiver=NONE, stringcallback="")NativeGlobal

          Loads a child swf to the target.

        Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.