WoW:API GameTooltip SetOwner: Difference between revisions
Jump to navigation
Jump to search
GameTooltip:SetOwner -Documentation by Xenoveritas-
-Edited by ThePooBurner-
No edit summary |
m (Pointer, not name.) |
||
| Line 4: | Line 4: | ||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | ||
GameTooltip:SetOwner(owner, anchor[, +x, +y]); | GameTooltip:SetOwner(owner, "anchor"[, +x, +y]); | ||
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section --> | <!-- Describe the purpose of the function, though exhausting detail can be saved for a later section --> | ||
| Line 16: | Line 16: | ||
:(owner, "Anchor"[, +x, +y]) | :(owner, "Anchor"[, +x, +y]) | ||
:;owner : Frame - Owner frame, which defines the element where the tooltip is centered on ( | :;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). | ||
:;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 meathods as follows: | ||
::ANCHOR_TOPRIGHT ------- SetPoint("BOTTOMRIGHT",object,"TOPRIGHT") | ::ANCHOR_TOPRIGHT ------- SetPoint("BOTTOMRIGHT",object,"TOPRIGHT") | ||
Revision as of 16:23, 21 March 2006
GameTooltip:SetOwner(owner, "anchor"[, +x, +y]);
Moves the game tooltip to a location based on the "owner" frame.
- 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 getglobal() 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_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
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.