StartScriptProfiling function - Debug script

Found in:

Vanilla

voidfunctionStartScriptProfiling(stringasScriptName)NativeGlobal

Description

Wiki Description

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.

Documentation Comment

Start profiing a specific script - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off

Caveats

CK Wiki - Notes

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.

Parameters

stringasScriptName
CK Wiki Description
The name of the script to start profiling.

Examples

; Starts profiling "MySlowScript"
Debug.StartScriptProfiling("MySlowScript")

Auto-Generated Example

string myString__asScriptName

Debug.StartScriptProfiling(myString__asScriptName)

Debug
Debug.StopScriptProfiling(...)
StartPapyrusScriptProfile (Console Command)

Additional References

View this function’s page on the Skyrim Creation Kit Wiki