StartScriptProfiling - Debug: Difference between revisions
Jump to navigation
Jump to search
(→Notes: Added note concerning a visualizer) |
m (Convert source tags to syntaxhighlight) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
< | <syntaxhighlight lang="papyrus"> | ||
Function StartScriptProfiling(string asScriptName) native global | Function StartScriptProfiling(string asScriptName) native global | ||
</ | </syntaxhighlight> | ||
== Parameters == | == Parameters == | ||
| Line 18: | Line 18: | ||
== Examples == | == Examples == | ||
< | <syntaxhighlight lang="papyrus"> | ||
; Starts profiling "MySlowScript" | ; Starts profiling "MySlowScript" | ||
Debug.StartScriptProfiling("MySlowScript") | Debug.StartScriptProfiling("MySlowScript") | ||
</ | </syntaxhighlight> | ||
== Notes == | == Notes == | ||
| Line 31: | Line 31: | ||
*[[Debug Script]] | *[[Debug Script]] | ||
*[[StopScriptProfiling - Debug]] | *[[StopScriptProfiling - Debug]] | ||
*[[StartPapyrusScriptProfile]] (Console Command) | |||
Latest revision as of 20:22, 5 September 2026
Member of: Debug Script
Starts profiling a single Papyrus script. Child and parent scripts are not profiled. The profile files are stored in "<game folder>/Logs/Script/Profiling". This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc). If the script is already profiled nothing will change. Profiling requests are not saved and will be reset if you load a save game.
Syntax[edit | edit source]
Function StartScriptProfiling(string asScriptName) native globalParameters[edit | edit source]
- asScriptName: The name of the script to start profiling.
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; Starts profiling "MySlowScript"
Debug.StartScriptProfiling("MySlowScript")Notes[edit | edit source]
Profiling requires the "bEnableProfiling" flag in the "[Papyrus]" section of the ini file to be set to 1. Consoles will never profile in release final builds.
The flamegraph visualizer speedscope supports all kinds of profiles that Skyrim produces, including those produced by this function.
See Also[edit | edit source]
- Debug Script
- StopScriptProfiling - Debug
- StartPapyrusScriptProfile (Console Command)