Introduction
Usually, when a plugin function is called from the samurize client, samurize waits for the result to be available. This is also true for the scripts supported in samurize like vbs or javascript. The multithreading feature of the lua script plugin allows you to get around that limitation.
Using that feature is very simple. By default, a script behaves like it would with other scripting languages. The script is loaded and run, and the result of the script (identified by the return statement) is returned to samurize for display.
The clou to multithreaded functionality is this function:
The TempResult parameter is optional, if you don't set it the last intermediate result will be used.
You have to enable the Threads & Processes Module in the configuration dialog to use this function.
When you call this function, the intermediate result you give as the TempResult parameter will be given to samurize and samurize will use it. The script will continue to run in the background. You can update the intermediate result using the same function whenever you want. The script finishes as soon as the return statement is reached and the samurize client will return that value.
Using that feature is very simple. By default, a script behaves like it would with other scripting languages. The script is loaded and run, and the result of the script (identified by the return statement) is returned to samurize for display.
The clou to multithreaded functionality is this function:
SetIntermediateResult( [TempResult] )
The TempResult parameter is optional, if you don't set it the last intermediate result will be used.
You have to enable the Threads & Processes Module in the configuration dialog to use this function.
When you call this function, the intermediate result you give as the TempResult parameter will be given to samurize and samurize will use it. The script will continue to run in the background. You can update the intermediate result using the same function whenever you want. The script finishes as soon as the return statement is reached and the samurize client will return that value.
Subtitles