Difference between revisions of "StartObjectProfiling - Form"
Jump to navigation
Jump to search
imported>Tunaisafish (→Syntax: -global) |
(→Notes: Added note concerning a visualizer →See Also: Added corresponding console command) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
[[Category:Non-delayed Native Function]] | |||
'''Member of:''' [[Form Script]], [[Alias Script]], [[ActiveMagicEffect Script]] | '''Member of:''' [[Form Script]], [[Alias Script]], [[ActiveMagicEffect Script]] | ||
| Line 24: | Line 25: | ||
== Notes == | == Notes == | ||
Profiling requires the "bEnableProfiling" flag in the "[Papyrus]" section of the ini file to be set to 1. | Profiling requires the "bEnableProfiling" flag in the "[Papyrus]" section of the ini file to be set to 1. | ||
The flamegraph visualizer [https://speedscope.app speedscope] supports all kinds of profiles that Skyrim produces, including those produced by this function. | |||
== See Also == | == See Also == | ||
| Line 30: | Line 33: | ||
*[[Form Script]] | *[[Form Script]] | ||
*[[StopObjectProfiling - Form]] | *[[StopObjectProfiling - Form]] | ||
*[[StartPapyrusFormProfile]] (Console Command) | |||
Latest revision as of 14:56, 22 February 2024
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[edit | edit source]
Function StartObjectProfiling() nativeParameters[edit | edit source]
None.
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; Starts profiling the slow object
SlowObject.StartObjectProfiling()Notes[edit | edit source]
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.