WoW:API Region GetPoint: Difference between revisions

← Older edit

WoW:API Region GetPoint (source)

Revision as of 04:47, 15 August 2023

809 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ 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 ==
+ point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)
-point,relativeTo,relativePoint,xOfs,yOfs = Region:GetPoint()
+== Parameters ==
+=== 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 ==
+ 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)
-point,relativeTo,relativePoint,xOfs,yOfs = MyAddon_Frame1:GetPoint()<br>
+Result:
-DEFAULT_CHAT_FRAME:AddMessage(point)<br>
+ TOP
-DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName())<br>
+ MyAddon_Frame0
-DEFAULT_CHAT_FRAME:AddMessage(relativePoint)<br>
+ BOTTOM
-DEFAULT_CHAT_FRAME:AddMessage(xOfs)<br>
-DEFAULT_CHAT_FRAME:AddMessage(yOfs)<br>
+ -10
-== Result ==
-TOP<br>
+== Notes ==
-MyAddon_Frame0<br>
+* 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.
-BOTTOM<br>
-<br>
--10<br>