IsPlayerMapVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}
 
This function checks if the local player has their map showing
[[Image:MTAsa_Default_Map.png|thumb|224px|Screenshot of the default map]]
 
This function checks if the local player has their map showing (F11).


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


==Example==
==Example==
<syntaxhighlight lang="lua">
<section name="Example 1" class="client" show="true"><syntaxhighlight lang="lua">
function checkMap()
function checkMap()
if isPlayerMapVisible() then -- check if the player has his map visible
  local text = (isPlayerMapVisible() and "You are currently viewing your map!") or "Your map is not visible!"
outputChatBox("You are currently viewing your map!", 255, 255, 0) -- output text if it's visible
  outputChatBox(text, 255, 255, 0) -- output text  
else
outputChatBox("Your map is not visible!", 255, 255, 0) -- output text if it's not visible
end
end
end
addCommandHandler("map", checkMap) -- add '/map' command to the check
addCommandHandler("map", checkMap) -- add '/map' command to the check
</syntaxhighlight>
</syntaxhighlight></section>
 
<section name="Example 2" class="client" show="true"><syntaxhighlight lang="lua">
function showMap()
  if isPlayerMapVisible() then
      outputChatBox("Player-map closed", 0, 255, 0)
      forcePlayerMap(false)
  else
      outputChatBox("Viewing player-map", 0, 255, 0)
      forcePlayerMap(true)
  end
end
addCommandHandler("showmap", showMap)
</syntaxhighlight></section>


==See Also==
==See Also==
{{Client player functions}}
{{Client player functions}}

Latest revision as of 11:50, 9 November 2024

Screenshot of the default map

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

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("Player-map closed", 0, 255, 0)
      forcePlayerMap(false)
   else
      outputChatBox("Viewing player-map", 0, 255, 0)
      forcePlayerMap(true)
   end
end
addCommandHandler("showmap", showMap)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerMapVisible?oldid=81388"