The Debug Script

No properties found.

No events found.

• Found in:
  • Vanilla

  voidfunctionCenterOnCell(stringasCellname)NativeGlobal

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

• Found in:
  • Vanilla

  floatfunctionCenterOnCellAndWait(stringasCellname)NativeGlobal

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

• Found in:
  • Vanilla

  floatfunctionPlayerMoveToAndWait(stringasDestRef)NativeGlobal

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

• Found in:
  • Vanilla

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

• Found in:
  • Vanilla

  voidfunctionDebugChannelNotify(stringchannel, stringmessage)NativeGlobal

  Outputs the string to a named debug channel (useful on the Xenon currently)

• Found in:
  • Vanilla

  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".

• Found in:
  • Vanilla

  stringfunctionGetConfigName()NativeGlobal

  Obtains the game's build configuration.

• Found in:
  • Vanilla

  stringfunctionGetPlatformName()NativeGlobal

  Obtains the game's platform name.

• Found in:
  • Vanilla

  stringfunctionGetVersionNumber()NativeGlobal

  Obtains the game's version number.

• Found in:
  • Vanilla

  voidfunctionMessageBox(stringasMessageBoxText)NativeGlobal

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

• Found in:
  • Vanilla

  voidfunctionNotification(stringasNotificationText)NativeGlobal

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

• Found in:
  • Vanilla

  boolfunctionOpenUserLog(stringasLogName)NativeGlobal

  Opens a new user log on disk. This will also cycle the older logs (so log 0 becomes 1, 1 becomes 2, etc). The log files are stored in "My Documents/My Games/Skyrim/Logs/Script/User". If the log is already open, the function will return false (but not print an error to the main script log). Note that you do not have to close the log yourself unless you want to, it will close automatically when the game ends, the player goes back to the main menu, or a save is loaded.

• Found in:
  • Vanilla

  voidfunctionQuitGame()NativeGlobal

  Immediately exits the game.

• Found in:
  • Vanilla

  voidfunctionSetFootIK(boolabFootIK)NativeGlobal

  Turns foot IK on and off in the game.

• Found in:
  • Vanilla

  voidfunctionSetGodMode(boolabGodMode)NativeGlobal

  Turns god mode on and off in the game.

• Found in:
  • Vanilla

  voidfunctionSendAnimationEvent(ObjectReferencearRef, stringasEventName)NativeGlobal

  Sends an animation event to a reference directly.

• Found in:
  • Vanilla

  voidfunctionStartScriptProfiling(stringasScriptName)NativeGlobal

  Starts profiling a single Papyrus script. Child and parent scripts are not profiled. The profile files are stored in "<game folder>/Logs/Script/Profiling". This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc). If the script is already profiled nothing will change. Profiling requests are not saved and will be reset if you load a save game.

• Found in:
  • Vanilla

  voidfunctionStartStackProfiling()NativeGlobal

  Starts profiling a single Papyrus stack until stopped or until the last function exits. The profile files are stored in "<game folder>/Logs/Script/Profiling". This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc). If the stack is already profiled nothing will change. Profiling requests are not saved and will be reset if you load a save game.

• Found in:
  • Vanilla

  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.

• Found in:
  • Vanilla

  voidfunctionStopStackProfiling()NativeGlobal

  Stops profiling a single Papyrus stack. The profile files are stored in "<game folder>/Logs/Script/Profiling". This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc). If the stack is not currently profiled nothing will change.

• Found in:
  • Vanilla

  voidfunctionTakeScreenshot(stringasFilename)NativeGlobal

  Takes a screenshot (Xenon only)

• Found in:
  • Vanilla

  voidfunctionToggleAI()NativeGlobal

  Toggles AI on and off in the game.

• Found in:
  • Vanilla

  voidfunctionToggleCollisions()NativeGlobal

  Toggles collisions on and off in the game.

• Found in:
  • Vanilla

  voidfunctionToggleMenus()NativeGlobal

  Toggles the display of menus on and off in the game.

  No menus are closed or opened, they are just made visible or invisible.

• Found in:
  • Vanilla

  voidfunctionTrace(stringasTextToPrint, intaiSeverity=0)NativeGlobal

  Outputs a string to the Papyrus log on disk, and the Papyrus debug text page. The Papyrus log file is located in Documents\My Games\Skyrim\Logs\Script\Papyrus0.log, but only if bEnableTrace and bEnableLogging are set to 1 in the Papyrus section of the Skyrim.INI, SkyrimPrefs.INI or a plugin's INI.

• Found in:
  • Vanilla

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

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

• Found in:
  • Vanilla

  boolfunctionTraceUser(stringasUserLog, stringasTextToPrint, intaiSeverity=0)NativeGlobal

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

• Found in:
  • Vanilla

  voidfunctionTraceConditional(stringTextToPrint, boolShowTrace)Global

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

• Found in:
  • Vanilla

  voidfunctionTraceAndBox(stringasTextToPrint, intaiSeverity=0)Global

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

• Found in:
  • Vanilla

  voidfunctionShowRefPosition(ObjectReferencearRef)NativeGlobal

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

• Found in:
  • Vanilla

  voidfunctionDBSendPlayerPosition()NativeGlobal

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