setTimerPaused | Multi Theft Auto: Wiki Skip to content

setTimerPaused

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.


This function is used to either pause or resume a timer.

Syntax

bool setTimerPaused ( timer theTimer, bool 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

  • bool: value

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

Code Examples

shared

This example pauses all current timers from this resource.

-- 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