Difference between revisions of "Enable Debug Logging"

97 bytes added ,  04:18, 7 May 2022
m
Correcting paths
imported>Qazaaq
(Added some style, changed some wording, and fixed wiki links)
m (Correcting paths)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Tutorial_Stubs]]
The [[Debug Script]] offers many methods for diagnosing and tracing execution of [[Papyrus]] scripts.
The [[Debug Script]] offers many methods for diagnosing and tracing execution of [[Papyrus]] scripts.  
 
The following are some of the most commonly used.
The following are some of the most commonly used.
<source lang="papyrus">
<source lang="papyrus">
Debug.Trace("This message is written to the papyrus log file.")
Debug.Trace("This message is written to the papyrus log file.")
Debug.Notification("This message is displayed on the HUD menu.")
Debug.Notification("This message is displayed on the HUD menu.")
Debug.MessageBox("This message is displayed in a message box.")
Debug.MessageBox("This message is displayed in a message box.")
Debug.CenterOnCell("QASmoke")
Debug.CenterOnCell("QASmoke")
Debug.DumpEventRegistrations(self)
Debug.DumpEventRegistrations(self)
</source>
</source>




However, these methods will not work unless you enable logging:
However, these methods will not work unless you enable logging:
# Open the file "<code>..\Documents\My Games\Fallout4\Fallout4Custom.ini</code>".
# Populate the <code>Fallout4Custom.ini</code> file with the following settings.
Log output from [[Papyrus]] will be written to <code>..\Documents\My Games\Fallout4\Logs\Script\Papyrus.0.log</code> or <code>..\Documents\My Games\Fallout4\Logs\Script\User\</code> if you have configured a user log.


# Open the file :  <code>..\Documents\My Games\Fallout 4\Fallout4Custom.ini</code>
==== ..\Documents\My Games\Fallout 4\Fallout4Custom.ini ====
# Populate the Fallout4Custom.ini file with the following:
<source lang="ini">
<source lang="text">
[Papyrus]
[Papyrus]
bEnableLogging=1
bEnableLogging=1
bEnableTrace=1
bEnableTrace=1
bLoadDebugInformation=1
bLoadDebugInformation=1
bEnableProfiling=1
bEnableProfiling=1
sDefaultLogOverlay=Papyrus
sDefaultLogOverlay=Papyrus
</source>
</source>




'''NOTE'''
[[Category:Game Configurations]]
Log output from [[Papyrus]] will be written to <code>..\Documents\My Games\Fallout 4\Logs\Script\Papyrus.0.log</code> or <code>..\Documents\My Games\Fallout 4\Logs\Script\User\</code> if you have configured a user log.
[[Category:Papyrus Configurations]]
7

edits