- Found in:
- Vanilla
Description
Wiki Description
Stops profiling all stacks that start in the specified script (and optionally object).
Documentation Comment
Stop 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.
- 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 not currently 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 stop profiling.
ScriptObjectakObj=NONE
CK Wiki Description
The object to limit the profiling to. Passing None does not remove all profiling roots for a particular script, it will only remove the 'all' profiling request if one was made.
- Default:None
Examples
; Stops profiling all stacks that start in MySlowScript (unless a filtered one remains)
Debug.StopStackRootProfiling("MySlowScript"); Stops profiling all stacks that start in MySlowScript, but only on MyObj
; Will have no effect if MyObj was not being filtered already
Debug.StartStackRootProfiling("MySlowScript", MyObj)Auto-Generated Example
string myString__asScriptName
ScriptObject myScriptObject__akObj
Debug.StopStackRootProfiling(myString__asScriptName, myScriptObject__akObj)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki