Difference between revisions of "Debug Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Global Functions: Formatting Change)
imported>CraftySentinel
(Revert to List)
 
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 ==


{|class="wikitable" width =100%
:'''[[CenterOnCell - Debug|CenterOnCell]](String ''asCellName'')'''
!style="text-align:left;"|Function
:*Teleports the player to the specified cell.
!style="text-align:left;"|Description
|-
|[[CenterOnCell - Debug|'''CenterOnCell'''(String ''asCellName'')]]
|Teleports the player to the specified cell.
|-


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


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


|[[CloseUserLog - Debug|'''CloseUserLog'''(String ''asLogName'')]]
:'''[[CloseUserLog - Debug|CloseUserLog]](String ''asLogName'')'''
|Closes the specified user log
:*Closes the specified user log
|-


|[[DumpAliasData - Debug|'''DumpAliasData'''(Quest ''akQuest'')]]
:'''[[DumpAliasData - Debug|DumpAliasData]](Quest ''akQuest'')'''
|Dumps all alias fill information to the alias dump log.
:*Dumps all alias fill information to the alias dump log.
|-


|[[GetConfigName - Debug|String '''GetConfigName'''()]]
:'''String [[GetConfigName - Debug|GetConfigName]]()'''
|Obtains the build configuration name
:*Obtains the build configuration name
|-


|[[GetPlatformName - Debug|String '''GetPlatformName'''()]]
:'''String [[GetPlatformName - Debug|GetPlatformName]]()'''
|Obtains the current platform name
:*Obtains the current platform name
|-


|[[GetVersionNumber - Debug|String '''GetVersionNumber'''()]]
:'''String [[GetVersionNumber - Debug|GetVersionNumber]]()'''
|Obtains the current version number
:*Obtains the current version number
|-


|[[MessageBox - Debug|'''MessageBox'''(String ''asMessageBoxText'')]]
:'''[[MessageBox - Debug|MessageBox]](String ''asMessageBoxText'')'''
|Displays an OK message box with the specified text
:*Displays an OK message box with the specified text
|-


|[[Notification - Debug|'''Notification'''(String ''asNotificationText'')]]
:'''[[Notification - Debug|Notification]](String ''asNotificationText'')'''
|Displays an in-game notification message (on the top-left corner)
:*Displays an in-game notification message (on the top-left corner)
|-


|[[OpenUserLog - Debug|Bool '''OpenUserLog'''(String ''asLogName'')]]
:'''Bool [[OpenUserLog - Debug|OpenUserLog]](String ''asLogName'')'''
|Opens the specified user log (fails if already open)
:*Opens the specified user log (fails if already open)
|-


|[[QuitGame - Debug|'''QuitGame'''()]]
:'''[[QuitGame - Debug|QuitGame]]()'''
|Quits the game
:*Quits the game
|-


|[[SetFootIK - Debug|'''SetFootIK'''(Bool ''abFootIK'')]]
:'''[[SetFootIK - Debug|SetFootIK]](Bool ''abFootIK'')'''
|Turns foot IK on and off
:*Turns foot IK on and off
|-


|[[SetGodMode - Debug|'''SetGodMode'''(Bool ''abGodMode'')]]
:'''[[SetGodMode - Debug|SetGodMode]](Bool ''abGodMode'')'''
|Turns god mode on and off
:*Turns god mode on and off
|-


|[[SendAnimationEvent - Debug|'''SendAnimationEvent'''(ObjectReference ''arRef'', String ''asEventName'')]]
:'''[[SendAnimationEvent - Debug|SendAnimationEvent]](ObjectReference ''arRef'', String ''asEventName'')'''
|Sends an animation event to the specified reference.
:*Sends an animation event to the specified reference.
|-


|[[StartScriptProfiling - Debug|'''StartScriptProfiling'''(String ''asScriptName'')]]
:'''[[StartScriptProfiling - Debug|StartScriptProfiling]](String ''asScriptName'')'''
|Starts profiling a specific Papyrus script
:*Starts profiling a specific Papyrus script
|-


|[[StartStackProfiling - Debug|'''StartStackProfiling'''()]]
:'''[[StartStackProfiling - Debug|StartStackProfiling]]()'''
|Starts profiling the calling stack
:*Starts profiling the calling stack
|-


|[[StopScriptProfiling - Debug|'''StopScriptProfiling'''(String ''asScriptName'')]]
:'''[[StopScriptProfiling - Debug|StopScriptProfiling]](String ''asScriptName'')'''
|Stops profiling a specific Papyrus script
:*Stops profiling a specific Papyrus script
|-


|[[StopStackProfiling - Debug|'''StopStackProfiling'''()]]
:'''[[StopStackProfiling - Debug|StopStackProfiling]]()'''
|Stops profiling the calling stack
:*Stops profiling the calling stack
|-


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


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


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


|[[Trace - Debug|'''Trace'''(String ''asTextToPrint'', Int ''aiSeverity'')]]
:'''[[Trace - Debug|Trace]](String ''asTextToPrint'', Int ''aiSeverity'')'''
|Outputs the string to the Papyrus log and debug text page
:*Outputs the string to the Papyrus log and debug text page
|-


|[[TraceAndBox - Debug|'''TraceAndBox'''(String ''asTextToPrint'', Int ''aiSeverity'')]]
:'''[[TraceAndBox - Debug|TraceAndBox]](String ''asTextToPrint'', Int ''aiSeverity'')'''
|Outputs the string to the log and puts up a message box
:*Outputs the string to the log and puts up a message box
|-


|[[TraceConditional - Debug|'''TraceConditional'''(String ''TextToPrint'', Bool ''ShowTrace'')]]
:'''[[TraceConditional - Debug|TraceConditional]](String ''TextToPrint'', Bool ''ShowTrace'')'''
|Outputs the string to the Papyrus log, but only if the condition is true
:*Outputs the string to the Papyrus log, but only if the condition is true
|-


|[[TraceStack - Debug|'''TraceStack'''(String ''asTextToPrint'', Int ''aiSeverity'')]]
:'''[[TraceStack - Debug|TraceStack]](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 Papyrus log and debug text page, along with a full call stack
|-


|[[TraceUser - Debug|Bool '''TraceUser'''(String ''asUserLog'', String ''asTextToPrint'', Int ''aiSeverity'')]]
:'''Bool [[TraceUser - Debug|TraceUser]](String ''asUserLog'', String ''asTextToPrint'', Int ''aiSeverity'')'''
|Outputs the string to the specified user log (and debug text page)
:*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