WoW:API GetPlayerMapPosition: Difference between revisions

Revision as of 08:48, 10 January 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

A one-time call to SetMapToCurrentZone() is required before GetPlayerMapPosition() will return the correct values.

Returns the position of a unit on the current map

posX, posY = GetPlayerMapPosition("unit");

unit: String - The unitId for which the position is returned. Does not work with all unit types. Works with "player", "partyN" or "raidN" as unit type. In particular, it does not work on pets. This was to disable range-checking mods.

posX, posY

posX: Number - X value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame)
posY: Number - Y value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame)

If both posX and posY are exactly 0, the position is unknown, unknowable, or not valid for the current map, i.e.

The player is inside of a classic instance. Northrend instance will return non-zero map coordinates, but classic instances will always return (0, 0).
The map hasn't been updated yet; either open the map or use SetMapToCurrentZone() after entering a new zone
An unsupported unitId was given.
You're actually at 0,0 in a given map, which although its unlikely, its perfectly possible and legal.

local posX, posY = GetPlayerMapPosition("player");

0.43320921063423, 0.69365233182907

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
-==Patch 3.0.2==
+==Initialization==
-NOTE: This appears to have issues with the advent of Patch 3.0.2
+A one-time call to [[API SetMapToCurrentZone|SetMapToCurrentZone]]() is required before GetPlayerMapPosition() will return the correct values.
-It seems to be only working intermittently.
-Until you open the world map, this always seems to return (0,0). <br>
-After you open and close the world map, the coords return the correct values. <br>
-Start your code with the following two lines in your OnInitialize Section: <br>
-WorldMapFrame:Show() <br>
-WorldMapFrame:Hide() <br>
 ==Usage==
@@ Line 29: / Line 21: @@
 : If both posX and posY are exactly 0, the position is unknown, unknowable, or not valid for the current map, i.e.
-:* The player is inside an instance: the game will never return coordinates inside an instance. (CHANGED AS OF 3.0.1 - coordinates are returned within instances) (CHANGED again AS OF 3.0.3 - coordinates are no longer returned inside instances) (CHANGED again. In 3.1.1 (possibly earlier) coordinates are being returned in instances.)
+:* The player is inside of a classic instance. Northrend instance will return non-zero map coordinates, but classic instances will always return (0, 0).
 :* The map hasn't been updated yet; either open the map or use [[API SetMapToCurrentZone|SetMapToCurrentZone]]() after entering a new zone
 :* An unsupported [[unitId]] was given.