IsPlayerMapForced: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(This exists both clientside and serverside)
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}}

Revision as of 12:03, 15 January 2009

This function checks if the specified player's radar map has been forced on or not.

Syntax

Click to collapse [-]
Server
bool isPlayerMapForced ( player thePlayer )

Required Arguments

  • thePlayer: A player object referencing the specified player

Returns

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

Click to collapse [-]
Client
bool isPlayerMapForced ()

Returns

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

Example

Click to collapse [-]
Server

This example forces a players radar map on for 10 seconds if it hasn't been already. 

function forceMapForPlayer ( callingPlayer, command, whoNick )
	local who = getPlayerFromNick ( whoNick )                                   -- Look up the specified player
	if ( who ) then
		if ( not isPlayerMapForced ( who ) ) then                           -- if his radar map isn't already forced on
			forcePlayerMap ( who, true )                                -- force it on
			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
		else
			outputChatBox ( "Map already forced for " .. whoNick, callingPlayer ) -- if the map is already forced, output a message
		end
	else
		outputChatBox ( "Couldn't find " .. whoNick, callingPlayer )        -- if the player wasn't found, output a message
	end
end
addCommandHandler ( "forcemap", forceMapForPlayer ) -- add a command handler

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerMapForced?oldid=18134"