Debug Script

From the CreationKit Wiki
Revision as of 12:42, 20 February 2012 by imported>Jog (→‎Global Functions)
Jump to navigation Jump to search


Collection of debug-related global functions

Definition

ScriptName Debug

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.

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 SendAnimationEvent(ObjectReference arRef, string asEventName)

  • Sends an animation event to the specified reference.

Function StartScriptProfiling(string asScriptName)

  • Starts profiling a specific Papyrus script

Function StartStackProfiling()

  • Starts profiling the calling stack

Function StopScriptProfiling(string asScriptName)

  • Stops profiling a specific Papyrus script

Function StopStackProfiling()

  • Stops profiling the calling stack

Function ToggleAI()

  • Turns AI on and off.

Function ToggleCollisions()

  • Turns collision on and off.

Function ToggleMenus()

  • Toggles menus on and off.

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)

  • Outputs the string to the Papyrus log, but only if the condition is true

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