WoW:API GetPlayerMapPosition: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Fixed arg list consistency)
(Changed back the valid arguments)
Line 9: Line 9:


:("unit")
:("unit")
:;unit : String - The [[API TYPE UnitId|UnitId]] for which the position is returned. (Verified for <tt>player</tt>, <tt>party</tt>*, <tt>target</tt> and <tt>mouseover</tt> (Though the latter two may only work for friendly players). Does not appear to work for <tt>pet</tt> (Tested with warlock)).
:;unit : String - The [[API TYPE UnitId|UnitId]] for which the position is returned. (Verified for <tt>player</tt>, <tt>party</tt>*. Does not appear to work for <tt>pet</tt> (Tested with warlock), <tt>target</tt> and <tt>mouseover</tt> - removed by Blizzard.)


----
----

Revision as of 13:11, 27 December 2004

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. (Verified for player, party*. Does not appear to work for pet (Tested with warlock), target and mouseover - removed by Blizzard.)

Returns
posX, posY
posX
Number - X value of the unit position (a proprotion 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.


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

Result
0.43320921063423, 0.69365233182907

Template:WoW API