Justns at 10:26, 6 September 2024

2024-09-06T10:26:32Z

← Older revision		Revision as of 10:26, 6 September 2024
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===

Dragon: 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..."

2024-09-05T06:53:56Z

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

New page

{{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 timers.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setTimerPaused ( timer theTimer, bool paused )
</syntaxhighlight>
{{OOP||[[timer]]:paused||}}
===Required Arguments===
*'''theTimer:''' The [[timer]] you wish to pause or resume.
*'''paused:''' Whether you want to pause (''true'') or resume (''false'') the [[timer]].

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

SetTimerPaused - Revision history

Justns at 10:26, 6 September 2024

Dragon: 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..."

Dragon: 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..."