IsPlayerMapVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
This function checks if the local player has their map showing
 
[[Image:MTAsa_Default_Map.png|thumb|200px|Screenshot of the default map]]
 
This function checks if the local player has their map showing.


==Syntax==
==Syntax==
Line 8: Line 11:
===Returns===
===Returns===
Returns ''true'' if the player has the map visible, ''false'' otherwise.
Returns ''true'' if the player has the map visible, ''false'' otherwise.
[[File:MTAsa_Default_Map.png|400px|thumb|left|MTA:SA Default Map]]


==Example==
==Example==

Revision as of 16:20, 23 June 2018

Screenshot of the default map

This function checks if the local player has their map showing.

Syntax

bool isPlayerMapVisible ()

Returns

Returns true if the player has the map visible, false otherwise.

Example

Click to collapse [-]
Example 1
function checkMap()
   local text = (isPlayerMapVisible() and "You are currently viewing your map!") or "Your map is not visible!"
   outputChatBox(text, 255, 255, 0) -- output text 
end
addCommandHandler("map", checkMap) -- add '/map' command to the check
Click to collapse [-]
Example 2
function showMap()
   if isPlayerMapVisible() then
      outputChatBox("Radar closed", 0, 255, 0)
      forcePlayerMap(false)
   else
      outputChatBox("Viewing radar", 0, 255, 0)
      forcePlayerMap(true)
   end
end
addCommandHandler("showmap", showMap)

See Also