Debug Script

From the CreationKit Wiki
Revision as of 03:53, 24 October 2013 by imported>CraftySentinel (→‎Global Functions: Formatting Change)
Jump to navigation Jump to search


Collection of debug-related global functions

Definition

ScriptName Debug

Properties

None

Global Functions

Function Description
CenterOnCell(String asCellName) Teleports the player to the specified cell.
Float CenterOnCellAndWait(String asCellName) Teleports the player to the specified cell and doesn't return until he gets there.
Float PlayerMoveToAndWait(String asDestRef) Teleports the player to the specified reference and doesn't return until he gets there.
CloseUserLog(String asLogName) Closes the specified user log
DumpAliasData(Quest akQuest) Dumps all alias fill information to the alias dump log.
String GetConfigName() Obtains the build configuration name
String GetPlatformName() Obtains the current platform name
String GetVersionNumber() Obtains the current version number
MessageBox(String asMessageBoxText) Displays an OK message box with the specified text
Notification(String asNotificationText) Displays an in-game notification message (on the top-left corner)
Bool OpenUserLog(String asLogName) Opens the specified user log (fails if already open)
QuitGame() Quits the game
SetFootIK(Bool abFootIK) Turns foot IK on and off
SetGodMode(Bool abGodMode) Turns god mode on and off
SendAnimationEvent(ObjectReference arRef, String asEventName) Sends an animation event to the specified reference.
StartScriptProfiling(String asScriptName) Starts profiling a specific Papyrus script
StartStackProfiling() Starts profiling the calling stack
StopScriptProfiling(String asScriptName) Stops profiling a specific Papyrus script
StopStackProfiling() Stops profiling the calling stack
ToggleAI() Turns AI on and off.
ToggleCollisions() Turns collision on and off.
ToggleMenus() Toggles menus on and off.
Trace(String asTextToPrint, Int aiSeverity) Outputs the string to the Papyrus log and debug text page
TraceAndBox(String asTextToPrint, Int aiSeverity) Outputs the string to the log and puts up a message box
TraceConditional(String TextToPrint, Bool ShowTrace) Outputs the string to the Papyrus log, but only if the condition is true
TraceStack(String asTextToPrint, Int aiSeverity) Outputs the string to the Papyrus log and debug text page, along with a full call stack
Bool TraceUser(String asUserLog, String asTextToPrint, Int aiSeverity) Outputs the string to the specified user log (and debug text page)

Member Functions

None

Events

None