Script Operator
Script Operator properties for Script Engine. Calls a function defined in the project's script file once per frame, while playback is running. Useful for driving custom logic that needs to react frame-by-frame — updating overlays based on the current state, polling external systems, computing values that other components depend on. The script function name and an optional string parameter are configurable, and the operator measures how long each call takes so you can keep an eye on script-side overhead.
| Property | Type | Access | Description |
|---|---|---|---|
MethodName |
string |
get/set |
Name of the function in the project's script file to call once per frame while playback is running. Leave empty to disable. The function is looked up by name in the project's script — make sure spelling matches and the function is exported/callable. Errors during the call are written to ComponentLog. |
MethodParam |
string |
get/set |
Optional string passed as an argument to the script function on every call. Use it to parameterise the same function for different operator instances, or to pass a JSON blob the script can parse. Leave empty if the function takes no arguments. |
ScriptPerformance |
string |
get |
Time taken by the most recent script function call, in milliseconds (read-only). Watch this to spot a script that has become a per-frame bottleneck — anything in the tens of milliseconds is likely worth optimising on a 50/60 fps project. |
ComponentLog |
ComponentLog |
get |
Live log of messages and errors related to this Script Operator (read-only). Failures during the call (missing function, runtime errors in the script) are reported here. |
Inherits from: AbstractOperator, AbstractAudioMetering.
See also: Script Operator in Operators — user-facing introduction, screenshots, and section summaries.