IsPlayerMapVisible

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

• forcePlayerMap
• getLocalPlayer
• getPlayerBlurLevel
• getPlayerFromName
• getPlayerMapBoundingBox
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerTeam
• getPlayerWantedLevel
• givePlayerMoney
• isPlayerHudComponentVisible
• isPlayerMapForced
• isPlayerMapVisible
• isPlayerNametagShowing
• isVoiceEnabled
• setPlayerBlurLevel
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• takePlayerMoney