UnpauseTimer: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|UnpauseTimer(timer)}} {{FuncParameters}} {{FuncParam|timer|__EDIT_ME__}} {{FuncReturnValue|__EDIT...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Unpause an already paused timer with this function.}}


{{FuncSyntax|UnpauseTimer(timer)}}
{{FuncSyntax|UnpauseTimer(timer)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|timer|__EDIT_ME__}}
{{FuncParam|timer|The timer identifier}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<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}}
__EDIT_ME__
* [[PauseTimer]]
* [[CreateTimer]]
* [[DestroyTimer]]

Latest revision as of 17:17, 27 May 2021

UnpauseTimer

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Unpause an already paused timer with this function.

Syntax

UnpauseTimer(timer)

Parameters

  • timer
    The timer identifier

Return Value

  • Returns true on success.

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

See also