- Found in:
- Vanilla
Description
Wiki Description
Starts profiling all stacks that start in the specified script (and optionally object). Calls into said script from outside scripts are NOT profiled.
Documentation Comment
Starts profiling all stacks that start in the specified script (and object, if any) - 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.
- This is effectively the same as adding Debug.StartStackProfiling() to every event in your script (except it will start profiling the stack before the event starts).
- The profile files are stored in "<documents>/My Games/Fallout4/Logs/Script/Profiling".
- This will also cycle the older profiling logs (so log 0 becomes 1, 1 becomes 2, etc).
- If the stack root is already profiled nothing will change.
- Profiling requests are not saved and will be reset if you load a save game.
Parameters
stringasScriptName
CK Wiki Description
The name of the script to start profiling.
ScriptObjectakObj=NONE
CK Wiki Description
The object to limit the profiling to. If None, will profile all instances of the script in the game.
- Default:None
Examples
; Starts profiling all stacks that start in MySlowScript
Debug.StartStackRootProfiling("MySlowScript"); Starts profiling all stacks that start in MySlowScript, but only on MyObj
Debug.StartStackRootProfiling("MySlowScript", MyObj)Auto-Generated Example
string myString__asScriptName
ScriptObject myScriptObject__akObj
Debug.StartStackRootProfiling(myString__asScriptName, myScriptObject__akObj)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki