Difference between revisions of "Debug Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
(Revert to List)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
Collection of debug-related global functions
Collection of debug-related global functions


Line 12: Line 8:
== Properties ==
== Properties ==
None
None


== Global Functions ==
== Global Functions ==
'''Function [[CenterOnCell - Debug|CenterOnCell]](string asCellName)'''
*Teleports the player to the specified cell.


'''float Function [[CenterOnCellAndWait - Debug|CenterOnCellAndWait]](string asCellName)'''
:'''[[CenterOnCell - Debug|CenterOnCell]](String ''asCellName'')'''
*Teleports the player to the specified cell and doesn't return until he gets there.
:*Teleports the player to the specified cell.
 
:'''Float [[CenterOnCellAndWait - Debug|CenterOnCellAndWait]](String ''asCellName'')'''
:*Teleports the player to the specified cell and doesn't return until he gets there.
 
:'''Float [[PlayerMoveToAndWait - Debug|PlayerMoveToAndWait]](String ''asDestRef'')'''
:*Teleports the player to the specified reference and doesn't return until he gets there.


'''float Function [[PlayerMoveToAndWait - Debug|PlayerMoveToAndWait]](string asDestRef)'''
:'''[[CloseUserLog - Debug|CloseUserLog]](String ''asLogName'')'''
*Teleports the player to the specified reference and doesn't return until he gets there.
:*Closes the specified user log


'''Function [[CloseUserLog - Debug|CloseUserLog]](string asLogName)'''
:'''[[DumpAliasData - Debug|DumpAliasData]](Quest ''akQuest'')'''
*Closes the specified user log
:*Dumps all alias fill information to the alias dump log.


'''Function [[DumpAliasData - Debug|DumpAliasData]](Quest akQuest)'''
:'''String [[GetConfigName - Debug|GetConfigName]]()'''
*Dumps all alias fill information to the alias dump log.
:*Obtains the build configuration name


'''string Function [[GetConfigName - Debug|GetConfigName]]()'''
:'''String [[GetPlatformName - Debug|GetPlatformName]]()'''
*Obtains the build configuration name
:*Obtains the current platform name


'''string Function [[GetPlatformName - Debug|GetPlatformName]]()'''
:'''String [[GetVersionNumber - Debug|GetVersionNumber]]()'''
*Obtains the current platform name
:*Obtains the current version number


'''string Function [[GetVersionNumber - Debug|GetVersionNumber]]()'''
:'''[[MessageBox - Debug|MessageBox]](String ''asMessageBoxText'')'''
*Obtains the current version number
:*Displays an OK message box with the specified text


'''Function [[MessageBox - Debug|MessageBox]](string asMessageBoxText)'''
:'''[[Notification - Debug|Notification]](String ''asNotificationText'')'''
*Displays an OK message box with the specified text
:*Displays an in-game notification message (on the top-left corner)


'''Function [[Notification - Debug|Notification]](string asNotificationText)'''
:'''Bool [[OpenUserLog - Debug|OpenUserLog]](String ''asLogName'')'''
*Displays an in-game notification message (on the top-left corner)
:*Opens the specified user log (fails if already open)


'''bool Function [[OpenUserLog - Debug|OpenUserLog]](string asLogName)'''
:'''[[QuitGame - Debug|QuitGame]]()'''
*Opens the specified user log (fails if already open)
:*Quits the game


'''Function [[QuitGame - Debug|QuitGame]]()'''
:'''[[SetFootIK - Debug|SetFootIK]](Bool ''abFootIK'')'''
*Quits the game
:*Turns foot IK on and off


'''Function [[SetFootIK - Debug|SetFootIK]](bool abFootIK)'''
:'''[[SetGodMode - Debug|SetGodMode]](Bool ''abGodMode'')'''
*Turns foot IK on and off
:*Turns god mode on and off


'''Function [[SetGodMode - Debug|SetGodMode]](bool abGodMode)'''
:'''[[SendAnimationEvent - Debug|SendAnimationEvent]](ObjectReference ''arRef'', String ''asEventName'')'''
*Turns god mode on and off
:*Sends an animation event to the specified reference.


'''Function [[SendAnimationEvent - Debug|SendAnimationEvent]](ObjectReference arRef, string asEventName)'''
:'''[[StartScriptProfiling - Debug|StartScriptProfiling]](String ''asScriptName'')'''
*Sends an animation event to the specified reference.
:*Starts profiling a specific Papyrus script


'''Function [[StartScriptProfiling - Debug|StartScriptProfiling]](string asScriptName)'''
:'''[[StartStackProfiling - Debug|StartStackProfiling]]()'''
*Starts profiling a specific Papyrus script
:*Starts profiling the calling stack


'''Function [[StartStackProfiling - Debug|StartStackProfiling]]()'''
:'''[[StopScriptProfiling - Debug|StopScriptProfiling]](String ''asScriptName'')'''
*Starts profiling the calling stack
:*Stops profiling a specific Papyrus script


'''Function [[StopScriptProfiling - Debug|StopScriptProfiling]](string asScriptName)'''
:'''[[StopStackProfiling - Debug|StopStackProfiling]]()'''
*Stops profiling a specific Papyrus script
:*Stops profiling the calling stack


'''Function [[StopStackProfiling - Debug|StopStackProfiling]]()'''
:'''[[ToggleAI - Debug|ToggleAI]]()'''
*Stops profiling the calling stack
:*Turns AI on and off.


'''Function [[ToggleAI - Debug|ToggleAI]]()'''
:'''[[ToggleCollisions - Debug|ToggleCollisions]]()'''
*Turns AI on and off.
:*Turns collision on and off.


'''Function [[ToggleCollisions - Debug|ToggleCollisions]]()'''
:'''[[ToggleMenus - Debug|ToggleMenus]]()'''
*Turns collision on and off.
:*Toggles menus on and off.


'''Function [[ToggleMenus - Debug|ToggleMenus]]()'''
:'''[[Trace - Debug|Trace]](String ''asTextToPrint'', Int ''aiSeverity'')'''
*Toggles menus on and off.
:*Outputs the string to the Papyrus log and debug text page


'''Function [[Trace - Debug|Trace]](string asTextToPrint, int aiSeverity)'''
:'''[[TraceAndBox - Debug|TraceAndBox]](String ''asTextToPrint'', Int ''aiSeverity'')'''
*Outputs the string to the Papyrus log and debug text page
:*Outputs the string to the log and puts up a message box


'''Function [[TraceAndBox - Debug|TraceAndBox]](string asTextToPrint, int aiSeverity)'''
:'''[[TraceConditional - Debug|TraceConditional]](String ''TextToPrint'', Bool ''ShowTrace'')'''
*Outputs the string to the log and puts up a message box
:*Outputs the string to the Papyrus log, but only if the condition is true


'''Function [[TraceConditional - Debug|TraceConditional]](string TextToPrint, bool ShowTrace)'''
:'''[[TraceStack - Debug|TraceStack]](String ''asTextToPrint'', Int ''aiSeverity'')'''
*Outputs the string to the Papyrus log, but only if the condition is true
:*Outputs the string to the Papyrus log and debug text page, along with a full call stack


'''Function [[TraceStack - Debug|TraceStack]](string asTextToPrint, int aiSeverity)'''
:'''Bool [[TraceUser - Debug|TraceUser]](String ''asUserLog'', String ''asTextToPrint'', Int ''aiSeverity'')'''
*Outputs the string to the Papyrus log and debug text page, along with a full call stack
:*Outputs the string to the specified user log (and debug text page)


'''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 ==
None
None


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

Latest revision as of 06:48, 2 February 2014

Collection of debug-related global functions

Definition[edit | edit source]

ScriptName Debug

Properties[edit | edit source]

None


Global Functions[edit | edit source]

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[edit | edit source]

None


Events[edit | edit source]

None