SetTimerPaused: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|22701| This function allows you to pause existing running timers and resume existing paused ti...")
 
No edit summary
 
Line 2: Line 2:
__NOTOC__
__NOTOC__
{{New feature/item|3.0161|1.6.0|22701|  
{{New feature/item|3.0161|1.6.0|22701|  
This function allows you to pause existing running timers and resume existing paused timers.
This function is used to either pause or resume a timer.
}}
}}


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


===Returns===
===Returns===

Latest revision as of 10:26, 6 September 2024

ADDED/UPDATED IN VERSION 1.6.0 r22701:

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

Syntax

bool setTimerPaused ( timer theTimer, bool paused )

OOP Syntax Help! I don't understand this!

Variable: .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. 

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetTimerPaused?oldid=80121"