WoW:API Region GetBottom: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API Region GetBottom to API Region GetBottom without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
This function returns the bottom 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.
{{widgetmethod}} __NOTOC__


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.
Returns the distance from the bottom/left edge of the screen to the requested edge of an object, scaled with the objects's effective scale.  


Note: The values returned by this function are generally not nice whole numbers but are often close.
offset = MyObject:GetBottom();
Example: 767.99994277954
offset = MyObject:GetTop();
offset = MyObject:GetLeft();
offset = MyObject:GetRight();


----
== Returns ==
;''Arguments''


:''none''
:;offset: Number - distance between the bottom or left side of screen, respectively, to the requested edge of the object, in pixels, scaled according to effective scale. Or '''nil''' if the object has not been positioned, or [[API Region ClearAllPoints|:ClearAllPoints]]() has been called on it.


----
== Notes ==
;''Returns''
As an object moves towards the top of the screen, the return values for GetTop/GetBottom increase. As an object moves toward the right, the return values for GetLeft/GetRight increase. This function works for all objects including UIParent and WorldFrame.


:;number
This function is only guaranteed to work after the PLAYER_LOGIN event and then, only if the object in question is being Shown.  Also, currently if you re-anchor an object or Show it, you will need to wait until after the next [[UIHANDLER OnUpdate|OnUpdate]] event before this function will return the correct new value.


Note: nil is returned if the frame has no anchor points (ie. frame was never positioned or :ClearAllPoints() has been called on the frame)
The values returned by this function are generally not nice whole numbers but are often close. Example: 767.99994277954. Use <tt>floor(bottom + 0.5)</tt> to make integer.


----
;''Example''
local playerFrameBottom = PlayerFrame:GetBottom();
----


==See also==
== Example ==
 
*[[API_LayoutFrame_GetTop|LayoutFrame:GetTop()]]
*[[API_LayoutFrame_GetLeft|LayoutFrame:GetLeft()]]
*[[API_LayoutFrame_GetRight|LayoutFrame:GetRight()]]


local playerFrameBottom = PlayerFrame:GetBottom();
local playerFrameTop    = PlayerFrame:GetTop();
local playerFrameLeft  = PlayerFrame:GetLeft();
local playerFrameRight  = PlayerFrame:GetRight();
playerFrameBottom: 650
playerFrameTop:    780
playerFrameLeft:    20
playerFrameRight:  180


*[[Widget_Anchors|Widget Anchors]]


== See also ==


----
*[[Widget Anchors]]
{{WoW API}}

Latest revision as of 04:47, 15 August 2023

← Widget API ← Region < GetBottom

Returns the distance from the bottom/left edge of the screen to the requested edge of an object, scaled with the objects's effective scale. 

offset = MyObject:GetBottom();
offset = MyObject:GetTop();
offset = MyObject:GetLeft();
offset = MyObject:GetRight();

Returns[edit]

offset
Number - distance between the bottom or left side of screen, respectively, to the requested edge of the object, in pixels, scaled according to effective scale. Or nil if the object has not been positioned, or :ClearAllPoints() has been called on it.

Notes[edit]

As an object moves towards the top of the screen, the return values for GetTop/GetBottom increase. As an object moves toward the right, the return values for GetLeft/GetRight increase. This function works for all objects including UIParent and WorldFrame.

This function is only guaranteed to work after the PLAYER_LOGIN event and then, only if the object in question is being Shown. Also, currently if you re-anchor an object or Show it, you will need to wait until after the next OnUpdate event before this function will return the correct new value.

The values returned by this function are generally not nice whole numbers but are often close. Example: 767.99994277954. Use floor(bottom + 0.5) to make integer.


Example[edit]

local playerFrameBottom = PlayerFrame:GetBottom();
local playerFrameTop    = PlayerFrame:GetTop();
local playerFrameLeft   = PlayerFrame:GetLeft();
local playerFrameRight  = PlayerFrame:GetRight();

playerFrameBottom: 650
playerFrameTop:    780
playerFrameLeft:    20
playerFrameRight:  180


See also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_Region_GetBottom&oldid=19686"