WoW:API Region GetBottom - Revision history

Move page script: Move page script moved page API Region GetBottom to WoW:API Region GetBottom without leaving a redirect

2023-08-15T04:47:07Z

Move page script moved page API Region GetBottom to API Region GetBottom without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Mikk: Put all GetBottom/GetTop/GetLeft/GetRight in a single page. Silly to have separate pages. The others will now redirect to here.

2006-07-29T15:20:07Z

Put all GetBottom/GetTop/GetLeft/GetRight in a single page. Silly to have separate pages. The others will now redirect to here.

← Older revision		Revision as of 15:20, 29 July 2006
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}}~~

WoWWiki>Flickering: /* See also */

2006-03-29T00:41:16Z

See also

← Older revision		Revision as of 00:41, 29 March 2006
Line 1:		Line 1:
	This function returns the bottom 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 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.

	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.		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.
Line 25:		Line 25:
	==See also==		==See also==

	*[[~~API_Frame_GetTop~~\|~~Frame~~:GetTop()]]		*[[API_LayoutFrame_GetTop\|LayoutFrame:GetTop()]]
	*[[~~API_Frame_GetLeft~~\|~~Frame~~:GetLeft()]]		*[[API_LayoutFrame_GetLeft\|LayoutFrame:GetLeft()]]
	*[[~~API_Frame_GetRight~~\|~~Frame~~:GetRight()]]		*[[API_LayoutFrame_GetRight\|LayoutFrame:GetRight()]]

WoWWiki>Muert at 05:12, 4 January 2006

2006-01-04T05:12:14Z

← Older revision		Revision as of 05:12, 4 January 2006
Line 32:		Line 32:
	*[[Widget_Anchors\|Widget Anchors]]		*[[Widget_Anchors\|Widget Anchors]]

	~~[[Category:API Functions\|Frame GetBottom]]~~
	~~[[Category:~~API ~~Frame Functions\|Frame GetBottom]]~~		----
			{{WoW API}}

WoWWiki>Jbcc at 23:22, 8 November 2005

2005-11-08T23:22:02Z

@@ Line 1: / Line 1: @@
-Be carefull when using this function, this function returns nil if you use it when:
+This function returns the bottom 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 also may return nil in other situations, I've only tested this case.
+Note: The values returned by this function are generally not nice whole numbers but are often close.
 ==See also==

WoWWiki>Inglais at 13:03, 27 August 2005

2005-08-27T13:03:57Z

← Older revision		Revision as of 13:03, 27 August 2005
Line 16:		Line 16:

	*[[Widget_Anchors\|Widget Anchors]]		*[[Widget_Anchors\|Widget Anchors]]

			[[Category:API Functions\|Frame GetBottom]]
			[[Category:API Frame Functions\|Frame GetBottom]]

WoWWiki>Shag at 15:48, 17 July 2005

2005-07-17T15:48:51Z

New page

Be carefull when using this function, this function returns nil if you use it when:
* you handle the PLAYER_ENTERING_WORLD event
* the frame position has not been saved by WoW to layout-cache.txt.
* frame parent is UIParent

This function also may return nil in other situations, I've only tested this case.

==See also==

*[[API_Frame_GetTop|Frame:GetTop()]]
*[[API_Frame_GetLeft|Frame:GetLeft()]]
*[[API_Frame_GetRight|Frame:GetRight()]]

*[[Widget_Anchors|Widget Anchors]]