StartObjectProfiling - Form

Member of: Form Script, Alias Script, ActiveMagicEffect Script

Starts profiling all scripts attached to this object until stopped. The profile files are stored in "<documents>/My Games/Skyrim/Logs/Script/Profiling". This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc). If the object is already profiled nothing will change. Profiling requests are not saved and will be reset if you load a save game.

Syntax

Function StartObjectProfiling() native

Parameters

None.

Return Value

None.

Examples

; Starts profiling the slow object
SlowObject.StartObjectProfiling()

Notes

Profiling requires the "bEnableProfiling" flag in the "[Papyrus]" section of the ini file to be set to 1.

The flamegraph visualizer speedscope supports all kinds of profiles that Skyrim produces, including those produced by this function.

See Also

• Alias Script
• ActiveMagicEffect Script
• Form Script
• StopObjectProfiling - Form
• StartPapyrusFormProfile (Console Command)