WoW:API Region GetPoint: Difference between revisions
Jump to navigation
Jump to search
m (→Returns) |
m (Move page script moved page API Region GetPoint to API Region GetPoint without leaving a redirect) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| 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. | |||
= | point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n) | ||
point | == 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 | |||
: [[UITYPE FramePoint|FramePoint]] -- attachment point of frame <tt>MyFrame</tt> | |||
relativeTo: The frame | ; relativeTo | ||
relativePoint: attachment point | : 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: | ; relativePoint | ||
yOfs: | : [[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() | |||
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 | |||
TOP | == 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. | |||
BOTTOM | |||
Latest revision as of 04:47, 15 August 2023
← Widget API ← Region < GetPoint
Returns information about the anchor points for a region.
point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)
Parameters[edit]
Arguments[edit]
- n
- integer - number of point about which you want to retrieve info. Should be in range 1 .. MyRegion:GetNumPoints()
Returns[edit]
- point
- FramePoint -- attachment point of frame MyFrame
- relativeTo
- Region -- The frame MyFrame is attached to (NOTE: this returns the actual widget object, if you want to get that object's name, use relativeTo:GetName())
- relativePoint
- FramePoint -- attachment point of the relativeTo frame
- xOfs
- number -- horizontal offset; not necessarily integer (positive xOfs means shift to the right)
- yOfs
- number -- vertical offset; not necessarily integer (positive yOfs means shift upwards)
Example[edit]
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
Notes[edit]
- 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.