C_Map
namespaceavailable in: camelotStatus in wowlua
40 functions: 8 implemented, 18 recorded, 14 guessed. 7 events, 6 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
CanSetUserWaypointOnMap | Whether the player can place a map pin on a map. · by wowlua(uiMapID: number): boolean | recorded |
ClearUserWaypoint | Clears the currently assigned user waypoint, if one exists.() | guessed |
CloseWorldMapInteraction | Ends the current world map interaction. · by wowlua() | guessed |
GetAreaInfo | Returns a map subzone name.(areaID: number): string | implemented |
GetBestMapForUnit | Returns the current UI map for the given unit. Only works for the player and group members.(unitToken: string): number? | implemented |
GetBountySetMaps | Returns the maps for a bounty.(bountySetID: number): number[] | guessed |
GetFallbackWorldMapID | Returns the world map id.(): number | recorded |
GetMapArtBackgroundAtlas | Returns the background atlas for a map.(uiMapID: number): string | implemented |
GetMapArtHelpTextPosition | Returns the position for the "Click to Zoom In" hint text on flight maps.(uiMapID: number): MapCanvasPosition | recorded |
GetMapArtID | Returns the art for a (phased) map.(uiMapID: number): number? | recorded |
GetMapArtLayerTextures | Returns the art layer textures for a map.(uiMapID: number, layerIndex: number): number[]? | implemented |
GetMapArtLayers | Returns the art layers for a map.(uiMapID: number): UiMapLayerInfo[]? | recorded |
GetMapArtZoneTextPosition | Returns where a map shows its zone name. · by wowlua(uiMapID: number): MapCanvasPosition | recorded |
GetMapBannersForMap | Returns the poi banners for a map.(uiMapID: number): MapBannerInfo[] | recorded |
GetMapChildrenInfo | Returns info for the children of a map.(uiMapID: number, mapType: UIMapType?, allDescendants: boolean?): UiMapDetails[]? | implemented |
GetMapDisplayInfo | Returns whether group member pins should be hidden.(uiMapID: number): boolean? | recorded |
GetMapGroupID | Returns the map group for a map.(uiMapID: number): number? | recorded |
GetMapGroupMembersInfo | Returns the floors for a map group.(uiMapGroupID: number): UiMapGroupMemberInfo[]? | guessed |
GetMapHighlightInfoAtPosition | Returns a map highlight pin for a location.(uiMapID: number, x: number, y: number): (number?, string?, number?, number?, number?, number?, number?, number?) | guessed |
GetMapHighlightPulseInfo | Returns the highlight pulse shown on a map. · by wowlua(uiMapID: number): (number?, string?, number?, number?, number?, number?, number?, number?) | recorded |
GetMapInfo | Returns map information.(uiMapID: number): UiMapDetails? | recorded |
GetMapInfoAtPosition | Returns info for any child or adjacent maps at a position on the map.(uiMapID: number, x: number, y: number, ignoreZoneMapPositionData: boolean?): UiMapDetails? | guessed |
GetMapLevels | Returns the suggested player and battle pet levels for a map.(uiMapID: number): (number?, number?, number?, number?) | recorded |
GetMapLinksForMap | Returns the map pins that link to another map.(uiMapID: number): MapLinkInfo[] | recorded |
GetMapPosFromWorldPos | Translates a world map position to a map position.(continentID: number, worldPosition: Vector2DMixin, overrideUiMapID: number?): (number?, Vector2DMixin?) | implemented |
GetMapRectOnMap | Returns the map rectangle location for a map on its parent map.(uiMapID: number, topUiMapID: number): (number?, number?, number?, number?) | recorded |
GetMapWorldSize | Returns the size in yards of the area represented by the map.(uiMapID: number): (number, number) | recorded |
GetPlayerMapPosition | Returns the location of the unit on a map.(uiMapID: number, unitToken: string): Vector2DMixin? | implemented |
GetUserWaypoint | Returns the UiMapPoint structure for the currently assigned user waypoint, if one exists.(): UiMapPoint? | guessed |
GetUserWaypointFromHyperlink | Returns the map pin a link points to. · by wowlua(hyperlink: string): UiMapPoint? | guessed |
GetUserWaypointHyperlink | Returns a worldmap hyperlink for the currently assigned user waypoint, if one exists.(): string? | guessed |
GetUserWaypointPositionForMap | Returns the map position for a user waypoint that is placed on a specified map ID.(uiMapID: number): Vector2DMixin? | guessed |
GetWorldPosFromMapPos | Translates a map position to a world map position.(uiMapID: number, mapPosition: Vector2DMixin): (number?, Vector2DMixin?) | implemented |
HasUserWaypoint | Returns true if a user waypoint has been assigned.(): boolean | guessed |
IsCityMap | Whether a map is a city. · by wowlua(uiMapID: number): boolean | recorded |
IsMapValidForNavBarDropdown | Whether a map can appear in the world map's navigation bar dropdown. · by wowlua(uiMapID: number): boolean | recorded |
MapHasArt | Returns true if the map has art.(uiMapID: number): boolean | recorded |
OpenWorldMap | Opens the world map frame to a specified map ID.(uiMapID: number?) | guessed |
RequestPreloadMap | Preloads textures for a map.(uiMapID: number) | guessed |
SetUserWaypoint | Changes the user-assigned waypoint to the specified location, encoded as a UiMapPoint structure.(point: UiMapPoint): boolean | guessed |
"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.
Events
| event | payload | fired by the emulator |
|---|---|---|
NEW_WMO_CHUNK | no payload | implemented |
PLAYER_MAP_CHANGED | oldMapID: number, newMapID: number | implemented |
USER_WAYPOINT_UPDATED | no payload | implemented |
WORLD_MAP_OPEN | uiMapID: number? | not implemented |
ZONE_CHANGED | no payload | implemented |
ZONE_CHANGED_INDOORS | no payload | implemented |
ZONE_CHANGED_NEW_AREA | no payload | implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("WORLD_MAP_OPEN").
Structures
MapBannerInfo· areaPoiID, name, atlasName, uiTextureKit?MapLinkInfo· areaPoiID, position, name, atlasName, linkedUiMapIDUiMapDetails· mapID, name, mapType, parentMapID, flagsUiMapGroupMemberInfo· mapID, relativeHeightIndex, nameUiMapHighlightInfo· fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildYUiMapLayerInfo· layerWidth, layerHeight, tileWidth, tileHeight, minScale, maxScale, additionalZoomSteps
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (MapUI system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.