StartObjectProfiling - Form | Skyrim SE

Found in:

Vanilla
SKSE

voidfunctionStartObjectProfiling()Native

Description

Wiki Description

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.

Documentation Comment

Turns on profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off

[DEV SERVER] Loading description...

Caveats

CK Wiki - 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.

Examples

; Starts profiling the slow object
SlowObject.StartObjectProfiling()

Auto-Generated Example

myForm__toCallFunctionOn.StartObjectProfiling()

Alias
ActiveMagicEffect
Form
Form.StopObjectProfiling()
StartPapyrusFormProfile (Console Command)

Additional References

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

Description

Wiki Description

Documentation Comment

Caveats

CK Wiki - Notes

Examples

Auto-Generated Example

Related Pages

Additional References

Description

Wiki Description

Documentation Comment