Background for Starfield

The Debug Script

    The Debug 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:

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

        • voidfunctionAutomatedTestLogDebug(stringasMessage)NativeGlobal

          Logs a debug message to the automated testing logger

        • voidfunctionAutomatedTestLogError(stringasMessage)NativeGlobal

          Logs an error message to the automated testing logger

        • voidfunctionAutomatedTestLogProgress(stringasMessage)NativeGlobal

          Logs a test progress message to the automated testing logger

        • voidfunctionCenterOnCell(stringasCellname)NativeGlobal

          Teleports the player to the specified cell. (Same as the CenterOnCell console command)

        • floatfunctionCenterOnCellAndWait(stringasCellname)NativeGlobal

          Teleports the player to the specified cell and does not return until they arrive.

        • floatfunctionPlayerMoveToAndWait(stringasDestRef)NativeGlobal

          Teleports the player to the specified reference and does not return until they arrive.

        • voidfunctionCloseUserLog(stringasLogName)NativeGlobal

          Closes the specified user log. If the log isn't open, it doesn't do anything. A subsequent call to Debug.OpenUserLog(...) will cycle the logs on disk (so log 0 becomes 1, 1 becomes 2, etc).

        • voidfunctionDumpAliasData(QuestakQuest)NativeGlobal

          Dumps all alias fill information on the specified quest to the alias dump file. The dump files are stored in "<game folder>/Logs/Script/AliasDump".

        • voidfunctionDumpEventRegistrations(ScriptObjectakScript)NativeGlobal

          Dumps all events the specified script is registered for to the script log.

        • voidfunctionEnableAI(boolabEnable=true)NativeGlobal

          Enables/disables AI processing in the game.

        • voidfunctionEnableCollisions(boolabEnable=true)NativeGlobal

          Enables/disables collisions in the game

        • voidfunctionEnableDetection(boolabEnable=true)NativeGlobal

          Enables/disables AI detection in the game.

        • voidfunctionEnableMenus(boolabEnable=true)NativeGlobal

          Enables/disables menu rendering in the game.

        • voidfunctionExecuteConsole(stringaCommand)NativeGlobal

          Execute the specified console command

        • stringfunctionGetConfigName()NativeGlobal

          Obtains the game's build configuration.

        • stringfunctionGetPlatformName()NativeGlobal

          Obtains the game's platform name.

        • stringfunctionGetVersionNumber()NativeGlobal

          Obtains the game's version number.

        • voidfunctionMessageBox(stringasMessageBoxText)NativeGlobal

          Displays a single-button OK message box containing the specified text.

        • voidfunctionNotification(stringasNotificationText)NativeGlobal

          Displays a notification in the top-left corner of the screen.

        • boolfunctionOpenUserLog(stringasLogName)NativeGlobal

          Opens a new user log on disk.

        • voidfunctionQuitGame()NativeGlobal

          Immediately exits the game.

        • voidfunctionSetGodMode(boolabGodMode)NativeGlobal

          Turns god mode on and off in the game.

        • voidfunctionStartScriptProfiling(stringasScriptName)NativeGlobal

          Starts profiling a single Papyrus script. Child and parent scripts are not profiled.

        • voidfunctionStartStackProfiling()NativeGlobal

          Starts profiling a single Papyrus stack until stopped or until the last function exits.

        • voidfunctionStartStackRootProfiling(stringasScriptName, ScriptObjectakObj=NONE)NativeGlobal

          Starts profiling all stacks that start in the specified script (and optionally object). Calls into said script from outside scripts are NOT profiled.

        • voidfunctionStopScriptProfiling(stringasScriptName)NativeGlobal

          Stops profiling a single Papyrus script. Child and parent scripts are not affected. If the script is not being profiled nothing will change.

        • voidfunctionStopStackProfiling()NativeGlobal

          Stops profiling a single Papyrus stack.

        • voidfunctionStopStackRootProfiling(stringasScriptName, ScriptObjectakObj=NONE)NativeGlobal

          Stops profiling all stacks that start in the specified script (and optionally object).

        • voidfunctionTrace(stringasTextToPrint, intaiSeverity=0)NativeGlobal

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay.

        • voidfunctionTraceFunction(stringasTextToPrint="racing function on request", intaiSeverity=0)NativeGlobal

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay. It also attaches all available information about the function that called in, including the current value of all of the function's variables and parameters.

        • voidfunctionTraceStack(stringasTextToPrint="racing stack on request", intaiSeverity=0)NativeGlobal

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay. It also attaches a full callstack so you can see who called you (and who called them and so on).

        • boolfunctionTraceUser(stringasUserLog, stringasTextToPrint, intaiSeverity=0)NativeGlobal

          Outputs a string to the specified user log on disk, and the Papyrus overlay. Returns true if the text was successfully output to the log.

        • voidfunctionTraceConditionalGlobal(stringTextToPrint, GlobalVariableShowTrace)Global

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay. But only if the global is true.

        • voidfunctionTraceConditional(stringTextToPrint, boolShowTrace, intSeverity=0)Global

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay. But only if the condition is true.

        • voidfunctionTraceAndBox(stringasTextToPrint, intaiSeverity=0)Global

          Outputs a string to the Papyrus log on disk, the Papyrus overlay, and pops up a message box with the same text.

        • voidfunctionTraceSelf(ScriptObjectCallingScript, stringFunctionName, stringStringToTrace)Global

          Outputs a string to the Papyrus log on disk, and the Papyrus overlay, pretty-printing the passed in self object and function name.

          The output format is: "[Script]-->FunctionName(): Text"

        • boolfunctionTraceLog(ScriptObjectCallingObject, stringasTextToPrint, stringlogName, stringSubLogName="", intaiSeverity=0, boolbShowNormalTrace=false, boolbShowWarning=false, boolbPrefixTraceWithLogNames=false, boolbPrefixTracesWithCallingObject=true)Global

          jduvall

        • voidfunctionShowRefPosition(ObjectReferencearRef)NativeGlobal

          Used to add a tripod to a reference (non-release builds only)

        • voidfunctionDBSendPlayerPosition()NativeGlobal

          Prints out the players position to the database (non-release PC and Xenon builds only)

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