Debug Script

From Creation Kit
Jump to: navigation, search


All functions in this script are debug only and will be compiled out of release archives.

Collection of debug-related global functions

Definition

ScriptName Debug Native DebugOnly Hidden

Properties

None

Global Functions

  • Function CenterOnCell(string asCellName)
    • Teleports the player to the specified cell.
  • float Function CenterOnCellAndWait(string asCellName)
    • Teleports the player to the specified cell and doesn't return until he gets there.
  • float Function PlayerMoveToAndWait(string asDestRef)
    • Teleports the player to the specified reference and doesn't return until he gets there.
  • Function CloseUserLog(string asLogName)
    • Closes the specified user log
  • Function DumpAliasData(Quest akQuest)
    • Dumps all alias fill information to the alias dump log.
  • Function DumpEventRegistrations(ScriptObject akScript)
    • Dumps all events the passed-in script is registered for to the script log
  • Function EnableAI(bool abEnable)
    • Enable/disable game AI processing.
  • Function EnableCollisions(bool abEnable)
    • Enable/disable collision in the game.
  • Function EnableDetection(bool abEnable)
    • Enable/disable AI detection in the game.
  • Function EnableMenus(bool abEnable)
    • Enable/disable menu rendering.
  • string Function GetConfigName()
    • Obtains the build configuration name
  • string Function GetPlatformName()
    • Obtains the current platform name
  • string Function GetVersionNumber()
    • Obtains the current version number
  • Function MessageBox(string asMessageBoxText)
    • Displays an OK message box with the specified text
  • Function Notification(string asNotificationText)
    • Displays an in-game notification message (on the top-left corner)
  • bool Function OpenUserLog(string asLogName)
    • Opens the specified user log (fails if already open)
  • Function QuitGame()
    • Quits the game
  • Function SetFootIK(bool abFootIK)
    • Turns foot IK on and off
  • Function SetGodMode(bool abGodMode)
    • Turns god mode on and off
  • Function StartScriptProfiling(string asScriptName)
    • Starts profiling a specific Papyrus script
  • Function StartStackProfiling()
    • Starts profiling the calling stack
  • Function StartStackRootProfiling(string asScriptName, ScriptObject akObj)
    • Starts profiling all stacks that start in the specified script and object
  • Function StopScriptProfiling(string asScriptName)
    • Stops profiling a specific Papyrus script
  • Function StopStackProfiling()
    • Stops profiling the calling stack
  • Function StopStackRootProfiling(string asScriptName, ScriptObject akObj)
    • Stops profiling all stacks that start in the specified script and object
  • Function Trace(string asTextToPrint, int aiSeverity)
    • Outputs the string to the Papyrus log and debug text page
  • Function TraceAndBox(string asTextToPrint, int aiSeverity)
    • Outputs the string to the log and puts up a message box
  • Function TraceConditional(string TextToPrint, bool ShowTrace, int Severity)
    • Outputs the string to the Papyrus log, but only if the condition is true
  • Function TraceConditionalGlobal(string TextToPrint, GlobalVariable ShowTrace)
    • Outputs the string to the Papyrus log, but only if the global is true
  • Function TraceFunction(string asTextToPrint, int aiSeverity)
    • Outputs the string to the Papyrus log and debug text page, along with all available information about the calling function. Institute Only
  • Function TraceSelf(ScriptObject CallingScript, string FunctionName, string StringToTrace)
    • Pretty-prints a string to the Papyrus log with the script and function name requested
  • Function TraceStack(string asTextToPrint, int aiSeverity)
    • Outputs the string to the Papyrus log and debug text page, along with a full call stack
  • bool Function TraceUser(string asUserLog, string asTextToPrint, int aiSeverity)
    • Outputs the string to the specified user log (and debug text page)

Member Functions

None

Events

None