Description
This function adds a new SCRIPT task definition during runtime.
Signature
nxa.AddScriptTask (string, string, bool, bool, bool, number, string, number)
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| sourceItemID | string | M | |
| destinationItemID | string | M | |
| triggerOnReceive | bool | M | corresponds to the OnReceive parameter of the task definition |
| triggerOnSend | bool | M | corresponds to the OnSend parameter of the task definition |
| triggerOnSet | bool | M | corresponds to the OnSet parameter of the task definition |
| delay | number | M | time interval in milliseconds that the task will be delayed when triggered |
| script | string | M | LUA script name that will be executed when the task is triggered |
| moduleID | number | O | Has to be > 1000. Can be referenced in the nxa.RemoveScriptTask function. |
Return
| Type | Description |
|---|---|
| string | TaskID for reference in nxa.RemoveItemTask(), nxa.ActivateItemTask(), nxa.DeactivateItemTask(). |