SetWindowFlashing - Revision history

Lopez at 18:37, 24 January 2016

2016-01-24T18:37:59Z

← Older revision		Revision as of 18:37, 24 January 2016
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	=== Arguments ===		=== Required Arguments ===
	* '''shouldFlash:''' whether the window should flash		* '''shouldFlash:''' whether the window should flash
	* '''count~~''' ''(optional)'''''~~:''' the number of times the window should flash, defaults to '''10 times'''
			=== Optional Arguments ===
			* '''count:''' the number of times the window should flash, defaults to '''10 times'''

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

Lopez at 15:45, 24 January 2016

2016-01-24T15:45:45Z

← Older revision		Revision as of 15:45, 24 January 2016
Line 5:		Line 5:
	== Syntax ==		== Syntax ==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWindowFlashing ( bool shouldFlash[, int count= 10] )		bool setWindowFlashing ( bool shouldFlash [, int count = 10 ] )
	</syntaxhighlight>		</syntaxhighlight>

Jusonex at 16:51, 14 January 2016

2016-01-14T16:51:00Z

← Older revision		Revision as of 16:51, 14 January 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.~~0160~~\|1.6\|~~7653~~\|This function allows the window to flash in the Windows taskbar.}}		{{New feature/item\|3.0152\|1.5.2\|\|This function allows the window to flash in the Windows taskbar.}}

	== Syntax ==		== Syntax ==

Qaisjp: remove infinite restriction

2015-12-04T19:54:40Z

remove infinite restriction

← Older revision		Revision as of 19:54, 4 December 2015
Line 16:		Line 16:
	* the window is already in focus		* the window is already in focus
	* the client has disabled this feature		* the client has disabled this feature
	* ''count'' is ''0'' (flashing forever)

	Returns '''true''' otherwise		Returns '''true''' otherwise

Qaisjp: spacing

2015-12-04T19:53:12Z

spacing

← Older revision		Revision as of 19:53, 4 December 2015
Line 29:		Line 29:
	)		)
	</syntaxhighlight>		</syntaxhighlight>


	A command that allows the player to flash their window after a certain period of time for a certain count.		A command that allows the player to flash their window after a certain period of time for a certain count.

Qaisjp: add another example

2015-12-04T17:31:40Z

add another example

← Older revision		Revision as of 17:31, 4 December 2015
Line 22:		Line 22:
	== Example ==		== Example ==
	A command that allows the player to flash their window three times after one second.		A command that allows the player to flash their window three times after one second.
			<syntaxhighlight lang="lua">
			addCommandHandler("flash",
			function()
			setTimer(setWindowFlashing, 1000, 1, true, 3)
			end
			)
			</syntaxhighlight>

	A command that allows the player to flash their window after a certain period of time for a certain count.		A command that allows the player to flash their window after a certain period of time for a certain count.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Qaisjp: fix typo

2015-12-04T17:31:19Z

fix typo

← Older revision		Revision as of 17:31, 4 December 2015
Line 18:		Line 18:
	* ''count'' is ''0'' (flashing forever)		* ''count'' is ''0'' (flashing forever)

	Returns '''true'' otherwise		Returns '''true''' otherwise

	== Example ==		== Example ==

Qaisjp: fix typo

2015-12-04T17:31:06Z

fix typo

← Older revision		Revision as of 17:31, 4 December 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.0160\|1.6\|7653\|This function allows the to flash in the Windows taskbar.}}		{{New feature/item\|3.0160\|1.6\|7653\|This function allows the window to flash in the Windows taskbar.}}

	== Syntax ==		== Syntax ==

Qaisjp: Created page with "NOTOC {{Client function}} {{New feature/item|3.0160|1.6|7653|This function allows the to flash in the Windows taskbar.}} == Syntax == bool setWindowFlashing..."

2015-12-04T17:30:56Z

Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6|7653|This function allows the to flash in the Windows taskbar.}} == Syntax == <syntaxhighlight lang="lua"> bool setWindowFlashing..."

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6|7653|This function allows the to flash in the Windows taskbar.}}

== Syntax ==
<syntaxhighlight lang="lua">
bool setWindowFlashing ( bool shouldFlash[, int count= 10] )
</syntaxhighlight>

=== Arguments ===
* '''shouldFlash:''' whether the window should flash
* '''count''' ''(optional)''''':''' the number of times the window should flash, defaults to '''10 times'''

=== Returns ===
Returns '''false''' if:
* the window is already in focus
* the client has disabled this feature
* ''count'' is ''0'' (flashing forever)

Returns '''true'' otherwise

== Example ==
A command that allows the player to flash their window three times after one second.
A command that allows the player to flash their window after a certain period of time for a certain count.
<syntaxhighlight lang="lua">
addCommandHandler("flash",
function(_, wait, count)
wait = tonumber(wait) -- makes "wait" a number, this will be false if it can't be converted
shouldFlash = type(wait) == "number" -- if wait is given, we should flash, otherwise we shouldn't
wait = wait or 5-- make wait default to 1 second if it isn't a number
count = tonumber(count) or 5 -- makes "count" a number, 5 if it can't be converted

setTimer(setWindowFlashing, wait*1000, 1, shouldFlash, count)
end
)
</syntaxhighlight>

== See also ==
{{Client utility functions}}

SetWindowFlashing - Revision history

Lopez at 18:37, 24 January 2016

Lopez at 15:45, 24 January 2016

Jusonex at 16:51, 14 January 2016

Qaisjp: remove infinite restriction

Qaisjp: spacing

Qaisjp: add another example

Qaisjp: fix typo

Qaisjp: fix typo

Qaisjp: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6|7653|This function allows the to flash in the Windows taskbar.}} == Syntax == bool setWindowFlashing..."

Qaisjp: Created page with "NOTOC {{Client function}} {{New feature/item|3.0160|1.6|7653|This function allows the to flash in the Windows taskbar.}} == Syntax == bool setWindowFlashing..."