WoW:API GetCurrentPosition: Difference between revisions

Revision as of 21:37, 12 February 2021

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

Returns the position of a unit relative to the world.

local loc = GetCurrentPosition("unit")

local locX, locY, locZ = GetCurrentPosition("player");
DEFAULT_CHAT_FRAME:AddMessage(locX .. ", " .. locY .. ", " .. locZ);

1773.85, 63.06, -46.32

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi|removed=1.3.0|replace=Replaced by {{api|GetPlayerMapPosition}}}}
-{{removedapi|1.3.0|Replaced by [[API_GetPlayerMapPosition|GetPlayerMapPosition]]}}
-Returns the postion of a unit relative to the world.
- loc = GetCurrentPosition("unit");
+Returns the position of a unit relative to the world.
-----
+ local loc = GetCurrentPosition("unit")
-;''Returns''
-:locY, locX, locZ as one string.
+== Parameters ==
-:;locY : Number - Y value of the player's position.
+=== Returns ===
-:;locX : Number - X value of the player's position.
+* locY (number) - Y value of the player's position.
-:;locZ : Number - Z value of the player's position (0 is sea level).
+* locX (number) - X value of the player's position.
+* locZ (number) - Z value of the player's position (0 is sea level).
-----
+== Example ==
-;''Example''
   local locX, locY, locZ = GetCurrentPosition("player");
   DEFAULT_CHAT_FRAME:AddMessage(locX .. ", " .. locY .. ", " .. locZ);
-;''Result''
+;Result
 .85, 63.06, -46.32
+== Notes ==
+* Removed in patch 1.3.0. Use the more specific {{api|GetPlayerMapPosition}} instead.