Multi Theft Auto: Wiki - User contributions [en]

User:Justns

2024-09-06T10:31:34Z

Justns: Created page with "Discord: justns"

Discord: justns

IsTimerPaused

2024-09-06T10:29:21Z

Justns:

{{Server client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|22701|
This function allows you to check whether a timer is paused.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isTimerPaused ( timer theTimer )
</syntaxhighlight>
{{OOP|||paused}}
===Required Arguments===
*'''theTimer:''' The [[timer]] you wish to check.

===Returns===
Returns ''true'' if the timer is currently paused, ''false'' if not or if no such timer existed.

==Example==

This example pauses all currently running timers and resumes all currently paused timers from this resource.
<syntaxhighlight lang="lua">
-- Get a table of all current timers from this resource
local timers = getTimers ( )
-- Loop through the table of timers
for timerIndex, timerValue in ipairs( timers ) do
-- check if each timer is currently paused
local isPaused = isTimerPaused( timerValue )
-- pause or resume each timer based on its current state
setTimerPaused ( timerValue, not isPaused )
end
</syntaxhighlight>

==See Also==
{{Utility functions}}

SetTimerPaused

2024-09-06T10:26:32Z

Justns:

{{Server client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|22701|
This function is used to either pause or resume a timer.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setTimerPaused ( timer theTimer, bool paused )
</syntaxhighlight>
{{OOP|||paused}}
===Required Arguments===
*'''theTimer:''' The [[timer]] you wish to pause or resume.
*'''paused:''' a [[boolean]] value representing whether the timer should be paused or not. To pause the timer, use ''true''.

===Returns===
Returns ''true'' if the timer was successfully paused or resumed, ''false'' if no such timer existed.

==Example==

This example pauses all current timers from this resource.
<syntaxhighlight lang="lua">
-- Get a table of all current timers from this resource
local timers = getTimers ( )
-- Loop through the table of timers
for timerIndex, timerValue in ipairs( timers ) do
-- pause each timer
setTimerPaused ( timerValue, true )
end
</syntaxhighlight>

==See Also==
{{Utility functions}}