WoW:API Region SetPoint: Difference between revisions

WoW:API Region SetPoint (source)

Revision as of 20:07, 13 August 2007

130 bytes removed , 13 August 2007

→‎Details

Anonymous user

WoWWiki>Starlightblunder

@@ Line 7: / Line 7: @@
 == Parameters ==
 === Arguments ===
+; point : The point on your object to use for attaching the obj (see [[API Positions]])  (i.e.  bind the left side of your frame)
-:; point
+; frame : Name of, or reference to, a frame to attach obj to; or nil to anchor relative to obj's parent (if no parent exists, anchor reative to the whole screen).
-:: The point on your object to use for attaching the obj (see [[API Positions]])  (i.e.  bind the left side of your frame)
+; relativePoint : The relative point of ''frame'' to attach ''obj'' to (see [[API Positions]]); if not specified, defaults to the value of ''point'' when not specified.
+; x : x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.
-:; frame
+; y : y-offset (negative values will move ''obj'' down, positive values will move ''obj'' up), defaults to 0 if not specified.
-:: The name of the frame to attach the obj to - an actual frame variable can also be used (can be "UIParent"), or nil to anchor relative to the whole screen.
-:: Defaults to the parent of ''obj'' when not specified, or the screen (not UIParent) when obj does not have a parent
-:; relativePoint
-:: The relative point to attach ''obj'' to (see [[API Positions]])  (i.e. bind your frame to the left side of the parent)
-:: Defaults to the value of ''point'' when not specified.
-:; x
-:: The X offset (-5 means 5 units left, 5 means 5 units right)
-:: Defaults to 0 when not specified
-:: Units are relative to the screen with the frame's effective scale.
-:; y
-:: The Y offset (-5 means 5 units down, 5 means 5 units up)
-:: Defaults to 0 when not specified
-:: Units are relative to the screen with the frame's effective scale.
-=== Returns ===
-:;nil
 == Examples ==
@@ Line 46: / Line 27: @@
 * You will have to do a <code>obj:[[API Region ClearAllPoints|ClearAllPoints]]()</code> before using obj:SetPoint(...), if you expect the frame to actually move. -- [[User:Maisha|Maisha]]
+* x and y units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, width varies with aspect ratio.
 * As of 1.11 or so, there seems to be an [[API Region SetPoint/Exponential time|exponential-time increase]] if you anchor chains of objects with more than one point.