WoW:API GetPlayerMapPosition: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 10: Line 10:


:("unit")
:("unit")
:;unit : String - The [[API TYPE UnitId|UnitId]] for which the position is returned. (Only works with <tt>player</tt> as unit type. This was to disable range-checking mods).
:;unit : String - The [[API TYPE UnitId|UnitId]] for which the position is returned. (Does not work with all unit types. Works with <tt>player</tt>, <tt>party<i>N</i></tt> or <tt>raid<i>N</i></tt> as unit type. This was to disable range-checking mods).


----
----
Line 16: Line 16:


:posX, posY
:posX, posY
:;posX : Number - X value of the unit position (a proprotion between 0 and 1, relative to WorldMapDetailFrame)
:;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)
:;posY : Number - Y value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame)



Revision as of 20:19, 10 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.


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

Result
0.43320921063423, 0.69365233182907

Template:WoW API