WoW:API Region GetLeft: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API Region GetLeft to API Region GetLeft without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This function returns the left edge of the frame in relation to the left of the screen.  As a frame moves to the right its return value for this function increases, as the frame moves to the left its return value decreases.  This function works for all frames including UIParent and WorldFrame.
#REDIRECT [[API Region GetBottom]] {{widgetmethod}}
 
This function is only guaranteed to work after the PLAYER_LOGIN event and then, only if the frame in question is being Shown.  Also, currently if you re-anchor a frame or Show a frame, you will need to wait up to a second before this function will return the correct new value.
 
Note: The values returned by this function are generally not nice whole numbers but are often close.
Example: 767.99994277954
 
----
;''Arguments''
 
:''none''
 
----
;''Returns''
 
:;number
 
Note: nil is returned if the frame has no anchor points (ie. frame was never positioned or :ClearAllPoints() has been called on the frame)
 
----
;''Example''
local playerFrameLeft = PlayerFrame:GetLeft();
----
 
==See also==
 
*[[API_Frame_GetTop|Frame:GetTop()]]
*[[API_Frame_GetBottom|Frame:GetBottom()]]
*[[API_Frame_GetRight|Frame:GetRight()]]
 
 
*[[Widget_Anchors|Widget Anchors]]
 
[[Category:API Functions|Frame GetLeft]]
[[Category:API Frame Functions|Frame GetLeft]]

Latest revision as of 04:47, 15 August 2023