SetTimerEx: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Welcome|note=This was added in 0.1b and will not work in first version. | {{Welcome| | ||
desc=This will create set a timer, which will be triggered when the given time has passed.| | |||
params=<syntaxhighlight lang="lua">(FunctionName, interval, repeat)</syntaxhighlight> | |||
<poem>::FunctionName : The name of the function to be called. | |||
::interval : The amount of time (in milliseconds) after which the function will be called. | |||
::n : The number of times the function is to be called. Specify 0 to call the function infinite number of times</poem>| | |||
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.1b and will not work in first version. | |||
}} | }} | ||
Revision as of 06:14, 13 November 2022
Description:
This will create set a timer, which will be triggered when the given time has passed.
Parameters:
(FunctionName, interval, repeat)
FunctionName : The name of the function to be called.
interval : The amount of time (in milliseconds) after which the function will be called.
n : The number of times the function is to be called. Specify 0 to call the function infinite number of times
Return Values:
The ID of the timer created, which can be used with KillTimer
Important Note:
This was added in 0.1b and will not work in first version.