Background for Starfield

The Message Script

    The Message script is a part of Starfield’s Papyrus scripting ecosystem. It is included with the base game.

    For this script, the Papyrus index knows about:

    • 6 functions


    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

        • intfunctionShow(floatafArg1=0.0, floatafArg2=0.0, floatafArg3=0.0, floatafArg4=0.0, floatafArg5=0.0, floatafArg6=0.0, floatafArg7=0.0, floatafArg8=0.0, floatafArg9=0.0)Native

          Displays the message to the screen, substituting the passed-in numbers into the appropriate spots in the text. If the message is set to display in a message box, the function waits for the user to press a button and returns which button they hit.

        • voidfunctionShowAsHelpMessage(stringasEvent, floatafDuration, floatafInterval, intaiMaxTimes, stringasContext="", intaiPriority=0, MessageGamepadMsg=NONE)Native

          Displays a help message on screen for a specified duration at specified intervals until a specified number of showings occurs or until a user event takes place.

        • voidfunctionUnshowAsHelpMessage()Native

          Ends display of the message as a help message on screen.

        • voidfunctionClearHelpMessages()NativeGlobal

          Hides any currently displayed help messages. Doesn't mark the current message as complete, i.e. the user has seen the message and acted on it.

        • voidfunctionResetHelpMessage(stringasEvent)NativeGlobal

          Resets the status of a help message input event, allowing a message to be displayed for that input event.

        • voidfunctionAttachLoadDoors(ObjectReference[]aDoorRefsToAdd)Native

          Assigns the given array of load doors to each option in the message respectively. References passed must be of type door.

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