WoW:API GetPlayerMapPosition: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
(Added minor info about the 0,0 error and SetMapToCurrentZone.)
Line 19: Line 19:
:;posY : Number - Y 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 0, then the position is unknown, unknowable, or not valid for the current map.
If both posX and posY are 0, then the position is unknown, unknowable, or not valid for the current map. This usually happens inside an instance, if the map hasn't been updated (by either opening the map or using [[API_SetMapToCurrentZone|SetMapToCurrentZone]]) after entering a new zone, or using a [[API TYPE UnitId|UnitId]] other than the ones above.


----
----

Revision as of 14:48, 28 November 2005

GetPlayerMapPosition -Documentation by Meog-


Returns the postion of a unit on the current map

posX, posY = GetPlayerMapPosition("unit");

Arguments
("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. This was to disable range-checking mods).

Returns
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 0, then the position is unknown, unknowable, or not valid for the current map. This usually happens inside an instance, if the map hasn't been updated (by either opening the map or using SetMapToCurrentZone) after entering a new zone, or using a UnitId other than the ones above.


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

Result
0.43320921063423, 0.69365233182907

Template:WoW API