WoW:API GameTooltip SetOwner: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{widgetmethod}})
m (Move page script moved page API GameTooltip SetOwner to API GameTooltip SetOwner without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}
<center>'''GameTooltip:SetOwner''' ''-Documentation by [[user:Xenoveritas|Xenoveritas]]-''</center>
<center>''-Edited by [[user:ThePooBurner|ThePooBurner]]-''</center>
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
GameTooltip:SetOwner(owner, "anchor"&#91;, +x, +y&#93;);
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Moves the game tooltip to a location based on the "owner" frame.
Moves the game tooltip to a location based on the "owner" frame.
GameTooltip:SetOwner(owner, "anchor"&#91;, +x, +y&#93;);


----
----
;''Arguments''
;''Arguments''
<!-- List each argument, together with its type -->


:(owner, "Anchor"&#91;, +x, +y&#93;)
:(owner, "Anchor"&#91;, +x, +y&#93;)
:;owner : Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use getglobal() to get the pointer from the frame name).
:;owner : Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use _G['MyFrame'] to get the pointer from the frame name).
:;anchor : String - a string that describes the anchor point as it would be set via the SetPoint() function.  Anchoring meathods as follows:
:;anchor : String - a string that describes the anchor point as it would be set via the SetPoint() function.  Anchoring methods as follows:
::ANCHOR_TOPRIGHT    -------    SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")
::ANCHOR_TOPRIGHT    -------    SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")
::ANCHOR_RIGHT      -------  SetPoint("BOTTOMLEFT",object,"TOPRIGHT")
::ANCHOR_RIGHT      -------  SetPoint("BOTTOMLEFT",object,"TOPRIGHT")
Line 28: Line 17:
::ANCHOR_CURSOR
::ANCHOR_CURSOR
::ANCHOR_PRESERVE
::ANCHOR_PRESERVE
::ANCHOR_NONE


You can also move the tooltip by x or y, where positive x is to the right and positive y is up. Thus, negative x is to the left and negative y is down. Doesn't work if anchor is ANCHOR_CURSOR.
You can also move the tooltip by x or y, where positive x is to the right and positive y is up. Thus, negative x is to the left and negative y is down. Doesn't work if anchor is ANCHOR_CURSOR.
Line 34: Line 24:
;''Returns''
;''Returns''


<!-- List each return value, together with its type -->
: Nothing.
: Nothing?


----
----
;''Details''
;''Details''
<!-- Details not appropriate for the main description can go here -->


: This will set the owner for tooltip:IsOwned(frame). For instance, first call GameTooltip:SetOwner(UIParent). Then GameTooltip:IsOwned(UIParent) will return 1.
: This will set the owner for tooltip:IsOwned(frame). For instance, first call GameTooltip:SetOwner(UIParent). Then GameTooltip:IsOwned(UIParent) will return 1.

Latest revision as of 04:45, 15 August 2023

Widget API ← GameTooltip < SetOwner

Moves the game tooltip to a location based on the "owner" frame.

GameTooltip:SetOwner(owner, "anchor"[, +x, +y]);

Arguments
(owner, "Anchor"[, +x, +y])
owner
Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use _G['MyFrame'] to get the pointer from the frame name).
anchor
String - a string that describes the anchor point as it would be set via the SetPoint() function. Anchoring methods as follows:
ANCHOR_TOPRIGHT ------- SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")
ANCHOR_RIGHT ------- SetPoint("BOTTOMLEFT",object,"TOPRIGHT")
ANCHOR_BOTTOMRIGHT ------- SetPoint("TOPLEFT",object,"BOTTOMRIGHT")
ANCHOR_TOPLEFT ------- SetPoint("BOTTOMLEFT",object,"TOPLEFT")
ANCHOR_LEFT ------- SetPoint("BOTTOMRIGHT",object,"TOPLEFT")
ANCHOR_BOTTOMLEFT ------- SetPoint("TOPRIGHT",object,"BOTTOMLEFT")
ANCHOR_CURSOR
ANCHOR_PRESERVE
ANCHOR_NONE

You can also move the tooltip by x or y, where positive x is to the right and positive y is up. Thus, negative x is to the left and negative y is down. Doesn't work if anchor is ANCHOR_CURSOR.


Returns
Nothing.

Details
This will set the owner for tooltip:IsOwned(frame). For instance, first call GameTooltip:SetOwner(UIParent). Then GameTooltip:IsOwned(UIParent) will return 1.