PauseTimer: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|PauseTimer(timer)}} {{FuncParameters}} {{FuncParam|timer|__EDIT_ME__}} {{FuncReturnValue|__EDIT_M..." |
FlyingFork (talk | contribs) No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Server|1.0}} | {{Info|Function|Server & Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Pauses the specified timer.}} | ||
{{FuncSyntax|PauseTimer(timer)}} | {{FuncSyntax|PauseTimer(timer)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|timer| | {{FuncParam|timer|The timer identifier}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true''' on success, '''false''' on error.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
function pauseTimers() | |||
for index, timer in ipairs(GetAllTimers()) do | |||
PauseTimer(timer) | |||
end | |||
end | |||
function resumeTimers() | |||
for index, timer in ipairs(GetAllTimers()) do | |||
UnpauseTimer(timer) | |||
end | |||
end | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:TimerFunctions}} | |||
Latest revision as of 17:16, 27 May 2021
Description
Pauses the specified timer.
Syntax
PauseTimer(timer)
Parameters
- timer
The timer identifier
Return Value
- Returns true on success, false on error.
Example
function pauseTimers()
for index, timer in ipairs(GetAllTimers()) do
PauseTimer(timer)
end
end
function resumeTimers()
for index, timer in ipairs(GetAllTimers()) do
UnpauseTimer(timer)
end
end
