# Class Map [-] [+]

A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc.

Inherits all methods from: none

## Methods

Data | Returns a runtime-persistent cache tied to the Map. This data will remain for as long as the Map exists, or until a server restart.
GetAreaId | Returns the area ID of the Map at the specified X, Y, and Z coordinates.
GetDifficulty | Returns the difficulty of the Map.
GetHeight | Returns the height of the Map at the given X and Y coordinates.
GetInstanceData | Gets the instance data table for the Map, if it exists.
GetInstanceId | Returns the instance ID of the Map.
GetMapId | Returns the ID of the Map.
GetName | Returns the name of the Map.
GetPlayerCount | Returns the player count currently on the Map (excluding GMs).
GetPlayers | Returns a table with all the current Players in the map
GetWaterOrGroundLevel | Returns the water or ground level from the map for the given position.
GetWorldObject | Returns a WorldObject by its GUID from the map if it is spawned.
IsArena | Returns `true` if the Map is an arena BattleGround, `false` otherwise.
IsBattleground | Returns `true` if the Map is a non-arena BattleGround, `false` otherwise.
IsDungeon | Returns `true` if the Map is a dungeon, `false` otherwise.
IsEmpty | Returns `true` if the Map has no Players, `false` otherwise.
IsHeroic | Returns `true` if the Map is a heroic, `false` otherwise.
IsRaid | Returns `true` if the Map is a raid, `false` otherwise.
SaveInstanceData | Saves the Map's instance data to the database.
SetWeather | Sets the [Weather] type based on [WeatherType] and grade supplied.

# Keyboard shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

# Search tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct` (or `str`), `enum`, `trait`, `typedef` (or `tdef`).

Generated on
© 2010 - 2024 Eluna Lua Engine