WoW:API Region GetTop

From AddOn Studio
Revision as of 23:21, 8 November 2005 by WoWWiki>Jbcc
Jump to navigation Jump to search

This function returns the top edge of the frame in relation to the bottom of the screen. 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.

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