Difference between revisions of "Debug Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Henning
 
imported>Jog
Line 14: Line 14:


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


== Member Functions ==
== Member Functions ==

Revision as of 12:42, 20 February 2012


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