IsPlayerMapForced - Revision history

Fernando187 at 11:53, 9 November 2024

2024-11-09T11:53:07Z

← Older revision		Revision as of 11:53, 9 November 2024
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function checks if the specified player's ~~radar~~ map has been forced on or not.		This function checks if the specified player's map (F11) has been forced on or not.

	==Syntax==		==Syntax==
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns ''true'' if the player's ~~radar~~ map is forced on, ''false'' otherwise.		Returns ''true'' if the player's map is forced on, ''false'' otherwise.
	</section>		</section>
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
Line 17:		Line 17:
	{{OOP\|\|[[Player]].isMapForced\|\|forcePlayerMap}}		{{OOP\|\|[[Player]].isMapForced\|\|forcePlayerMap}}
	===Returns===		===Returns===
	Returns ''true'' if the local player's ~~radar~~ map is forced on, ''false'' otherwise.		Returns ''true'' if the local player's map is forced on, ''false'' otherwise.
	</section>		</section>

	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example forces a ~~players radar~~ map on for 10 seconds if it hasn't been already.		This example forces a player's map on for 10 seconds if it hasn't been already.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function forceMapForPlayer ( callingPlayer, command, whoNick )		function forceMapForPlayer ( callingPlayer, command, whoNick )
	local who = getPlayerFromName ( whoNick ) -- Look up the specified player		local who = getPlayerFromName ( whoNick ) -- Look up the specified player
	if ( who ) then		if ( who ) then
	if ( not isPlayerMapForced ( who ) ) then -- if ~~his radar~~ map isn't already forced on		if ( not isPlayerMapForced ( who ) ) then -- if their map isn't already forced on
	forcePlayerMap ( who, true ) -- force it on		forcePlayerMap ( who, true ) -- force it on
	setTimer ( forcePlayerMap, 10000, 1, who, false ) -- force it off in 10secs		setTimer ( forcePlayerMap, 10000, 1, who, false ) -- force it off in 10secs

Qaisjp: fix oop syntax

2014-12-29T04:27:09Z

fix oop syntax

← Older revision		Revision as of 04:27, 29 December 2014
Line 15:		Line 15:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">bool isPlayerMapForced ()</syntaxhighlight>		<syntaxhighlight lang="lua">bool isPlayerMapForced ()</syntaxhighlight>
	{{OOP\|\|[[Player]].isMapForced\|~~mapForced~~\|forcePlayerMap}}		{{OOP\|\|[[Player]].isMapForced\|\|forcePlayerMap}}
	===Returns===		===Returns===
	Returns ''true'' if the local player's radar map is forced on, ''false'' otherwise.		Returns ''true'' if the local player's radar map is forced on, ''false'' otherwise.

Strix: add client oop syntax

2014-12-28T23:21:03Z

add client oop syntax

← Older revision		Revision as of 23:21, 28 December 2014
Line 15:		Line 15:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">bool isPlayerMapForced ()</syntaxhighlight>		<syntaxhighlight lang="lua">bool isPlayerMapForced ()</syntaxhighlight>
			{{OOP\|\|[[Player]].isMapForced\|mapForced\|forcePlayerMap}}
	===Returns===		===Returns===
	Returns ''true'' if the local player's radar map is forced on, ''false'' otherwise.		Returns ''true'' if the local player's radar map is forced on, ''false'' otherwise.

MarioKart: /* Syntax */ OOP syntax added

2014-07-15T05:14:13Z

Syntax: OOP syntax added

← Older revision		Revision as of 05:14, 15 July 2014
Line 6:		Line 6:
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">bool isPlayerMapForced ( player thePlayer )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isPlayerMapForced ( player thePlayer )</syntaxhighlight>
			{{OOP\|\|[[player]]:isMapForced\|mapForced\|forcePlayerMap}}
	===Required Arguments===		===Required Arguments===
	* '''thePlayer:''' A [[player]] object referencing the specified player		* '''thePlayer:''' A [[player]] object referencing the specified player

VWOer at 16:16, 22 November 2011

2011-11-22T16:16:30Z

← Older revision		Revision as of 16:16, 22 November 2011
Line 25:		Line 25:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function forceMapForPlayer ( callingPlayer, command, whoNick )		function forceMapForPlayer ( callingPlayer, command, whoNick )
	local who = ~~getPlayerFromNick~~ ( whoNick ) -- Look up the specified player		local who = getPlayerFromName ( whoNick ) -- Look up the specified player
	if ( who ) then		if ( who ) then
	if ( not isPlayerMapForced ( who ) ) then -- if his radar map isn't already forced on		if ( not isPlayerMapForced ( who ) ) then -- if his radar map isn't already forced on

Talidan: This exists both clientside and serverside

2009-01-15T12:03:32Z

This exists both clientside and serverside

← Older revision		Revision as of 12:03, 15 January 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}
	This function checks if the specified player's radar map has been forced on or not.		This function checks if the specified player's radar map has been forced on or not.

	==Syntax==		==Syntax==
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">bool isPlayerMapForced ( player thePlayer )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isPlayerMapForced ( player thePlayer )</syntaxhighlight>

Line 11:		Line 12:
	===Returns===		===Returns===
	Returns ''true'' if the player's radar map is forced on, ''false'' otherwise.		Returns ''true'' if the player's radar map is forced on, ''false'' otherwise.
			</section>
			<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">bool isPlayerMapForced ()</syntaxhighlight>

			===Returns===
			Returns ''true'' if the local player's radar map is forced on, ''false'' otherwise.
			</section>

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example forces a players radar map on for 10 seconds if it hasn't been already.		This example forces a players radar map on for 10 seconds if it hasn't been already.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 31:		Line 40:
	addCommandHandler ( "forcemap", forceMapForPlayer ) -- add a command handler		addCommandHandler ( "forcemap", forceMapForPlayer ) -- add a command handler
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

Arc at 20:03, 16 August 2007

2007-08-16T20:03:21Z

← Older revision		Revision as of 20:03, 16 August 2007
Line 21:		Line 21:
	forcePlayerMap ( who, true ) -- force it on		forcePlayerMap ( who, true ) -- force it on
	setTimer ( forcePlayerMap, 10000, 1, who, false ) -- force it off in 10secs		setTimer ( forcePlayerMap, 10000, 1, who, false ) -- force it off in 10secs
	outputChatBox("Forcing Map for " .. whoNick, callingPlayer) -- output a message to the one who entered the command		outputChatBox ( "Forcing Map for " .. whoNick, callingPlayer ) -- output a message to the one who entered the command
	else		else
	outputChatBox("Map already forced for " .. whoNick, callingPlayer) -- if the map is already forced, output a message		outputChatBox ( "Map already forced for " .. whoNick, callingPlayer ) -- if the map is already forced, output a message
	end		end
	else		else
	outputChatBox("Couldn't find " .. whoNick,callingPlayer) -- if the player wasn't found, output a message		outputChatBox ( "Couldn't find " .. whoNick, callingPlayer ) -- if the player wasn't found, output a message
	end		end
	end		end
	addCommandHandler("~~forceMap~~", forceMapForPlayer) -- add a command handler		addCommandHandler ( "forcemap", forceMapForPlayer ) -- add a command handler
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

Arc at 20:00, 16 August 2007

2007-08-16T20:00:39Z

← Older revision		Revision as of 20:00, 16 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	This function checks if the specified player's radar-map has been forced on or not.		This function checks if the specified player's radar map has been forced on or not.

	==Syntax==		==Syntax==
Line 7:		Line 7:

	===Required Arguments===		===Required Arguments===
	* '''thePlayer''': A [[player]] object referencing the specified player		* '''thePlayer:''' A [[player]] object referencing the specified player

	===Returns===		===Returns===
	Returns ''true'' if the player's radar-map is forced on, ''false'' otherwise.		Returns ''true'' if the player's radar map is forced on, ''false'' otherwise.

	==Example==		==Example==
	This example forces a players radar-map on for ~~10seconds~~ if it ~~hasnt~~ been already		This example forces a players radar map on for 10 seconds if it hasn't been already.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function forceMapForPlayer(callingPlayer,command,~~who~~)		function forceMapForPlayer ( callingPlayer, command, whoNick )
	~~player~~ = getPlayerFromNick ( ~~who~~ ) -- ~~do we have a~~ player ~~named "dave"~~		local who = getPlayerFromNick ( whoNick ) -- Look up the specified player
	if ( ~~player~~ ) then		if ( who ) then
	if ( isPlayerMapForced ( ~~player~~ ) ~~== false~~ ) then -- if his radar-map isn't already forced on		if ( not isPlayerMapForced ( who ) ) then -- if his radar map isn't already forced on
	forcePlayerMap ( ~~player~~, true ) -- force it on		forcePlayerMap ( who, true ) -- force it on
	setTimer ( forcePlayerMap, 10000, 1, ~~player~~, false ) -- force it off in 10secs		setTimer ( forcePlayerMap, 10000, 1, who, false ) -- force it off in 10secs
	outputChatBox("Forcing Map for "..~~who~~,callingPlayer) -- output a message to the one who entered the command		outputChatBox("Forcing Map for " .. whoNick, callingPlayer) -- output a message to the one who entered the command
	else		else
	outputChatBox("Map already forced for "..~~who~~,callingPlayer) -- if the map is already forced, output a message		outputChatBox("Map already forced for " .. whoNick, callingPlayer) -- if the map is already forced, output a message
	end		end
	else		else
	outputChatBox("Couldn't find "..~~who~~,callingPlayer) -- if the player wasn't found, output a message		outputChatBox("Couldn't find " .. whoNick,callingPlayer) -- if the player wasn't found, output a message
	end		end
	end		end

Driver2 at 12:03, 7 August 2007

2007-08-07T12:03:11Z

← Older revision		Revision as of 12:03, 7 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	This function checks if the specified player's radar-map has been forced on or not.		This function checks if the specified player's radar-map has been forced on or not.

Driver2 at 18:35, 30 July 2007

2007-07-30T18:35:12Z

← Older revision		Revision as of 18:35, 30 July 2007
Line 14:		Line 14:
	This example forces a players radar-map on for 10seconds if it hasnt been already		This example forces a players radar-map on for 10seconds if it hasnt been already
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	player = ~~getPlayerByNick~~ ( ~~"dave"~~ ) -- do we have a player named "dave"		function forceMapForPlayer(callingPlayer,command,who)
	if ( player ) then		player = getPlayerFromNick ( who ) -- do we have a player named "dave"
	if ( isPlayerMapForced ( player ) == false ) then -- if his radar-map isn't already forced on		if ( player ) then
	forcePlayerMap ( player, true ) -- force it on		if ( isPlayerMapForced ( player ) == false ) then -- if his radar-map isn't already forced on
	setTimer ( "forcePlayerMap", 10000, 1, false ) -- force it off in 10secs		forcePlayerMap ( player, true ) -- force it on
	end		setTimer ( forcePlayerMap, 10000, 1, player, false ) -- force it off in 10secs
			outputChatBox("Forcing Map for "..who,callingPlayer) -- output a message to the one who entered the command
			else
			outputChatBox("Map already forced for "..who,callingPlayer) -- if the map is already forced, output a message
			end
			else
			outputChatBox("Couldn't find "..who,callingPlayer) -- if the player wasn't found, output a message
			end
	end		end
			addCommandHandler("forceMap", forceMapForPlayer) -- add a command handler
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}