WoW:API GetCurrentPosition: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(use removedapi template)
m (Move page script moved page API GetCurrentPosition to API GetCurrentPosition without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{removedapi|1.3.0|It was replaced by [[API_GetPlayerMapPosition|GetPlayerMapPosition]]}}
{{wowapi|removed=1.3.0|replace=Replaced by {{api|GetPlayerMapPosition}}}}


<center>'''GetCurrentPosition''' ''-Documentation by [[user:Pilum|Pilum]]-''</center>
Returns the position of a unit relative to the world.


Returns the postion of a unit relative to the world.
local loc = GetCurrentPosition("unit")


loc = GetCurrentPosition("unit");
== Parameters ==
=== Returns ===
* locY (number) - Y value of the player's position.
* locX (number) - X value of the player's position.
* locZ (number) - Z value of the player's position (0 is sea level).


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


:locY, locX, locZ as one string.
;Result
:;locY : Number - Y value of the player's position.
:;locX : Number - X value of the player's position.
:;locZ : Number - Z value of the player's position (0 is sea level).
 
----
;''Example''
local loc = GetCurrentPosition("player");
 
;''Result''
1773.85, 63.06, -46.32
1773.85, 63.06, -46.32


 
== Notes ==
 
* Removed in patch 1.3.0. Use the more specific {{api|GetPlayerMapPosition}} instead.
----
{{WoW API}}

Latest revision as of 04:45, 15 August 2023

WoW API < GetCurrentPosition

Returns the position of a unit relative to the world.

local loc = GetCurrentPosition("unit")

Parameters[edit]

Returns[edit]

  • locY (number) - Y value of the player's position.
  • locX (number) - X value of the player's position.
  • locZ (number) - Z value of the player's position (0 is sea level).

Example[edit]

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

1773.85, 63.06, -46.32

Notes[edit]