Creates a timer to run a script at regular intervals or at some specified time in the future.
Number | Type | Compulsory | Default | Description |
---|---|---|---|---|
1 |
string |
Yes |
|
Command |
2 |
real |
Yes |
|
Interval |
3 |
string array |
No |
2 |
options |
Command to run. This can be a primitive command or the name of a script and may include arguments to the command or script.
Interval in milliseconds. The first event will occur after the interval time has elapsed.
Options. String array containing any combination of 'oneshot' and 'echo'. 'oneshot' defines a timer that will trigger only once. 'echo' enables message output in the command shell.
Return type: real
The function returns an integer id. This can be used as an argument to functions DeleteTimer , EditTimer and GetTimerInfo.
|