SetRadarAreaFlashing - Revision history

XLive at 08:58, 4 November 2020

2020-11-04T08:58:33Z

← Older revision		Revision as of 08:58, 4 November 2020
Line 36:		Line 36:
	function hill_Enter ( thePlayer, matchingDimension )		function hill_Enter ( thePlayer, matchingDimension )
	-- announce to everyone that the player entered the hill		-- announce to everyone that the player entered the hill
	outputChatBox( getPlayerName(thePlayer) .. " entered the zone!", ~~getRootElement()~~, 255, 255, 109 )		outputChatBox( getPlayerName(thePlayer) .. " entered the zone!", root, 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, true )		setRadarAreaFlashing ( hillRadar, true )
	end		end
Line 46:		Line 46:
	if isPlayerDead ( thePlayer ) ~= true then		if isPlayerDead ( thePlayer ) ~= true then
	-- if he was alive, announce to everyone that the player has left the hill		-- if he was alive, announce to everyone that the player has left the hill
	outputChatBox ( getPlayerName(thePlayer) .. " left the zone!", ~~getRootElement()~~, 255, 255, 109 )		outputChatBox ( getPlayerName(thePlayer) .. " left the zone!", root, 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, false )		setRadarAreaFlashing ( hillRadar, false )
	end		end

AlexTMjugador: Added OOP syntax

2014-11-26T17:38:02Z

Added OOP syntax

← Older revision		Revision as of 17:38, 26 November 2014
Line 7:		Line 7:
	bool setRadarAreaFlashing ( radararea theRadarArea, bool flash )		bool setRadarAreaFlashing ( radararea theRadarArea, bool flash )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[radararea]]:setFlashing\|flashing\|isRadarAreaFlashing}}

	===Required Arguments===		===Required Arguments===

Awwu: /* Example */

2009-08-27T12:10:25Z

Example

← Older revision		Revision as of 12:10, 27 August 2009
Line 35:		Line 35:
	function hill_Enter ( thePlayer, matchingDimension )		function hill_Enter ( thePlayer, matchingDimension )
	-- announce to everyone that the player entered the hill		-- announce to everyone that the player entered the hill
	outputChatBox( ~~getClientName~~(thePlayer) .. " entered the zone!", getRootElement(), 255, 255, 109 )		outputChatBox( getPlayerName(thePlayer) .. " entered the zone!", getRootElement(), 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, true )		setRadarAreaFlashing ( hillRadar, true )
	end		end
Line 45:		Line 45:
	if isPlayerDead ( thePlayer ) ~= true then		if isPlayerDead ( thePlayer ) ~= true then
	-- if he was alive, announce to everyone that the player has left the hill		-- if he was alive, announce to everyone that the player has left the hill
	outputChatBox ( ~~getClientName~~(thePlayer) .. " left the zone!", getRootElement(), 255, 255, 109 )		outputChatBox ( getPlayerName(thePlayer) .. " left the zone!", getRootElement(), 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, false )		setRadarAreaFlashing ( hillRadar, false )
	end		end

Arc at 17:14, 17 May 2008

2008-05-17T17:14:41Z

← Older revision		Revision as of 17:14, 17 May 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}
	This function makes an existing radar area flash in transparency.		This function makes an existing radar area flash in transparency.

Arc at 20:53, 15 August 2007

2007-08-15T20:53:33Z

← Older revision		Revision as of 20:53, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	This function makes an existing radar area flash in transparency.		This function makes an existing radar area flash in transparency.

Line 18:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local isFlashing = isRadarAreaFlashing ( someArea )		local isFlashing = isRadarAreaFlashing ( someArea )
	if isFlashing then -- if the area is already flashing...		if isFlashing then -- if the area is already flashing...
	outputChatBox ( "The radar area is already flashing." )		outputChatBox ( "The radar area is already flashing." )
	else -- it it isn't...		else -- if it isn't...
	setRadarAreaFlashing ( someArea, true ) -- make the area flash		setRadarAreaFlashing ( someArea, true ) -- make the area flash
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:'''This example creates a radar area for the ''King of the Hill'' script, and a colsquare. When the player enters the radar area flashes, it stops flashing when a player leaves.		'''Example 2:''' This example creates a radar area for the ''King of the Hill'' script, and a colsquare. When the player enters the radar area flashes, it stops flashing when a player leaves.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- create our hill area for our gamemode		-- create our hill area for our gamemode
Line 33:		Line 34:
	-- add hill_Enter as a handler for when a player enters the hill area		-- add hill_Enter as a handler for when a player enters the hill area
	function hill_Enter ( thePlayer, matchingDimension )		function hill_Enter ( thePlayer, matchingDimension )
	--announce to everyone that the player entered the hill		-- announce to everyone that the player entered the hill
	outputChatBox( getClientName(thePlayer).." entered the zone!", getRootElement(), 255, 255, 109, )		outputChatBox( getClientName(thePlayer) .. " entered the zone!", getRootElement(), 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, true )		setRadarAreaFlashing ( hillRadar, true )
	end		end
	addEventHandler ( "onColShapeHit", hillArea, hill_Enter )		addEventHandler ( "onColShapeHit", hillArea, hill_Enter )
Line 41:		Line 42:
	-- add hill_Enter as a handler for when a player leaves the hill area		-- add hill_Enter as a handler for when a player leaves the hill area
	function hill_Exit ( thePlayer, matchingDimension )		function hill_Exit ( thePlayer, matchingDimension )
	--check if the player is not dead		-- check if the player is not dead
	if isPlayerDead ( thePlayer ) ~= true then		if isPlayerDead ( thePlayer ) ~= true then
	--if he was alive, announce to everyone that the player has left the hill		-- if he was alive, announce to everyone that the player has left the hill
	outputChatBox ( getClientName(thePlayer).." left the zone!", getRootElement(), 255, 255, 109 )		outputChatBox ( getClientName(thePlayer) .. " left the zone!", getRootElement(), 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, false )		setRadarAreaFlashing ( hillRadar, false )
	end		end
	end		end
	addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )		addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )

Jbeta at 14:02, 16 July 2007

2007-07-16T14:02:48Z

← Older revision		Revision as of 14:02, 16 July 2007
Line 1:		Line 1:
	~~{{Needs_Checking\|Does it return false if the radararea is set to flash but already is flashing (and vice versa)? [[User:Erorr404\|Erorr404]]}}~~

	__NOTOC__		__NOTOC__
	~~Makes~~ an existing radar area flash in transparency.		This function makes an existing radar area flash in transparency.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setRadarAreaFlashing ( radararea ~~theRadararea~~, bool flash )		bool setRadarAreaFlashing ( radararea theRadarArea, bool flash )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~theRadararea~~:''' the radararea element.		*'''theRadarArea:''' the [[radararea]] element we want to change flashing state of.
	*'''flash:''' a bool indicating whether the radar area should flash (true to flash, false to not flash).		*'''flash:''' a bool indicating whether the radar area should flash (''true'' to flash, ''false'' to not flash).

	===Returns===		===Returns===
	Returns ''true'' if the ~~radar area~~ was ~~successfuly~~ set ~~to flash~~, ''false'' if the radar area doesn't exist.		Returns ''true'' if the new flash state was successfully set, ''false'' if the radar area doesn't exist or invalid arguments were passed.

	==Example==		==Example==
	'''Example 1:''' This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't:		'''Example 1:''' This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~flag~~ = isRadarAreaFlashing ( someArea )		local isFlashing = isRadarAreaFlashing ( someArea )
	if ~~( flag )~~ then -- if the area is already flashing...		if isFlashing then -- if the area is already flashing...
	outputChatBox ( "The radar area is already flashing." )		outputChatBox ( "The radar area is already flashing." )
	else -- it it isn't...		else -- it it isn't...
Line 27:		Line 25:
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:'''This example creates a radar area for the King of the ~~hill~~ script, and a colsquare. When the player enters the radar area flashes, it stops flashing when a player leaves.		'''Example 2:'''This example creates a radar area for the ''King of the Hill'' script, and a colsquare. When the player enters the radar area flashes, it stops flashing when a player leaves.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- create our hill area for our gamemode		-- create our hill area for our gamemode
Line 36:		Line 34:
	function hill_Enter ( thePlayer, matchingDimension )		function hill_Enter ( thePlayer, matchingDimension )
	--announce to everyone that the player entered the hill		--announce to everyone that the player entered the hill
	outputChatBox( getClientName(thePlayer).." entered the zone!", getRootElement(),255, 255, 109, )		outputChatBox( getClientName(thePlayer).." entered the zone!", getRootElement(), 255, 255, 109, )
	setRadarAreaFlashing ( hillRadar, true )		setRadarAreaFlashing ( hillRadar, true )
	end		end
Line 47:		Line 45:
	--if he was alive, announce to everyone that the player has left the hill		--if he was alive, announce to everyone that the player has left the hill
	outputChatBox ( getClientName(thePlayer).." left the zone!", getRootElement(), 255, 255, 109 )		outputChatBox ( getClientName(thePlayer).." left the zone!", getRootElement(), 255, 255, 109 )
	setRadarAreaFlashing ( hillRadar, false )		setRadarAreaFlashing ( hillRadar, false )
	end		end
	end		end

Talidan: new example & updated

2007-07-15T21:56:18Z

new example & updated

@@ Line 17: / Line 17: @@
 ==Example==
-This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't:
+'''Example 1:''' This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't:
 <syntaxhighlight lang="lua">
 flag = isRadarAreaFlashing ( someArea )
@@ Line 25: / Line 25: @@
     setRadarAreaFlashing ( someArea, true ) -- make the area flash
 end
 </syntaxhighlight>
 ==See Also==
 {{Radar area_functions}}

Erorr404 at 23:25, 10 September 2006

2006-09-10T23:25:58Z

← Older revision		Revision as of 23:25, 10 September 2006
Line 1:		Line 1:
	[[~~Category~~:~~Incomplete~~]]		{{Needs_Checking\|Does it return false if the radararea is set to flash but already is flashing (and vice versa)? [[User:Erorr404\|Erorr404]]}}

	__NOTOC__		__NOTOC__
	~~This fake function is for use with blah & blah and does blahblahblabhalbhl~~		Makes an existing radar area flash in transparency.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setRadarAreaFlashing ( ~~element~~ radararea, bool flash )		bool setRadarAreaFlashing ( radararea theRadararea, bool flash )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~argumentName~~:''' ~~description~~		*'''theRadararea:''' the radararea element.
			*'''flash:''' a bool indicating whether the radar area should flash (true to flash, false to not flash).
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' descriptiona
	*'''~~argumentName3~~:''' ~~description~~

	===Returns===		===Returns===
	Returns ''true'' if ~~blah~~, ''false'' ~~otherwise~~.		Returns ''true'' if the radar area was successfuly set to flash, ''false'' if the radar area doesn't exist.

	==Example==		==Example==
	This example ~~does...~~		This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does~~...		flag = isRadarAreaFlashing ( someArea )
	~~blabhalbalhb --abababa~~		if ( flag ) then -- if the area is already flashing...
	--~~This line does this~~...		outputChatBox ( "The radar area is already flashing." )
	~~mooo~~		else -- it it isn't...
			setRadarAreaFlashing ( someArea, true ) -- make the area flash
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~FunctionArea_Functions~~}}		{{Radar area_functions}}

Ransom at 22:31, 20 May 2006

2006-05-20T22:31:35Z

New page

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==
<syntaxhighlight lang="lua">
bool setRadarAreaFlashing ( element radararea, bool flash )
</syntaxhighlight>

===Required Arguments===
*'''argumentName:''' description

===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description

===Returns===
Returns ''true'' if blah, ''false'' otherwise.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}