WoW:API Region GetTop: Difference between revisions

Revision as of 15:21, 29 July 2006

Redirect to:

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

@@ Line 1: / Line 1: @@
-This function returns the top edge of the frame in relation to the bottom of the screen, scaled with the frame's effective scale.  As a frame moves up its return value for this function increases, as the frame moves down 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 playerFrameTop = PlayerFrame:GetTop();
-----
-==See also==
-*[[API_LayoutFrame_GetLeft|LayoutFrame:GetLeft()]]
-*[[API_LayoutFrame_GetBottom|LayoutFrame:GetBottom()]]
-*[[API_LayoutFrame_GetRight|LayoutFrame:GetRight()]]
-*[[Widget_Anchors|Widget Anchors]]
-----
-{{WoW API}}