WoW:API Region GetPoint - Revision history

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

2023-08-15T04:47:07Z

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

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 22:21, 17 January 2015

2015-01-17T22:21:36Z

← Older revision		Revision as of 22:21, 17 January 2015
Line 1:		Line 1:
	{{widgetmethod}} __NOTOC__		{{widgetmethod}} __NOTOC__
			Returns information about the anchor points for a region.

	~~Returns information about the anchor points for a region.~~
	point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)		point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)

	== Arguments ==		== Parameters ==
			=== Arguments ===
	; n		; n
	: integer - number of point about which you want to retrieve info. Should be in range <tt>1 .. MyRegion:GetNumPoints()</tt>		: integer - number of point about which you want to retrieve info. Should be in range <tt>1 .. MyRegion:GetNumPoints()</tt>

	== Returns ==		=== Returns ===
	; point		; point
	: [[UITYPE FramePoint\|FramePoint]] -- attachment point of frame <tt>MyFrame</tt>		: [[UITYPE FramePoint\|FramePoint]] -- attachment point of frame <tt>MyFrame</tt>
Line 21:		Line 22:

	== Example ==		== Example ==

	point, relativeTo, relativePoint, xOfs, yOfs = MyAddon_Frame1:GetPoint()		point, relativeTo, relativePoint, xOfs, yOfs = MyAddon_Frame1:GetPoint()
	DEFAULT_CHAT_FRAME:AddMessage(point)		DEFAULT_CHAT_FRAME:AddMessage(point)
Line 30:		Line 30:

	Result:		Result:

	TOP		TOP
	MyAddon_Frame0		MyAddon_Frame0
Line 37:		Line 36:
	-10		-10

	== ~~Details~~ ==		== Notes ==

	* As of 2.2 the screen coordinates are no longer relative to the TOPLEFT instead they are relative to closest screen position which can be TOPLEFT, TOP, TOPRIGHT, LEFT, CENTER, RIGHT, BOTTOMLEFT, BOTTOM and BOTTOMRIGHT be sure to use/save the relativePoint argument in addition to xOfs and yOfs for frame positioning or your frames will appear at the wrong place and even off the screen.		* As of 2.2 the screen coordinates are no longer relative to the TOPLEFT instead they are relative to closest screen position which can be TOPLEFT, TOP, TOPRIGHT, LEFT, CENTER, RIGHT, BOTTOMLEFT, BOTTOM and BOTTOMRIGHT be sure to use/save the relativePoint argument in addition to xOfs and yOfs for frame positioning or your frames will appear at the wrong place and even off the screen.

WoWWiki>Thecrazy at 20:06, 3 October 2007

2007-10-03T20:06:31Z

← Older revision		Revision as of 20:06, 3 October 2007
Line 36:		Line 36:
	0		0
	-10		-10

			== Details ==

			* As of 2.2 the screen coordinates are no longer relative to the TOPLEFT instead they are relative to closest screen position which can be TOPLEFT, TOP, TOPRIGHT, LEFT, CENTER, RIGHT, BOTTOMLEFT, BOTTOM and BOTTOMRIGHT be sure to use/save the relativePoint argument in addition to xOfs and yOfs for frame positioning or your frames will appear at the wrong place and even off the screen.

WoWWiki>Fibby at 01:41, 27 September 2007

2007-09-27T01:41:57Z

← Older revision		Revision as of 01:41, 27 September 2007
Line 1:		Line 1:
	{{widgetmethod}} __NOTOC__ ~~Returns information about the anchor points for a region.~~		{{widgetmethod}} __NOTOC__

	=~~= Usage ==~~		Returns information about the anchor points for a region.
			point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)

	point~~,relativeTo,relativePoint,xOfs,yOfs = Region~~:~~GetPoint~~()		== Arguments ==
			; n
			: integer - number of point about which you want to retrieve info. Should be in range <tt>1 .. MyRegion:GetNumPoints()</tt>

	== Returns ==		== Returns ==
			; point
	~~point~~: attachment point ~~for this~~ frame<br>		: [[UITYPE FramePoint\|FramePoint]] -- attachment point of frame <tt>MyFrame</tt>
	relativeTo: The frame ~~this frame~~ is attached to (NOTE: this returns the actual widget object, so you ~~need~~ to use "relativeTo:GetName()~~" to retrieve the object name itself~~<br>		; relativeTo
	relativePoint: attachment point ~~for~~ the 'relativeTo~~' frame~~<br>		: Region -- The frame <tt>MyFrame</tt> is attached to (NOTE: this returns the actual widget object, if you want to get that object's name, use <tt>relativeTo:GetName()</tt>)
	xOfs: x offset<br>		; relativePoint
	yOfs: y offset<br>		: [[UITYPE FramePoint\|FramePoint]] -- attachment point of the <tt>relativeTo</tt> frame
			; xOfs
			: number -- horizontal offset; not necessarily integer (positive <tt>xOfs</tt> means shift to the right)
			; yOfs
			: number -- vertical offset; not necessarily integer (positive <tt>yOfs</tt> means shift upwards)

	== Example ==		== Example ==

	point,relativeTo,relativePoint,xOfs,yOfs = MyAddon_Frame1:GetPoint()~~<br>~~		point, relativeTo, relativePoint, xOfs, yOfs = MyAddon_Frame1:GetPoint()
	DEFAULT_CHAT_FRAME:AddMessage(point)~~<br>~~		DEFAULT_CHAT_FRAME:AddMessage(point)
	DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName())~~<br>~~		DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName())
	DEFAULT_CHAT_FRAME:AddMessage(relativePoint)~~<br>~~		DEFAULT_CHAT_FRAME:AddMessage(relativePoint)
	DEFAULT_CHAT_FRAME:AddMessage(xOfs)~~<br>~~		DEFAULT_CHAT_FRAME:AddMessage(xOfs)
	DEFAULT_CHAT_FRAME:AddMessage(yOfs)~~<br>~~		DEFAULT_CHAT_FRAME:AddMessage(yOfs)

	== Result ==		Result:

	TOP~~<br>~~		TOP
	MyAddon_Frame0~~<br>~~		MyAddon_Frame0
	BOTTOM~~<br>~~		BOTTOM
	0~~<br>~~		0
	-10~~<br>~~		-10

WoWWiki>Delee at 00:58, 12 November 2006

2006-11-12T00:58:51Z

← Older revision		Revision as of 00:58, 12 November 2006
Line 1:		Line 1:
	{{widgetmethod}} __NOTOC__ Returns information about the anchor points for a region		{{widgetmethod}} __NOTOC__ Returns information about the anchor points for a region.

	== Usage ==		== Usage ==

WoWWiki>Jncl: /* Returns */

2006-09-13T21:32:09Z

Returns

← Older revision		Revision as of 21:32, 13 September 2006
Line 8:		Line 8:

	point: attachment point for this frame<br>		point: attachment point for this frame<br>
	relativeTo: The frame this frame is attached to (NOTE: this returns the actual widget object, so you need to use "relativeTo:GetName()" to ~~retreive~~ the object name itself<br>		relativeTo: The frame this frame is attached to (NOTE: this returns the actual widget object, so you need to use "relativeTo:GetName()" to retrieve the object name itself<br>
	relativePoint: attachment point for the 'relativeTo' frame<br>		relativePoint: attachment point for the 'relativeTo' frame<br>
	xOfs: x offset<br>		xOfs: x offset<br>

WoWWiki>Jakobud at 08:39, 20 August 2006

2006-08-20T08:39:45Z

New page

{{widgetmethod}} __NOTOC__ Returns information about the anchor points for a region

== Usage ==

point,relativeTo,relativePoint,xOfs,yOfs = Region:GetPoint()

== Returns ==

point: attachment point for this frame 
relativeTo: The frame this frame is attached to (NOTE: this returns the actual widget object, so you need to use "relativeTo:GetName()" to retreive the object name itself 
relativePoint: attachment point for the 'relativeTo' frame 
xOfs: x offset 
yOfs: y offset 

== Example ==

point,relativeTo,relativePoint,xOfs,yOfs = MyAddon_Frame1:GetPoint() 
DEFAULT_CHAT_FRAME:AddMessage(point) 
DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName()) 
DEFAULT_CHAT_FRAME:AddMessage(relativePoint) 
DEFAULT_CHAT_FRAME:AddMessage(xOfs) 
DEFAULT_CHAT_FRAME:AddMessage(yOfs) 

== Result ==

TOP 
MyAddon_Frame0 
BOTTOM 
0 
-10