SetTimerEx: Difference between revisions
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
::... : Optional Parameters to pass to the function. Supported parameter data types are integers, floats and strings.</poem>| | ::... : Optional Parameters to pass to the function. Supported parameter data types are integers, floats and strings.</poem>| | ||
retvals=The ID of the timer created, which can be used with [[KillTimer]]| | retvals=The ID of the timer created, which can be used with [[KillTimer]]| | ||
note=Unlike the usual timer function in squirrel gamemode, this function has third parameter 1 or 0. If you pass 1, the timer will repeat indefinitely rather than execute one time. Pass 0 to execute timer '''one time''' only.|note=This was added in 0 | note=Unlike the usual timer function in squirrel gamemode, this function has third parameter 1 or 0. If you pass 1, the timer will repeat indefinitely rather than execute one time. Pass 0 to execute timer '''one time''' only.|note=This was added in v2.0 and will not work in previous versions.| | ||
relfuncs=*[[KillTimer]] | relfuncs=*[[KillTimer]] | ||
*[[SetTimer]] | *[[SetTimer]] | ||
}} | }} | ||
Revision as of 08:39, 13 November 2022
Description:
This will create set a timer, which will be triggered when the given time has passed.
Parameters:
(FunctionName, interval, n, ...)
FunctionName[string] : The name of the function to be called.
interval[integer] : The amount of time (in milliseconds) after which the function will be called.
n[integer] : The number of times the function is to be called. Specify 0 to call the function infinite number of times.
... : Optional Parameters to pass to the function. Supported parameter data types are integers, floats and strings.
Return Values:
The ID of the timer created, which can be used with KillTimer
Important Note:
This was added in v2.0 and will not work in previous versions.
Related Functions
The following functions may be helpful as they relate to this function in one way or another.