StartScriptProfiling - Debug

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

Function StartScriptProfiling(string asScriptName) native global

Parameters

• asScriptName: The name of the script to start profiling.

Return Value

None.

Examples

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

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.

See Also

• Debug Script
• StopScriptProfiling - Debug
• StartPapyrusScriptProfile (Console Command)