Wowpedia

We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Wowpedia
Register
Tag: WoW API docs
(Undo revision 6874139 by Ketho (talk))
Tags: WoW API docs Undo
 
(169 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{widget}}
+
{{widget}} {{tocright}}
Widgets (or frames) are user interface [[Wikipedia:Graphical_widget|elements]]. Widget [[Widget script handlers|scripts]] allow you to respond to user interaction by e.g. clicking a button. Frames drawn on the UI can be inspected with [[MACRO framestack|/fstack]] and [[MACRO_tableinspect|/tinspect]] or with debug addons. Widgets are created from Lua or from [[XML_elements|XML]], which supports creating [[XML_elements#LayoutFrame|virtual templates]] other frames can inherit from.
+
Widgets are [[Wikipedia:Graphical_widget|graphical elements]] created in Lua with {{api|CreateFrame}}() or via [[XML schema|XML]]. Widget objects can be extended with templates, mixins and [[Intrinsic_frame|intrinsics]]. The user interface may be inspected with <code>[[MACRO framestack|/fstack]]</code>, <code>[[MACRO_tableinspect|/tinspect]]</code> and development addons like [https://www.curseforge.com/wow/addons/devtool DevTool] and [https://github.com/TekNoLogic/Spew Spew].
  +
<gallery>
  +
Widget_Hierarchy.png|[https://www.townlong-yak.com/framexml/live/UI_shared.xsd UI.xsd], [https://github.com/Gethe/wow-ui-source/search?q=ScriptObject Documentation]
  +
API_framestack_02.png|/fstack and /tinspect
  +
</gallery>
  +
{{i-note|This list is up to date as of [[Patch_10.1.0/API_changes|Patch 10.1.0]] (49365) Apr 27 2023}}
  +
{{warning|The docs are being migrated to Blizzard's [https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_APIDocumentationGenerated official documentation]}}
   
  +
==Abstract Classes==
For convenience the list of widget types can be arranged in a hierarchy of classes, grouping widgets by inherited methods.
 
  +
===FrameScriptObject===
  +
{{:UIOBJECT_FrameScriptObject}}
   
  +
===Object===
{| class="darktable zebra vertical-align-row"
 
  +
{{:UIOBJECT_Object|method}}
! Abstract !! Base !! Frame !! Animation
 
|-
 
| <!-- Abstract -->
 
* ''[[#UIObject|UIObject]]''
 
* ''[[#ParentedObject|ParentedObject]]''
 
* ''[[#ScriptObject|ScriptObject]]''
 
* ''[[#Region|Region]]''
 
* ''[[#LayeredRegion|LayeredRegion]]''
 
* ''[[#FontInstance|FontInstance]]''
 
| <!-- Base -->
 
* [[#Frame|Frame]]
 
   
  +
===ScriptRegion===
* [[#AnimationGroup|AnimationGroup]]
 
  +
{{:UIOBJECT_ScriptRegion|method}}
* [[#Animation|Animation]]
 
* [[#ControlPoint|ControlPoint]]
 
   
  +
===Region===
* [[#Texture|Texture]]
 
  +
{{:UIOBJECT_Region}}
* [[#MaskTexture|MaskTexture]]
 
* [[#Line|Line]]
 
   
  +
===TextureBase===
* [[#Font|Font]]
 
  +
{{:UIOBJECT_TextureBase}}
* [[#FontString|FontString]]
 
| <!-- Frame -->
 
{{columns|count=2|minwidth=15em|
 
* [[#Browser|Browser]]
 
* [[#Button|Button]]
 
** [[#CheckButton|CheckButton]]
 
** [[#ItemButton|ItemButton]]
 
* [[#Checkout|Checkout]]
 
* [[#ColorSelect|ColorSelect]]
 
* [[#Cooldown|Cooldown]]
 
* [[#EditBox|EditBox]]
 
* [[#FogOfWarFrame|FogOfWarFrame]]
 
* [[#GameTooltip|GameTooltip]]
 
* [[#MessageFrame|MessageFrame]]
 
* ''[[#Minimap|Minimap]]''
 
* [[#Model|Model]]
 
:* [[#PlayerModel|PlayerModel]]
 
::* [[#CinematicModel|CinematicModel]]
 
::* [[#DressUpModel|DressUpModel]]
 
::* [[#TabardModel|TabardModel]]
 
<br />
 
* [[#ModelScene|ModelScene]]
 
* [[#ModelSceneActor|ModelSceneActor]]
 
* [[#MovieFrame|MovieFrame]]
 
* [[#OffScreenFrame|OffScreenFrame]]
 
* ''[[#POIFrame|POIFrame]]''
 
:* [[#ArchaeologyDigSiteFrame|ArchaeologyDigSiteFrame]]
 
:* [[#QuestPOIFrame|QuestPOIFrame]]
 
:* [[#ScenarioPOIFrame|ScenarioPOIFrame]]
 
* [[#ScrollFrame|ScrollFrame]]
 
* [[#ScrollingMessageFrame|ScrollingMessageFrame]]
 
* [[#SimpleHTML|SimpleHTML]]
 
* [[#Slider|Slider]]
 
* [[#StatusBar|StatusBar]]
 
* [[#UnitPositionFrame|UnitPositionFrame]]
 
* [[#WorldFrame|WorldFrame]]
 
}}
 
| <!-- Animation -->
 
* [[#Alpha|Alpha]]
 
* [[#Scale|Scale]]
 
* [[#LineScale|LineScale]]
 
* [[#Translation|Translation]]
 
* [[#LineTranslation|LineTranslation]]
 
* [[#Path|Path]]
 
* [[#Rotation|Rotation]]
 
* [[#TextureCoordTranslation|TextureCoordTranslation]]
 
|}
 
{{tocright}}
 
   
  +
==Textures==
{|- class="vertical-align-row"
 
  +
===[[UIOBJECT_Texture|Texture]]===
| [[Image:Widget_Hierarchy.png|thumb|none|Widget Hierarchy]] ||
 
  +
{{:UIOBJECT_Texture}}
   
  +
===[[UIOBJECT_MaskTexture|MaskTexture]]===
   
  +
===[[UIOBJECT_Line|Line]]===
References:
 
  +
{{:UIOBJECT_Line}}
:{{ref web|url=https://www.townlong-yak.com/framexml/live/UI.xsd|author=Blizzard|title=XML Schema Definition}}
 
:{{ref web|url=https://web.archive.org/web/20170312164321/http://wowprogramming.com/docs/widgets_hierarchy|author=wowprogramming|title=Widget Hierarchy}}
 
:{{ref web|url=https://www.townlong-yak.com/framexml/7.2.5/Helix/WidgetAPI.lua|author=Townlong Yak|title=Helix/WidgetAPI.lua}}
 
:{{ref web|url=https://github.com/Resike/BlizzardInterfaceResources/blob/master/Resources/WidgetReference.lua|author=Resike|title=BlizzardInterfaceResources}}
 
:{{ref web|url=https://github.com/Ketho/BlizzardInterfaceResources/blob/live/Resources/WidgetAPI.lua|author=Ketho|title=BlizzardInterfaceResources}}
 
|}
 
   
  +
==Fonts==
{{i-note|This list is up to date as of [[Patch_9.0.2/API_changes|Patch 9.0.2]] (36753) Nov 24 2020}}
 
  +
===[[UIOBJECT_Font|Font]]===
  +
{{:UIOBJECT_Font}}
   
  +
===[[UIOBJECT_FontString|FontString]]===
== UIObject ==
 
  +
{{:UIOBJECT_FontString}}
  +
  +
==Animations==
  +
===[[UIOBJECT_AnimationGroup|AnimationGroup]]===
  +
{{:UIOBJECT_AnimationGroup|method}}
  +
  +
===[[UIOBJECT_Animation|Animation]]===
  +
{{:UIOBJECT_Animation|method}}
  +
  +
===[[UIOBJECT_Alpha|Alpha]]===
  +
{{:UIOBJECT_Alpha|method}}
  +
  +
===[[UIOBJECT_FlipBook|FlipBook]]===
  +
{{:UIOBJECT_FlipBook|method}}
  +
  +
===[[UIOBJECT_Path|Path]]===
  +
{{:UIOBJECT_Path|method}}
  +
  +
===[[UIOBJECT_ControlPoint|ControlPoint]]===
  +
{{:UIOBJECT_ControlPoint|method}}
  +
  +
===[[UIOBJECT_Rotation|Rotation]]===
  +
{{:UIOBJECT_Rotation|method}}
  +
  +
===[[UIOBJECT_Scale|Scale]]===
  +
{{:UIOBJECT_Scale|method}}
  +
  +
===[[UIOBJECT_TextureCoordTranslation|TextureCoordTranslation]]===
  +
{{:UIOBJECT_TextureCoordTranslation|method}}
  +
  +
===[[UIOBJECT_Translation|Translation]]===
  +
{{:UIOBJECT_Translation|method}}
  +
  +
==Frames==
  +
===[[UIOBJECT_Frame|Frame]]===
  +
{{:UIOBJECT_Frame|method}}
  +
  +
===[[UIOBJECT_Button|Button]]===
  +
{{:UIOBJECT_Button|method}}
  +
  +
===[[UIOBJECT_CheckButton|CheckButton]]===
  +
{{:UIOBJECT_CheckButton|method}}
  +
  +
===[[UIOBJECT_Model|Model]]===
  +
{{:UIOBJECT_Model|method}}
  +
  +
===[[UIOBJECT_CharacterModelBase|PlayerModel]]===
  +
PlayerModel is officially documented as <code>CharacterModelBase</code>.
  +
{{:UIOBJECT_CharacterModelBase|method}}
  +
<!--
  +
===CinematicModel===
  +
-->
  +
  +
===[[UIOBJECT_DressUpModel|DressUpModel]]===
  +
{{:UIOBJECT_DressUpModel|method}}
  +
<!--
  +
===TabardModel===
  +
-->
  +
  +
===[[UIOBJECT_ColorSelect|ColorSelect]]===
  +
{{:UIOBJECT_ColorSelect|method}}
  +
  +
===Cooldown===
  +
: {{apilink|t=w|Cooldown:Clear}}
  +
: {{apilink|t=w|Cooldown:GetCooldownDisplayDuration|ret=duration}}
  +
: {{apilink|t=w|Cooldown:GetCooldownDuration|ret=duration}}
  +
: {{apilink|t=w|Cooldown:GetCooldownTimes|ret=start, duration}}
  +
: {{apilink|t=w|Cooldown:GetDrawBling|ret=drawBling}}
  +
: {{apilink|t=w|Cooldown:GetDrawEdge|ret=drawEdge}}
  +
: {{apilink|t=w|Cooldown:GetDrawSwipe|ret=drawSwipe}}
  +
: {{apilink|t=w|Cooldown:GetEdgeScale|ret=edgeScale}}
  +
: {{apilink|t=w|Cooldown:GetReverse|ret=reverse}}
  +
: {{apilink|t=w|Cooldown:GetRotation|ret=rotationRadians}}
  +
: {{apilink|t=w|Cooldown:IsPaused|ret=isPaused}}
  +
: {{apilink|t=w|Cooldown:Pause}}
  +
: {{apilink|t=w|Cooldown:Resume}}
  +
: {{apilink|t=w|Cooldown:SetBlingTexture|arg=texture, colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|Cooldown:SetCooldown|arg=start, duration, modRate?}}
  +
: {{apilink|t=w|Cooldown:SetCooldownDuration|arg=duration, modRate?}}
  +
: {{apilink|t=w|Cooldown:SetCooldownUNIX|arg=start, duration, modRate?}}
  +
: {{apilink|t=w|Cooldown:SetCountdownAbbrevThreshold|arg=seconds}}
  +
: {{apilink|t=w|Cooldown:SetCountdownFont|arg=fontName}}
  +
: {{apilink|t=w|Cooldown:SetDrawBling|arg=drawBling?}}
  +
: {{apilink|t=w|Cooldown:SetDrawEdge|arg=drawEdge?}}
  +
: {{apilink|t=w|Cooldown:SetDrawSwipe|arg=drawSwipe?}}
  +
: {{apilink|t=w|Cooldown:SetEdgeScale|arg=scale}}
  +
: {{apilink|t=w|Cooldown:SetEdgeTexture|arg=texture, colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|Cooldown:SetHideCountdownNumbers|arg=hideNumbers?}}
  +
: {{apilink|t=w|Cooldown:SetReverse|arg=reverse?}}
  +
: {{apilink|t=w|Cooldown:SetRotation|arg=rotationRadians}}
  +
: {{apilink|t=w|Cooldown:SetSwipeColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|Cooldown:SetSwipeTexture|arg=texture, colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|Cooldown:SetTexCoordRange|arg=low, high}}
  +
: {{apilink|t=w|Cooldown:SetUseCircularEdge|arg=useCircularEdge?}}
  +
  +
===EditBox===
  +
: {{apilink|t=w|EditBox:AddHistoryLine|arg=text}}
  +
: {{apilink|t=w|EditBox:ClearFocus}}
  +
: {{apilink|t=w|EditBox:ClearHighlightText}}
  +
: {{apilink|t=w|EditBox:ClearHistory}}
  +
: {{apilink|t=w|EditBox:Disable}}
  +
: {{apilink|t=w|EditBox:Enable}}
  +
: {{apilink|t=w|EditBox:GetAltArrowKeyMode|ret=altMode}}
  +
: {{apilink|t=w|EditBox:GetBlinkSpeed|ret=cursorBlinkSpeedSec}}
  +
: {{apilink|t=w|EditBox:GetCursorPosition|ret=cursorPosition}}
  +
: {{apilink|t=w|EditBox:GetDisplayText|ret=displayText}}
  +
: {{apilink|t=w|EditBox:GetFont|ret=name, fontHeight, flags}}
  +
: {{apilink|t=w|EditBox:GetFontObject|ret=font}}
  +
: {{apilink|t=w|EditBox:GetHighlightColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|EditBox:GetHistoryLines|ret=numHistoryLines}}
  +
: {{apilink|t=w|EditBox:GetIndentedWordWrap|ret=isIndented}}
  +
: {{apilink|t=w|EditBox:GetInputLanguage|ret=language}}
  +
: {{apilink|t=w|EditBox:GetJustifyH|ret=justifyH}}
  +
: {{apilink|t=w|EditBox:GetJustifyV|ret=justifyV}}
  +
: {{apilink|t=w|EditBox:GetMaxBytes|ret=maxBytes}}
  +
: {{apilink|t=w|EditBox:GetMaxLetters|ret=maxLetters}}
  +
: {{apilink|t=w|EditBox:GetNumLetters|ret=numLetters}}
  +
: {{apilink|t=w|EditBox:GetNumber|ret=number?}}
  +
: {{apilink|t=w|EditBox:GetShadowColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|EditBox:GetShadowOffset|ret=offsetX, offsetY}}
  +
: {{apilink|t=w|EditBox:GetSpacing|ret=fontHeight}}
  +
: {{apilink|t=w|EditBox:GetText|ret=text}}
  +
: {{apilink|t=w|EditBox:GetTextColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|EditBox:GetTextInsets|ret=left, right, top, bottom}}
  +
: {{apilink|t=w|EditBox:GetUTF8CursorPosition|ret=cursorPosition}}
  +
: {{apilink|t=w|EditBox:GetVisibleTextByteLimit|ret=maxVisibleBytes}}
  +
: {{apilink|t=w|EditBox:HasFocus|ret=hasFocus}}
  +
: {{apilink|t=w|EditBox:HasText|ret=hasText}}
  +
: {{apilink|t=w|EditBox:HighlightText|arg=start?, stop?}}
  +
: {{apilink|t=w|EditBox:Insert|arg=text}}
  +
: {{apilink|t=w|EditBox:IsAutoFocus|ret=autoFocus}}
  +
: {{apilink|t=w|EditBox:IsCountInvisibleLetters|ret=countInvisibleLetters}}
  +
: {{apilink|t=w|EditBox:IsEnabled|ret=isEnabled}}
  +
: {{apilink|t=w|EditBox:IsInIMECompositionMode|ret=isInIMECompositionMode}}
  +
: {{apilink|t=w|EditBox:IsMultiLine|ret=multiline}}
  +
: {{apilink|t=w|EditBox:IsNumeric|ret=isNumeric}}
  +
: {{apilink|t=w|EditBox:IsPassword|ret=isPassword}}
  +
: {{apilink|t=w|EditBox:IsSecureText|ret=isSecure}}
  +
: {{apilink|t=w|EditBox:SetAltArrowKeyMode|arg=altMode?}}
  +
: {{apilink|t=w|EditBox:SetAutoFocus|arg=autoFocus?}}
  +
: {{apilink|t=w|EditBox:SetBlinkSpeed|arg=cursorBlinkSpeedSec}}
  +
: {{apilink|t=w|EditBox:SetCountInvisibleLetters|arg=countInvisibleLetters?}}
  +
: {{apilink|t=w|EditBox:SetCursorPosition|arg=cursorPosition}}
  +
: {{apilink|t=w|EditBox:SetEnabled|arg=enabled?}}
  +
: {{apilink|t=w|EditBox:SetFocus}}
  +
: {{apilink|t=w|EditBox:SetFont|arg=fontFile, height, flags|ret=success}}
  +
: {{apilink|t=w|EditBox:SetFontObject|arg=font}}
  +
: {{apilink|t=w|EditBox:SetHighlightColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|EditBox:SetHistoryLines|arg=numHistoryLines}}
  +
: {{apilink|t=w|EditBox:SetIndentedWordWrap|arg=isIndented?}}
  +
: {{apilink|t=w|EditBox:SetJustifyH|arg=justifyH}}
  +
: {{apilink|t=w|EditBox:SetJustifyV|arg=justifyV}}
  +
: {{apilink|t=w|EditBox:SetMaxBytes|arg=maxBytes}}
  +
: {{apilink|t=w|EditBox:SetMaxLetters|arg=maxLetters}}
  +
: {{apilink|t=w|EditBox:SetMultiLine|arg=multiline?}}
  +
: {{apilink|t=w|EditBox:SetNumber|arg=number}}
  +
: {{apilink|t=w|EditBox:SetNumeric|arg=isNumeric?}}
  +
: {{apilink|t=w|EditBox:SetPassword|arg=isPassword?}}
  +
: {{apilink|t=w|EditBox:SetSecureText|arg=isSecure?}}
  +
: {{apilink|t=w|EditBox:SetSecurityDisablePaste}}
  +
: {{apilink|t=w|EditBox:SetSecurityDisableSetText}}
  +
: {{apilink|t=w|EditBox:SetShadowColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|EditBox:SetShadowOffset|arg=offsetX, offsetY}}
  +
: {{apilink|t=w|EditBox:SetSpacing|arg=fontHeight}}
  +
: {{apilink|t=w|EditBox:SetText|arg=text}}
  +
: {{apilink|t=w|EditBox:SetTextColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|EditBox:SetTextInsets|arg=left, right, top, bottom}}
  +
: {{apilink|t=w|EditBox:SetVisibleTextByteLimit|arg=maxVisibleBytes}}
  +
: {{apilink|t=w|EditBox:ToggleInputLanguage}}
  +
  +
===GameTooltip===
  +
In patch 10.0.2 any addons that are creating GameTooltip frames should now ensure they inherit [[GameTooltipTemplate]]. This template has been updated to include the new [https://github.com/Ketho/wow-ui-source-df/search?q=GameTooltipDataMixin GameTooltipDataMixin] mixin, which provides automatic updates of tooltip contents from the {{api|t=e|TOOLTIP_DATA_UPDATE}} event as well as a subset of backwards-compatible methods for retrieving or populating tooltip contents from the new C_TooltipInfo APIs.
  +
<syntaxhighlight lang="lua">
  +
CreateFrame("GameTooltip") -- inherits `Frame`
  +
</syntaxhighlight>
  +
: {{api|t=w|GameTooltip:AddAtlas}}
  +
: {{api|t=w|GameTooltip:AddDoubleLine}}
  +
: {{api|t=w|GameTooltip:AddFontStrings}}
  +
: {{api|t=w|GameTooltip:AddLine}}
  +
: {{api|t=w|GameTooltip:AddTexture}}
  +
: {{api|t=w|GameTooltip:AppendText}}
  +
: {{api|t=w|GameTooltip:ClearLines}}
  +
: {{api|t=w|GameTooltip:CopyTooltip}}
  +
: {{api|t=w|GameTooltip:FadeOut}}
  +
: {{api|t=w|GameTooltip:GetAnchorType}}
  +
: {{api|t=w|GameTooltip:GetCustomLineSpacing}}
  +
: {{api|t=w|GameTooltip:GetMinimumWidth}}
  +
: {{api|t=w|GameTooltip:GetOwner}}
  +
: {{api|t=w|GameTooltip:GetPadding}}
  +
: {{api|t=w|GameTooltip:IsOwned}}
  +
: {{api|t=w|GameTooltip:NumLines}}
  +
: {{api|t=w|GameTooltip:SetAllowShowWithNoLines}}
  +
: {{api|t=w|GameTooltip:SetAnchorType}}
  +
: {{api|t=w|GameTooltip:SetCustomLineSpacing}}
  +
: {{api|t=w|GameTooltip:SetCustomWordWrapMinWidth}}
  +
: {{api|t=w|GameTooltip:SetFrameStack}}
  +
: {{api|t=w|GameTooltip:SetMinimumWidth}}
  +
: {{api|t=w|GameTooltip:SetObjectTooltipPosition}}
  +
: {{api|t=w|GameTooltip:SetOwner}}
  +
: {{api|t=w|GameTooltip:SetPadding}}
  +
: {{api|t=w|GameTooltip:SetShrinkToFitWrapped}}
  +
: {{api|t=w|GameTooltip:SetText}}
  +
  +
<syntaxhighlight lang="lua">
  +
CreateFrame("GameTooltip", nil, nil, "GameTooltipTemplate") -- includes `GameTooltipDataMixin`
  +
</syntaxhighlight>
  +
See also [https://wowpedia.fandom.com/wiki/Category:API_namespaces/C_TooltipInfo C_TooltipInfo]
  +
: {{api|t=w|GameTooltip:SetAchievementByID}}
  +
: {{api|t=w|GameTooltip:SetAction}}
  +
: {{api|t=w|GameTooltip:SetArtifactItem}}
  +
: {{api|t=w|GameTooltip:SetArtifactPowerByID}}
  +
: {{api|t=w|GameTooltip:SetAzeriteEssence}}
  +
: {{api|t=w|GameTooltip:SetAzeriteEssenceSlot}}
  +
: {{api|t=w|GameTooltip:SetAzeritePower}}
  +
: {{api|t=w|GameTooltip:SetBackpackToken}}
  +
: {{api|t=w|GameTooltip:SetBagItem}}
  +
: {{api|t=w|GameTooltip:SetBagItemChild}}
  +
: {{api|t=w|GameTooltip:SetBuybackItem}}
  +
: {{api|t=w|GameTooltip:SetCompanionPet}}
  +
: {{api|t=w|GameTooltip:SetConduit}}
  +
: {{api|t=w|GameTooltip:SetCurrencyByID}}
  +
: {{api|t=w|GameTooltip:SetCurrencyToken}}
  +
: {{api|t=w|GameTooltip:SetEnhancedConduit}}
  +
: {{api|t=w|GameTooltip:SetEquipmentSet}}
  +
: {{api|t=w|GameTooltip:SetExistingSocketGem}}
  +
: {{api|t=w|GameTooltip:SetGuildBankItem}}
  +
: {{api|t=w|GameTooltip:SetHeirloomByItemID}}
  +
: {{api|t=w|GameTooltip:SetHyperlink}}
  +
: {{api|t=w|GameTooltip:SetInboxItem}}
  +
: {{api|t=w|GameTooltip:SetInstanceLockEncountersComplete}}
  +
: {{api|t=w|GameTooltip:SetInventoryItem}}
  +
: {{api|t=w|GameTooltip:SetInventoryItemByID}}
  +
: {{api|t=w|GameTooltip:SetItemByGUID}}
  +
: {{api|t=w|GameTooltip:SetItemByID}}
  +
: {{api|t=w|GameTooltip:SetItemInteractionItem}}
  +
: {{api|t=w|GameTooltip:SetItemKey}}
  +
: {{api|t=w|GameTooltip:SetLFGDungeonReward}}
  +
: {{api|t=w|GameTooltip:SetLFGDungeonShortageReward}}
  +
: {{api|t=w|GameTooltip:SetLootCurrency}}
  +
: {{api|t=w|GameTooltip:SetLootItem}}
  +
: {{api|t=w|GameTooltip:SetLootRollItem}}
  +
: {{api|t=w|GameTooltip:SetMerchantCostItem}}
  +
: {{api|t=w|GameTooltip:SetMerchantItem}}
  +
: {{api|t=w|GameTooltip:SetMinimapMouseover}}
  +
: {{api|t=w|GameTooltip:SetMountBySpellID}}
  +
: {{api|t=w|GameTooltip:SetOwnedItemByID}}
  +
: {{api|t=w|GameTooltip:SetPetAction}}
  +
: {{api|t=w|GameTooltip:SetPossession}}
  +
: {{api|t=w|GameTooltip:SetPvpBrawl}}
  +
: {{api|t=w|GameTooltip:SetPvpTalent}}
  +
: {{api|t=w|GameTooltip:SetQuestCurrency}}
  +
: {{api|t=w|GameTooltip:SetQuestItem}}
  +
: {{api|t=w|GameTooltip:SetQuestLogCurrency}}
  +
: {{api|t=w|GameTooltip:SetQuestLogItem}}
  +
: {{api|t=w|GameTooltip:SetQuestLogRewardSpell}}
  +
: {{api|t=w|GameTooltip:SetQuestLogSpecialItem}}
  +
: {{api|t=w|GameTooltip:SetQuestPartyProgress}}
  +
: {{api|t=w|GameTooltip:SetQuestRewardSpell}}
  +
: {{api|t=w|GameTooltip:SetRecipeRankInfo}}
  +
: {{api|t=w|GameTooltip:SetRecipeReagentItem}}
  +
: {{api|t=w|GameTooltip:SetRecipeResultItem}}
  +
: {{api|t=w|GameTooltip:SetRecipeResultItemForOrder}}
  +
: {{api|t=w|GameTooltip:SetRuneforgeResultItem}}
  +
: {{api|t=w|GameTooltip:SetSendMailItem}}
  +
: {{api|t=w|GameTooltip:SetShapeshift}}
  +
: {{api|t=w|GameTooltip:SetSlottedKeystone}}
  +
: {{api|t=w|GameTooltip:SetSocketedItem}}
  +
: {{api|t=w|GameTooltip:SetSocketedRelic}}
  +
: {{api|t=w|GameTooltip:SetSocketGem}}
  +
: {{api|t=w|GameTooltip:SetSpellBookItem}}
  +
: {{api|t=w|GameTooltip:SetSpellByID}}
  +
: {{api|t=w|GameTooltip:SetTalent}}
  +
: {{api|t=w|GameTooltip:SetTotem}}
  +
: {{api|t=w|GameTooltip:SetToyByItemID}}
  +
: {{api|t=w|GameTooltip:SetTradePlayerItem}}
  +
: {{api|t=w|GameTooltip:SetTradeTargetItem}}
  +
: {{api|t=w|GameTooltip:SetTrainerService}}
  +
: {{api|t=w|GameTooltip:SetTraitEntry}}
  +
: {{api|t=w|GameTooltip:SetTransmogrifyItem}}
  +
: {{api|t=w|GameTooltip:SetUnit}}
  +
: {{api|t=w|GameTooltip:SetUnitAura}}
  +
: {{api|t=w|GameTooltip:SetUnitBuff}}
  +
: {{api|t=w|GameTooltip:SetUnitBuffByAuraInstanceID}}
  +
: {{api|t=w|GameTooltip:SetUnitDebuff}}
  +
: {{api|t=w|GameTooltip:SetUnitDebuffByAuraInstanceID}}
  +
: {{api|t=w|GameTooltip:SetUpgradeItem}}
  +
: {{api|t=w|GameTooltip:SetVoidDepositItem}}
  +
: {{api|t=w|GameTooltip:SetVoidItem}}
  +
: {{api|t=w|GameTooltip:SetVoidWithdrawalItem}}
  +
: {{api|t=w|GameTooltip:SetWeeklyReward}}
  +
  +
===MessageFrame===
  +
: {{apilink|t=w|MessageFrame:AddMessage|arg=text, colorR, colorG, colorB, a?, messageID?}}
  +
: {{apilink|t=w|MessageFrame:Clear}}
  +
: {{apilink|t=w|MessageFrame:GetFadeDuration|ret=fadeDurationSeconds}}
  +
: {{apilink|t=w|MessageFrame:GetFadePower|ret=fadePower}}
  +
: {{apilink|t=w|MessageFrame:GetFading|ret=isFading}}
  +
: {{apilink|t=w|MessageFrame:GetFont|ret=fontFile, height, flags}}
  +
: {{apilink|t=w|MessageFrame:GetFontObject|ret=font}}
  +
: {{apilink|t=w|MessageFrame:GetFontStringByID|arg=messageID|ret=fontString}}
  +
: {{apilink|t=w|MessageFrame:GetIndentedWordWrap|ret=wordWrap}}
  +
: {{apilink|t=w|MessageFrame:GetInsertMode|ret=mode}}
  +
: {{apilink|t=w|MessageFrame:GetJustifyH|ret=justifyH}}
  +
: {{apilink|t=w|MessageFrame:GetJustifyV|ret=justifyV}}
  +
: {{apilink|t=w|MessageFrame:GetShadowColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|MessageFrame:GetShadowOffset|ret=offsetX, offsetY}}
  +
: {{apilink|t=w|MessageFrame:GetSpacing|ret=spacing}}
  +
: {{apilink|t=w|MessageFrame:GetTextColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|MessageFrame:GetTimeVisible|ret=timeVisibleSeconds}}
  +
: {{apilink|t=w|MessageFrame:HasMessageByID|arg=messageID|ret=hasMessage}}
  +
: {{apilink|t=w|MessageFrame:ResetMessageFadeByID|arg=messageID}}
  +
: {{apilink|t=w|MessageFrame:SetFadeDuration|arg=fadeDurationSeconds}}
  +
: {{apilink|t=w|MessageFrame:SetFadePower|arg=fadePower}}
  +
: {{apilink|t=w|MessageFrame:SetFading|arg=fading}}
  +
: {{apilink|t=w|MessageFrame:SetFont|arg=fontFile, height, flags}}
  +
: {{apilink|t=w|MessageFrame:SetFontObject|arg=font}}
  +
: {{apilink|t=w|MessageFrame:SetIndentedWordWrap|arg=wordWrap}}
  +
: {{apilink|t=w|MessageFrame:SetInsertMode|arg=mode}}
  +
: {{apilink|t=w|MessageFrame:SetJustifyH|arg=justifyH}}
  +
: {{apilink|t=w|MessageFrame:SetJustifyV|arg=justifyV}}
  +
: {{apilink|t=w|MessageFrame:SetShadowColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|MessageFrame:SetShadowOffset|arg=offsetX, offsetY}}
  +
: {{apilink|t=w|MessageFrame:SetSpacing|arg=spacing}}
  +
: {{apilink|t=w|MessageFrame:SetTextColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|MessageFrame:SetTimeVisible|arg=timeVisibleSeconds}}
  +
  +
===Minimap===
  +
unique widget
  +
: {{apilink|t=w|Minimap:GetPingPosition|ret=positionX, positionY}}
  +
: {{apilink|t=w|Minimap:GetZoom|ret=zoomFactor}}
  +
: {{apilink|t=w|Minimap:GetZoomLevels|ret=zoomLevels}}
  +
: {{apilink|t=w|Minimap:PingLocation|arg=locationX, locationY}}
  +
: {{apilink|t=w|Minimap:SetArchBlobInsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetArchBlobInsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetArchBlobOutsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetArchBlobOutsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetArchBlobRingAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetArchBlobRingScalar|arg=scalar}}
  +
: {{apilink|t=w|Minimap:SetArchBlobRingTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetBlipTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetCorpsePOIArrowTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetIconTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetMaskTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetPOIArrowTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetPlayerTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobInsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobInsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobOutsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobOutsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobRingAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobRingScalar|arg=scalar}}
  +
: {{apilink|t=w|Minimap:SetQuestBlobRingTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetStaticPOIArrowTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobInsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobInsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobOutsideAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobOutsideTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobRingAlpha|arg=alpha}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobRingScalar|arg=scalar}}
  +
: {{apilink|t=w|Minimap:SetTaskBlobRingTexture|arg=asset}}
  +
: {{apilink|t=w|Minimap:SetZoom|arg=zoomFactor}}
  +
: {{apilink|t=w|Minimap:UpdateBlips}}
  +
  +
===MovieFrame===
  +
: {{apilink|t=w|MovieFrame:EnableSubtitles|arg=enable}}
  +
: {{apilink|t=w|MovieFrame:StartMovie|arg=movieID, looping?|ret=success, returnCode}}
  +
: {{apilink|t=w|MovieFrame:StartMovieByName|arg=movieName, looping?, resolution?|ret=success, returnCode}}
  +
: {{apilink|t=w|MovieFrame:StopMovie}}
  +
  +
===ScrollFrame===
  +
: {{apilink|t=w|ScrollFrame:GetHorizontalScroll|ret=offset}}
  +
: {{apilink|t=w|ScrollFrame:GetHorizontalScrollRange|ret=range}}
  +
: {{apilink|t=w|ScrollFrame:GetScrollChild|ret=scrollChild}}
  +
: {{apilink|t=w|ScrollFrame:GetVerticalScroll|ret=offset}}
  +
: {{apilink|t=w|ScrollFrame:GetVerticalScrollRange|ret=range}}
  +
: {{apilink|t=w|ScrollFrame:SetHorizontalScroll|arg=offset}}
  +
: {{apilink|t=w|ScrollFrame:SetScrollChild|arg=scrollChild}}
  +
: {{apilink|t=w|ScrollFrame:SetVerticalScroll|arg=offset}}
  +
: {{apilink|t=w|ScrollFrame:UpdateScrollChildRect}}
  +
  +
===SimpleHTML===
  +
: {{apilink|t=w|SimpleHTML:GetContentHeight|ret=height}}
  +
: {{apilink|t=w|SimpleHTML:GetFont|arg=textType|ret=fontFile, height, flags}}
  +
: {{apilink|t=w|SimpleHTML:GetFontObject|arg=textType|ret=font}}
  +
: {{apilink|t=w|SimpleHTML:GetHyperlinkFormat|ret=format}}
  +
: {{apilink|t=w|SimpleHTML:GetIndentedWordWrap|arg=textType|ret=wordWrap}}
  +
: {{apilink|t=w|SimpleHTML:GetJustifyH|arg=textType|ret=justifyH}}
  +
: {{apilink|t=w|SimpleHTML:GetJustifyV|arg=textType|ret=justifyV}}
  +
: {{apilink|t=w|SimpleHTML:GetShadowColor|arg=textType|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|SimpleHTML:GetShadowOffset|arg=textType|ret=offsetX, offsetY}}
  +
: {{apilink|t=w|SimpleHTML:GetSpacing|arg=textType|ret=spacing}}
  +
: {{apilink|t=w|SimpleHTML:GetTextColor|arg=textType|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|SimpleHTML:GetTextData|ret=content}}
  +
: {{apilink|t=w|SimpleHTML:SetFont|arg=textType, fontFile, height, flags}}
  +
: {{apilink|t=w|SimpleHTML:SetFontObject|arg=textType, font}}
  +
: {{apilink|t=w|SimpleHTML:SetHyperlinkFormat|arg=format}}
  +
: {{apilink|t=w|SimpleHTML:SetIndentedWordWrap|arg=textType, wordWrap}}
  +
: {{apilink|t=w|SimpleHTML:SetJustifyH|arg=textType, justifyH}}
  +
: {{apilink|t=w|SimpleHTML:SetJustifyV|arg=textType, justifyV}}
  +
: {{apilink|t=w|SimpleHTML:SetShadowColor|arg=textType, colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|SimpleHTML:SetShadowOffset|arg=textType, offsetX, offsetY}}
  +
: {{apilink|t=w|SimpleHTML:SetSpacing|arg=textType, spacing}}
  +
: {{apilink|t=w|SimpleHTML:SetText|arg=text, ignoreMarkup?}}
  +
: {{apilink|t=w|SimpleHTML:SetTextColor|arg=textType, colorR, colorG, colorB, a?}}
  +
  +
===Slider===
  +
: {{apilink|t=w|Slider:Disable}}
  +
: {{apilink|t=w|Slider:Enable}}
  +
: {{apilink|t=w|Slider:GetMinMaxValues|ret=minValue, maxValue}}
  +
: {{apilink|t=w|Slider:GetObeyStepOnDrag|ret=isObeyStepOnDrag}}
  +
: {{apilink|t=w|Slider:GetOrientation|ret=orientation}}
  +
: {{apilink|t=w|Slider:GetStepsPerPage|ret=stepsPerPage}}
  +
: {{apilink|t=w|Slider:GetThumbTexture|ret=texture}}
  +
: {{apilink|t=w|Slider:GetValue|ret=value}}
  +
: {{apilink|t=w|Slider:GetValueStep|ret=valueStep}}
  +
: {{apilink|t=w|Slider:IsDraggingThumb|ret=isDraggingThumb}}
  +
: {{apilink|t=w|Slider:IsEnabled|ret=enabled}}
  +
: {{apilink|t=w|Slider:SetEnabled|arg=enabled}}
  +
: {{apilink|t=w|Slider:SetMinMaxValues|arg=minValue, maxValue}}
  +
: {{apilink|t=w|Slider:SetObeyStepOnDrag|arg=obeyStepOnDrag}}
  +
: {{apilink|t=w|Slider:SetOrientation|arg=orientation}}
  +
: {{apilink|t=w|Slider:SetStepsPerPage|arg=stepsPerPage}}
  +
: {{apilink|t=w|Slider:SetThumbTexture|arg=asset}}
  +
: {{apilink|t=w|Slider:SetValue|arg=value, treatAsMouseEvent?}}
  +
: {{apilink|t=w|Slider:SetValueStep|arg=valueStep}}
  +
  +
===StatusBar===
  +
: {{apilink|t=w|StatusBar:GetFillStyle|ret=fillStyle}}
  +
: {{apilink|t=w|StatusBar:GetMinMaxValues|ret=minValue, maxValue}}
  +
: {{apilink|t=w|StatusBar:GetOrientation|ret=orientation}}
  +
: {{apilink|t=w|StatusBar:GetReverseFill|ret=isReverseFill}}
  +
: {{apilink|t=w|StatusBar:GetRotatesTexture|ret=rotatesTexture}}
  +
: {{apilink|t=w|StatusBar:GetStatusBarColor|ret=colorR, colorG, colorB, colorA}}
  +
: {{apilink|t=w|StatusBar:GetStatusBarDesaturation|ret=desaturation}}
  +
: {{apilink|t=w|StatusBar:GetStatusBarTexture|ret=texture}}
  +
: {{apilink|t=w|StatusBar:GetValue|ret=value}}
  +
: {{apilink|t=w|StatusBar:IsStatusBarDesaturated|ret=desaturated}}
  +
: {{apilink|t=w|StatusBar:SetColorFill|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|StatusBar:SetFillStyle|arg=fillStyle}}
  +
: {{apilink|t=w|StatusBar:SetMinMaxValues|arg=minValue, maxValue}}
  +
: {{apilink|t=w|StatusBar:SetOrientation|arg=orientation}}
  +
: {{apilink|t=w|StatusBar:SetReverseFill|arg=isReverseFill}}
  +
: {{apilink|t=w|StatusBar:SetRotatesTexture|arg=rotatesTexture}}
  +
: {{apilink|t=w|StatusBar:SetStatusBarColor|arg=colorR, colorG, colorB, a?}}
  +
: {{apilink|t=w|StatusBar:SetStatusBarDesaturated|arg=desaturated?}}
  +
: {{apilink|t=w|StatusBar:SetStatusBarDesaturation|arg=desaturation}}
  +
: {{apilink|t=w|StatusBar:SetStatusBarTexture|arg=asset}}
  +
: {{apilink|t=w|StatusBar:SetValue|arg=value}}
  +
  +
==Undocumented==
  +
These widget types have yet to be documented on the wiki.
  +
<!-- == UIObject ==
 
{{:UIOBJECT UIObject|t=w}}
 
{{:UIOBJECT UIObject|t=w}}
   
 
== ParentedObject ==
 
== ParentedObject ==
{{api|t=o|ParentedObject}} (inherits from [[#UIObject|UIObject]]) is an abstract UI type that provides support for querying the parent of a given object.
 
 
{{:UIOBJECT ParentedObject|t=w}}
 
{{:UIOBJECT ParentedObject|t=w}}
   
Line 103: Line 502:
   
 
== LayeredRegion ==
 
== LayeredRegion ==
{{:UIOBJECT LayeredRegion|t=w}}
+
{{:UIOBJECT LayeredRegion|t=w}}
   
 
==AnimationGroup==
 
==AnimationGroup==
 
[[UIOBJECT AnimationGroup|AnimationGroup]]s (inherits from [[#ParentedObject|ParentedObject]] and [[#ScriptObject|ScriptObject]], created with {{api|t=w|Region:CreateAnimationGroup}}) control how various animations are actually applied to a region.<sup>[https://wowprogramming.com/docs/widgets/AnimationGroup.html]</sup>
 
[[UIOBJECT AnimationGroup|AnimationGroup]]s (inherits from [[#ParentedObject|ParentedObject]] and [[#ScriptObject|ScriptObject]], created with {{api|t=w|Region:CreateAnimationGroup}}) control how various animations are actually applied to a region.<sup>[https://wowprogramming.com/docs/widgets/AnimationGroup.html]</sup>
 
<br>{{ref web|url=https://www.wowinterface.com/forums/showthread.php?t=35104|author=zork|date=2010-09-22|title=3.1.0 Animation roundup}}
 
<br>{{ref web|url=https://www.wowinterface.com/forums/showthread.php?t=35104|author=zork|date=2010-09-22|title=3.1.0 Animation roundup}}
: [[API AnimationGroup CreateAnimation|AnimationGroup:CreateAnimation]](animationType, [name[,inheritsFrom]]) - Create and return an Animation as a child of this group.
+
: [[API AnimationGroup CreateAnimation|AnimationGroup:CreateAnimation]](<span class="apiarg">animationType, [name[,inheritsFrom]]</span>) - Create and return an Animation as a child of this group.
 
: [[API AnimationGroup Finish|AnimationGroup:Finish]]() - Notify this group to stop playing once the current loop cycle is done. Does nothing if this group is not playing.
 
: [[API AnimationGroup Finish|AnimationGroup:Finish]]() - Notify this group to stop playing once the current loop cycle is done. Does nothing if this group is not playing.
 
: [[API AnimationGroup GetAnimations|AnimationGroup:GetAnimations]]()
 
: [[API AnimationGroup GetAnimations|AnimationGroup:GetAnimations]]()
Line 122: Line 521:
 
: [[API AnimationGroup Pause|AnimationGroup:Pause]]() - Pause the animations in this group.
 
: [[API AnimationGroup Pause|AnimationGroup:Pause]]() - Pause the animations in this group.
 
: [[API AnimationGroup Play|AnimationGroup:Play]]() - Start playing the animations in this group.
 
: [[API AnimationGroup Play|AnimationGroup:Play]]() - Start playing the animations in this group.
  +
: [[API AnimationGroup RemoveAnimations|AnimationGroup:RemoveAnimations]]()
 
: [[API AnimationGroup Restart|AnimationGroup:Restart]]()
 
: [[API AnimationGroup Restart|AnimationGroup:Restart]]()
: [[API AnimationGroup SetLooping|AnimationGroup:SetLooping]](loopType) - Sets the type of looping for the group. Input is [NONE, REPEAT, or BOUNCE].
+
: [[API AnimationGroup SetLooping|AnimationGroup:SetLooping]](<span class="apiarg">loopType</span>) - Sets the type of looping for the group. Input is [NONE, REPEAT, or BOUNCE].
: [[API AnimationGroup SetPlaying|AnimationGroup:SetPlaying]](play)
+
: [[API AnimationGroup SetPlaying|AnimationGroup:SetPlaying]](<span class="apiarg">play</span>)
 
: [[API AnimationGroup SetToFinalAlpha|AnimationGroup:SetToFinalAlpha]]() - Apply the animations final resulting alpha to all animating regions.
 
: [[API AnimationGroup SetToFinalAlpha|AnimationGroup:SetToFinalAlpha]]() - Apply the animations final resulting alpha to all animating regions.
 
: [[API AnimationGroup Stop|AnimationGroup:Stop]]() - Stop all animations in this group.
 
: [[API AnimationGroup Stop|AnimationGroup:Stop]]() - Stop all animations in this group.
Line 137: Line 537:
 
: [[API Alpha GetFromAlpha|Alpha:GetFromAlpha]]() - Gets the start value that the alpha of this animation's parent Region changes by.
 
: [[API Alpha GetFromAlpha|Alpha:GetFromAlpha]]() - Gets the start value that the alpha of this animation's parent Region changes by.
 
: [[API Alpha GetToAlpha|Alpha:GetToAlpha]]() - Gets the end value that the alpha of this animation's parent Region changes by.
 
: [[API Alpha GetToAlpha|Alpha:GetToAlpha]]() - Gets the end value that the alpha of this animation's parent Region changes by.
: [[API Alpha SetFromAlpha|Alpha:SetFromAlpha]](fromAlpha) - Sets the start value from which the alpha of this animation's parent Region changes by.
+
: [[API Alpha SetFromAlpha|Alpha:SetFromAlpha]](<span class="apiarg">fromAlpha</span>) - Sets the start value from which the alpha of this animation's parent Region changes by.
: [[API Alpha SetToAlpha|Alpha:SetToAlpha]](toAlpha) - Sets the end value from which the alpha of this animation's parent Region changes by.
+
: [[API Alpha SetToAlpha|Alpha:SetToAlpha]](<span class="apiarg">toAlpha</span>) - Sets the end value from which the alpha of this animation's parent Region changes by.
   
 
====Scale====
 
====Scale====
Line 148: Line 548:
 
: [[API Scale GetScale|Scale:GetScale]]() - Gets the X scalar and the Y scalar that the animation's parent Region should scale by.
 
: [[API Scale GetScale|Scale:GetScale]]() - Gets the X scalar and the Y scalar that the animation's parent Region should scale by.
 
: [[API Scale GetToScale|Scale:GetToScale]]() - Gets the X scalar and the Y scalar that the animation will scale to if set.
 
: [[API Scale GetToScale|Scale:GetToScale]]() - Gets the X scalar and the Y scalar that the animation will scale to if set.
: [[API Scale SetFromScale|Scale:SetFromScale]](x, y) - Sets the X scalar and the Y scalar that the animation will scale from.
+
: [[API Scale SetFromScale|Scale:SetFromScale]](<span class="apiarg">x, y</span>) - Sets the X scalar and the Y scalar that the animation will scale from.
: [[API Scale SetOrigin|Scale:SetOrigin]](point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
+
: [[API Scale SetOrigin|Scale:SetOrigin]](<span class="apiarg">point, offsetX, offsetY</span>) - Sets the animation's origin of rotation for its parent Region.
: [[API Scale SetScale|Scale:SetScale]](x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
+
: [[API Scale SetScale|Scale:SetScale]](<span class="apiarg">x, y</span>) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
: [[API Scale SetToScale|Scale:SetToScale]](x, y) - Sets the X scalar and the Y scalar that the animation will scale to.
+
: [[API Scale SetToScale|Scale:SetToScale]](<span class="apiarg">x, y</span>) - Sets the X scalar and the Y scalar that the animation will scale to.
   
 
====LineScale====
 
====LineScale====
Line 160: Line 560:
 
[[UIOBJECT Translation|Translation]] has all the methods from [[#Animation|Animation]], plus the following:
 
[[UIOBJECT Translation|Translation]] has all the methods from [[#Animation|Animation]], plus the following:
 
: [[API Translation GetOffset|Translation:GetOffset]]() - Gets the offset that the animation's parent Region would travel.
 
: [[API Translation GetOffset|Translation:GetOffset]]() - Gets the offset that the animation's parent Region would travel.
: [[API Translation SetOffset|Translation:SetOffset]](x, y) - Sets the offset that the animation's parent Region would travel.
+
: [[API Translation SetOffset|Translation:SetOffset]](<span class="apiarg">x, y</span>) - Sets the offset that the animation's parent Region would travel.
   
 
====LineTranslation====
 
====LineTranslation====
Line 169: Line 569:
   
 
[[UIOBJECT Path|Path]] has all the methods from [[#Animation|Animation]], plus the following:
 
[[UIOBJECT Path|Path]] has all the methods from [[#Animation|Animation]], plus the following:
: [[API Path CreateControlPoint|Path:CreateControlPoint]]([name [, template [, order]]]) - Creates a new control point.
+
: [[API Path CreateControlPoint|Path:CreateControlPoint]](<span class="apiarg">[name [, template [, order]]]</span>) - Creates a new control point.
 
: [[API Path GetControlPoints|Path:GetControlPoints]]() - Gets the control points of the Path.
 
: [[API Path GetControlPoints|Path:GetControlPoints]]() - Gets the control points of the Path.
 
: [[API Path GetCurve|Path:GetCurve]]() - Gets the current curve type.
 
: [[API Path GetCurve|Path:GetCurve]]() - Gets the current curve type.
 
: [[API Path GetMaxOrder|Path:GetMaxOrder]]() - Gets the maximum order of the Path.
 
: [[API Path GetMaxOrder|Path:GetMaxOrder]]() - Gets the maximum order of the Path.
: [[API Path SetCurve|Path:SetCurve]](curveType) - Sets the curve type, which can be "SMOOTH" or "NONE".
+
: [[API Path SetCurve|Path:SetCurve]](<span class="apiarg">curveType</span>) - Sets the curve type, which can be "SMOOTH" or "NONE".
   
 
====Rotation====
 
====Rotation====
Line 182: Line 582:
 
: [[API Rotation GetOrigin|Rotation:GetOrigin]]() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
 
: [[API Rotation GetOrigin|Rotation:GetOrigin]]() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
 
: [[API Rotation GetRadians|Rotation:GetRadians]]() - Gets the amount of radians that the animation's parent Region would travel.
 
: [[API Rotation GetRadians|Rotation:GetRadians]]() - Gets the amount of radians that the animation's parent Region would travel.
: [[API Rotation SetDegrees|Rotation:SetDegrees]](degrees) - Sets the amount of degrees that the animation's parent Region would rotate.
+
: [[API Rotation SetDegrees|Rotation:SetDegrees]](<span class="apiarg">degrees</span>) - Sets the amount of degrees that the animation's parent Region would rotate.
: [[API Rotation SetOrigin|Rotation:SetOrigin]](point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
+
: [[API Rotation SetOrigin|Rotation:SetOrigin]](<span class="apiarg">point, offsetX, offsetY</span>) - Sets the animation's origin of rotation for its parent Region.
: [[API Rotation SetRadians|Rotation:SetRadians]](radians) - Sets the amount of radians that the animation's parent Region would travel.
+
: [[API Rotation SetRadians|Rotation:SetRadians]](<span class="apiarg">radians</span>) - Sets the amount of radians that the animation's parent Region would travel.
   
 
====TextureCoordTranslation====
 
====TextureCoordTranslation====
Line 194: Line 594:
 
: [[API ControlPoint GetOrder|ControlPoint:GetOrder]]()
 
: [[API ControlPoint GetOrder|ControlPoint:GetOrder]]()
 
: [[API ControlPoint SetOffset|ControlPoint:SetOffset]]()
 
: [[API ControlPoint SetOffset|ControlPoint:SetOffset]]()
: [[API ControlPoint SetOrder|ControlPoint:SetOrder]](order)
+
: [[API ControlPoint SetOrder|ControlPoint:SetOrder]](<span class="apiarg">order</span>)
 
: [[API ControlPoint SetParent|ControlPoint:SetParent]]()
 
: [[API ControlPoint SetParent|ControlPoint:SetParent]]()
   
Line 219: Line 619:
 
: [[API Line GetStartPoint|Line:GetStartPoint]]() - Gets the point from where the line starts.
 
: [[API Line GetStartPoint|Line:GetStartPoint]]() - Gets the point from where the line starts.
 
: [[API Line GetThickness|Line:GetThickness]]() - Gets this line's thickness.
 
: [[API Line GetThickness|Line:GetThickness]]() - Gets this line's thickness.
: [[API Line SetEndPoint|Line:SetEndPoint]](relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]) - Sets the point at which the line ends.
+
: [[API Line SetEndPoint|Line:SetEndPoint]](<span class="apiarg">relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]</span>) - Sets the point at which the line ends.
: [[API Line SetStartPoint|Line:SetStartPoint]](relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]) - Sets the point from where the line starts.
+
: [[API Line SetStartPoint|Line:SetStartPoint]](<span class="apiarg">relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]</span>) - Sets the point from where the line starts.
: [[API Line SetThickness|Line:SetThickness]](thickness) - Sets this line's thickness.
+
: [[API Line SetThickness|Line:SetThickness]](<span class="apiarg">thickness</span>) - Sets this line's thickness.
   
 
==Frame==
 
==Frame==
Line 233: Line 633:
 
: [[API Browser NavigateBack|Browser:NavigateBack]]()
 
: [[API Browser NavigateBack|Browser:NavigateBack]]()
 
: [[API Browser NavigateForward|Browser:NavigateForward]]()
 
: [[API Browser NavigateForward|Browser:NavigateForward]]()
: [[API Browser NavigateHome|Browser:NavigateHome]](tag)
+
: [[API Browser NavigateHome|Browser:NavigateHome]](<span class="apiarg">tag</span>)
 
: [[API Browser NavigateReload|Browser:NavigateReload]]()
 
: [[API Browser NavigateReload|Browser:NavigateReload]]()
 
: [[API Browser NavigateStop|Browser:NavigateStop]]()
 
: [[API Browser NavigateStop|Browser:NavigateStop]]()
 
: [[API Browser OpenExternalLink|Browser:OpenExternalLink]]()
 
: [[API Browser OpenExternalLink|Browser:OpenExternalLink]]()
: [[API Browser OpenTicket|Browser:OpenTicket]](index)
+
: [[API Browser OpenTicket|Browser:OpenTicket]](<span class="apiarg">index</span>)
 
: [[API Browser SetFocus|Browser:SetFocus]]()
 
: [[API Browser SetFocus|Browser:SetFocus]]()
: [[API Browser SetZoom|Browser:SetZoom]](zoom)
+
: [[API Browser SetZoom|Browser:SetZoom]](<span class="apiarg">zoom</span>)
   
 
===Button===
 
===Button===
Line 248: Line 648:
   
 
====ItemButton====
 
====ItemButton====
[[UIOBJECT ItemButton|ItemButton]] is an [[XML_properties#intrinsic|intrinsic]] frame.
+
[[UIOBJECT ItemButton|ItemButton]] is an [[intrinsic frame]].
   
 
It has all the methods from [[#Button|Button]] and [https://www.townlong-yak.com/framexml/go/ItemButtonMixin ItemButtonMixin].
 
It has all the methods from [[#Button|Button]] and [https://www.townlong-yak.com/framexml/go/ItemButtonMixin ItemButtonMixin].
Line 273: Line 673:
 
: [[API ColorSelect GetColorWheelTexture|ColorSelect:GetColorWheelTexture]]() - Get the texture for the color wheel - New in 1.11.
 
: [[API ColorSelect GetColorWheelTexture|ColorSelect:GetColorWheelTexture]]() - Get the texture for the color wheel - New in 1.11.
 
: [[API ColorSelect GetColorWheelThumbTexture|ColorSelect:GetColorWheelThumbTexture]]() - Get the texture for the color wheel thumb - New in 1.11.
 
: [[API ColorSelect GetColorWheelThumbTexture|ColorSelect:GetColorWheelThumbTexture]]() - Get the texture for the color wheel thumb - New in 1.11.
: [[API ColorSelect SetColorHSV|ColorSelect:SetColorHSV]](h, s, v) - Set to a specific HSV color.
+
: [[API ColorSelect SetColorHSV|ColorSelect:SetColorHSV]](<span class="apiarg">h, s, v</span>) - Set to a specific HSV color.
: [[API ColorSelect SetColorRGB|ColorSelect:SetColorRGB]](r, g, b) - Set to a specific RGB color.
+
: [[API ColorSelect SetColorRGB|ColorSelect:SetColorRGB]](<span class="apiarg">r, g, b</span>) - Set to a specific RGB color.
: [[API ColorSelect SetColorValueTexture|ColorSelect:SetColorValueTexture]](texturebool) - Set the texture used to show color value - New in 1.11.
+
: [[API ColorSelect SetColorValueTexture|ColorSelect:SetColorValueTexture]](<span class="apiarg">texturebool</span>) - Set the texture used to show color value - New in 1.11.
: [[API ColorSelect SetColorValueThumbTexture|ColorSelect:SetColorValueThumbTexture]](texturebool) - Set the texture for the color value thumb - New in 1.11.
+
: [[API ColorSelect SetColorValueThumbTexture|ColorSelect:SetColorValueThumbTexture]](<span class="apiarg">texturebool</span>) - Set the texture for the color value thumb - New in 1.11.
: [[API ColorSelect SetColorWheelTexture|ColorSelect:SetColorWheelTexture]](texturebool) - Set the texture for the color wheel - New in 1.11.
+
: [[API ColorSelect SetColorWheelTexture|ColorSelect:SetColorWheelTexture]](<span class="apiarg">texturebool</span>) - Set the texture for the color wheel - New in 1.11.
: [[API ColorSelect SetColorWheelThumbTexture|ColorSelect:SetColorWheelThumbTexture]](texturebool) - Set the texture for the color wheel thumb - New in 1.11.
+
: [[API ColorSelect SetColorWheelThumbTexture|ColorSelect:SetColorWheelThumbTexture]](<span class="apiarg">texturebool</span>) - Set the texture for the color wheel thumb - New in 1.11.
   
 
===Cooldown===
 
===Cooldown===
Line 285: Line 685:
 
===EditBox===
 
===EditBox===
 
[[UIOBJECT EditBox|EditBox]] has all the methods from [[#Frame|Frame]] and [[#FontInstance|FontInstance]], plus the following:
 
[[UIOBJECT EditBox|EditBox]] has all the methods from [[#Frame|Frame]] and [[#FontInstance|FontInstance]], plus the following:
: [[API EditBox AddHistoryLine|EditBox:AddHistoryLine]](text) - Add text to the edit history.
+
: [[API EditBox AddHistoryLine|EditBox:AddHistoryLine]](<span class="apiarg">text</span>) - Add text to the edit history.
 
: [[API EditBox ClearFocus|EditBox:ClearFocus]]()
 
: [[API EditBox ClearFocus|EditBox:ClearFocus]]()
 
: [[API EditBox ClearHistory|EditBox:ClearHistory]]()
 
: [[API EditBox ClearHistory|EditBox:ClearHistory]]()
  +
: [[API EditBox ClearHighlightText|EditBox:ClearHighlightText]]()
 
: [[API EditBox Disable|EditBox:Disable]]()
 
: [[API EditBox Disable|EditBox:Disable]]()
 
: [[API EditBox Enable|EditBox:Enable]]()
 
: [[API EditBox Enable|EditBox:Enable]]()
Line 306: Line 707:
 
: [[API EditBox GetVisibleTextByteLimit|EditBox:GetVisibleTextByteLimit]]()
 
: [[API EditBox GetVisibleTextByteLimit|EditBox:GetVisibleTextByteLimit]]()
 
: [[API EditBox HasFocus|EditBox:HasFocus]]() - Returns whether the edit box is currently being edited (has edit focus).
 
: [[API EditBox HasFocus|EditBox:HasFocus]]() - Returns whether the edit box is currently being edited (has edit focus).
: [[API EditBox HighlightText|EditBox:HighlightText]]([startPos, endPos]) - Set the highlight to all or some of the edit box text.
+
: [[API EditBox HighlightText|EditBox:HighlightText]](<span class="apiarg">[startPos, endPos]</span>) - Set the highlight to all or some of the edit box text.
: [[API EditBox Insert|EditBox:Insert]](text) - Insert text into the edit box.
+
: [[API EditBox Insert|EditBox:Insert]](<span class="apiarg">text</span>) - Insert text into the edit box.
 
: [[API EditBox IsAutoFocus|EditBox:IsAutoFocus]]() - Determine if the EditBox has autofocus enabled - New in 1.11.
 
: [[API EditBox IsAutoFocus|EditBox:IsAutoFocus]]() - Determine if the EditBox has autofocus enabled - New in 1.11.
 
: [[API EditBox IsCountInvisibleLetters|EditBox:IsCountInvisibleLetters]]()
 
: [[API EditBox IsCountInvisibleLetters|EditBox:IsCountInvisibleLetters]]()
Line 316: Line 717:
 
: [[API EditBox IsPassword|EditBox:IsPassword]]() - Determine if the EditBox performs password masking - New in 1.11.
 
: [[API EditBox IsPassword|EditBox:IsPassword]]() - Determine if the EditBox performs password masking - New in 1.11.
 
: [[API EditBox IsSecureText|EditBox:IsSecureText]]()
 
: [[API EditBox IsSecureText|EditBox:IsSecureText]]()
: [[API EditBox SetAltArrowKeyMode|EditBox:SetAltArrowKeyMode]](enable) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.
+
: [[API EditBox SetAltArrowKeyMode|EditBox:SetAltArrowKeyMode]](<span class="apiarg">enable</span>) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.
: [[API EditBox SetAutoFocus|EditBox:SetAutoFocus]](state) - Set whether or not the editbox will attempt to get input focus when it gets shown (default: yes) - New in 1.11.
+
: [[API EditBox SetAutoFocus|EditBox:SetAutoFocus]](<span class="apiarg">state</span>) - Set whether or not the editbox will attempt to get input focus when it gets shown (default: yes) - New in 1.11.
: [[API EditBox SetBlinkSpeed|EditBox:SetBlinkSpeed]](speed)
+
: [[API EditBox SetBlinkSpeed|EditBox:SetBlinkSpeed]](<span class="apiarg">speed</span>)
: [[API EditBox SetCountInvisibleLetters|EditBox:SetCountInvisibleLetters]]()
+
: [[API EditBox SetCountInvisibleLetters|EditBox:SetCountInvisibleLetters]](<span class="apiarg">state</span>) - Sets if invisible characters should count towards max letter count.
: [[API EditBox SetCursorPosition|EditBox:SetCursorPosition]](position) - Set the position of the cursor within the EditBox - New in 2.3.
+
: [[API EditBox SetCursorPosition|EditBox:SetCursorPosition]](<span class="apiarg">position</span>) - Set the position of the cursor within the EditBox - New in 2.3.
 
: [[API EditBox SetEnabled|EditBox:SetEnabled]]()
 
: [[API EditBox SetEnabled|EditBox:SetEnabled]]()
 
: [[API EditBox SetFocus|EditBox:SetFocus]]() - Move input focus (the cursor) to this editbox
 
: [[API EditBox SetFocus|EditBox:SetFocus]]() - Move input focus (the cursor) to this editbox
 
: [[API EditBox SetHighlightColor|EditBox:SetHighlightColor]]()
 
: [[API EditBox SetHighlightColor|EditBox:SetHighlightColor]]()
 
: [[API EditBox SetHistoryLines|EditBox:SetHistoryLines]](numLines) - Set the number of history lines to remember.
 
: [[API EditBox SetHistoryLines|EditBox:SetHistoryLines]](numLines) - Set the number of history lines to remember.
: [[API EditBox SetMaxBytes|EditBox:SetMaxBytes]](maxBytes) - Set the maximum byte size for entered text.
+
: [[API EditBox SetMaxBytes|EditBox:SetMaxBytes]](<span class="apiarg">maxBytes</span>) - Set the maximum byte size for entered text.
: [[API EditBox SetMaxLetters|EditBox:SetMaxLetters]](maxLetters) - Set the maximum number of letters for entered text.
+
: [[API EditBox SetMaxLetters|EditBox:SetMaxLetters]](<span class="apiarg">maxLetters</span>) - Set the maximum number of letters for entered text.
: [[API EditBox SetMultiLine|EditBox:SetMultiLine]](state) - Set the EditBox's multi-line state - New in 1.11.
+
: [[API EditBox SetMultiLine|EditBox:SetMultiLine]](<span class="apiarg">state</span>) - Set the EditBox's multi-line state - New in 1.11.
: [[API EditBox SetNumber|EditBox:SetNumber]](number)
+
: [[API EditBox SetNumber|EditBox:SetNumber]](<span class="apiarg">number</span>)
: [[API EditBox SetNumeric|EditBox:SetNumeric]](state) - Set if the EditBox only accepts numeric input - New in 1.11.
+
: [[API EditBox SetNumeric|EditBox:SetNumeric]](<span class="apiarg">state</span>) - Set if the EditBox only accepts numeric input - New in 1.11.
: [[API EditBox SetPassword|EditBox:SetPassword]](state) - Set the EditBox's password masking state - New in 1.11.
+
: [[API EditBox SetPassword|EditBox:SetPassword]](<span class="apiarg">state</span>) - Set the EditBox's password masking state - New in 1.11.
 
: [[API EditBox SetSecureText|EditBox:SetSecureText]]()
 
: [[API EditBox SetSecureText|EditBox:SetSecureText]]()
 
: [[API EditBox SetSecurityDisablePaste|EditBox:SetSecurityDisablePaste]]()
 
: [[API EditBox SetSecurityDisablePaste|EditBox:SetSecurityDisablePaste]]()
 
: [[API EditBox SetSecurityDisableSetText|EditBox:SetSecurityDisableSetText]]()
 
: [[API EditBox SetSecurityDisableSetText|EditBox:SetSecurityDisableSetText]]()
: [[API EditBox SetText|EditBox:SetText]](text) - Set the text contained in the edit box.
+
: [[API EditBox SetText|EditBox:SetText]](<span class="apiarg">text</span>) - Set the text contained in the edit box.
: [[API EditBox SetTextInsets|EditBox:SetTextInsets]](l, r, t, b)
+
: [[API EditBox SetTextInsets|EditBox:SetTextInsets]](<span class="apiarg">l, r, t, b</span>)
: [[API EditBox SetVisibleTextByteLimit|EditBox:SetVisibleTextByteLimit]](maxVisibleBytes)
+
: [[API EditBox SetVisibleTextByteLimit|EditBox:SetVisibleTextByteLimit]](<span class="apiarg">maxVisibleBytes</span>)
 
: [[API EditBox ToggleInputLanguage|EditBox:ToggleInputLanguage]]()
 
: [[API EditBox ToggleInputLanguage|EditBox:ToggleInputLanguage]]()
 
===FogOfWarFrame===
 
[[UIOBJECT FogOfWarFrame|FogOfWarFrame]] has all the methods from [[#Frame|Frame]], plus the following:
 
: [[API FogOfWarFrame GetFogOfWarBackgroundAtlas|FogOfWarFrame:GetFogOfWarBackgroundAtlas]]()
 
: [[API FogOfWarFrame GetFogOfWarBackgroundTexture|FogOfWarFrame:GetFogOfWarBackgroundTexture]]()
 
: [[API FogOfWarFrame GetFogOfWarMaskAtlas|FogOfWarFrame:GetFogOfWarMaskAtlas]]()
 
: [[API FogOfWarFrame GetFogOfWarMaskTexture|FogOfWarFrame:GetFogOfWarMaskTexture]]()
 
: [[API FogOfWarFrame GetMaskScalar|FogOfWarFrame:GetMaskScalar]]()
 
: [[API FogOfWarFrame GetUiMapID|FogOfWarFrame:GetUiMapID]]()
 
: [[API FogOfWarFrame SetFogOfWarBackgroundAtlas|FogOfWarFrame:SetFogOfWarBackgroundAtlas]](atlasName)
 
: [[API FogOfWarFrame SetFogOfWarBackgroundTexture|FogOfWarFrame:SetFogOfWarBackgroundTexture]](textureName or FileDataID, [horizontalTile, verticalTile])
 
: [[API FogOfWarFrame SetFogOfWarMaskAtlas|FogOfWarFrame:SetFogOfWarMaskAtlas]](atlasName)
 
: [[API FogOfWarFrame SetFogOfWarMaskTexture|FogOfWarFrame:SetFogOfWarMaskTexture]](textureName)
 
: [[API FogOfWarFrame SetMaskScalar|FogOfWarFrame:SetMaskScalar]](mapID)
 
: [[API FogOfWarFrame SetUiMapID|FogOfWarFrame:SetUiMapID]]()
 
   
 
===GameTooltip===
 
===GameTooltip===
  +
{{:UIOBJECT GameTooltip|t=w}}
The tooltip automatically resizes itself when its [[API Region Show|Region:Show]]() method is called.
 
 
[[UIOBJECT GameTooltip|GameTooltip]] has all the methods from [[#Frame|Frame]], plus the following:
 
: [[API GameTooltip AddAtlas|GameTooltip:AddAtlas]](atlas [, minx, maxx, miny, maxy] or [, textureInfoTable])
 
: [[API GameTooltip AddDoubleLine|GameTooltip:AddDoubleLine]](textL, textR, rL, gL, bL, rR, gR, bR)
 
: [[API GameTooltip AddFontStrings|GameTooltip:AddFontStrings]](leftstring, rightstring) - Dynamically expands the size of a tooltip - New in 1.11.
 
: [[API GameTooltip AddLine|GameTooltip:AddLine]](tooltipText [, r, g, b [, wrapText]]) - Appends the new line to the tooltip.
 
: [[API GameTooltip AddSpellByID|GameTooltip:AddSpellByID]](spellID)
 
: [[API GameTooltip AddTexture|GameTooltip:AddTexture]](texture) - Add a texture to the last line added.
 
: [[API GameTooltip AdvanceSecondaryCompareItem|GameTooltip:AdvanceSecondaryCompareItem]]()
 
: [[API GameTooltip AppendText|GameTooltip:AppendText]](text) - Append text to the end of the first line of the tooltip.
 
: [[API GameTooltip ClearLines|GameTooltip:ClearLines]]() - Clear all lines of tooltip (both left and right ones)
 
: [[API GameTooltip CopyTooltip|GameTooltip:CopyTooltip]]()
 
: [[API GameTooltip FadeOut|GameTooltip:FadeOut]]()
 
: [[API GameTooltip GetAnchorType|GameTooltip:GetAnchorType]]() - Returns the current anchoring type.
 
: [[API GameTooltip GetAzeritePowerID|GameTooltip:GetAzeritePowerID]]()
 
: [[API GameTooltip GetItem|GameTooltip:GetItem]]() - Returns name, link.
 
: [[API GameTooltip GetMinimumWidth|GameTooltip:GetMinimumWidth]]()
 
: [[API GameTooltip GetOwner|GameTooltip:GetOwner]]() - Returns owner frame, anchor.
 
: [[API GameTooltip GetPadding|GameTooltip:GetPadding]]()
 
: [[API GameTooltip GetSpell|GameTooltip:GetSpell]]() - Returns name, rank, id.
 
: [[API GameTooltip GetUnit|GameTooltip:GetUnit]]() - Returns unit name, unit id.
 
: [[API GameTooltip IsEquippedItem|GameTooltip:IsEquippedItem]]()
 
: [[API GameTooltip IsOwned|GameTooltip:IsOwned]](frame)
 
: [[API GameTooltip IsUnit|GameTooltip:IsUnit]](unit) - Returns bool.
 
: [[API GameTooltip NumLines|GameTooltip:NumLines]]() - Get the number of lines in the tooltip.
 
: [[API GameTooltip ResetSecondaryCompareItem|GameTooltip:ResetSecondaryCompareItem]]()
 
: [[API GameTooltip SetAchievementByID|GameTooltip:SetAchievementByID]](id)
 
: [[API GameTooltip SetAction|GameTooltip:SetAction]](slot) - Shows the tooltip for the specified action button.
 
: [[API GameTooltip SetAnchorType|GameTooltip:SetAnchorType]](anchorType [,Xoffset] [,Yoffset])
 
: [[API GameTooltip SetArtifactItem|GameTooltip:SetArtifactItem]]()
 
: [[API GameTooltip SetArtifactPowerByID|GameTooltip:SetArtifactPowerByID]]()
 
: [[API GameTooltip SetAzeriteEssence|GameTooltip:SetAzeriteEssence]](essenceID)
 
: [[API GameTooltip SetAzeriteEssenceSlot|GameTooltip:SetAzeriteEssenceSlot]](slot)
 
: [[API GameTooltip SetAzeritePower|GameTooltip:SetAzeritePower]](itemID, itemLevel, powerID[, owningItemLink])
 
: [[API GameTooltip SetBackpackToken|GameTooltip:SetBackpackToken]](id)
 
: [[API GameTooltip SetBagItem|GameTooltip:SetBagItem]](bag, slot)
 
: [[API GameTooltip SetBagItemChild|GameTooltip:SetBagItemChild]]()
 
: [[API GameTooltip SetBuybackItem|GameTooltip:SetBuybackItem]](slot)
 
: [[API GameTooltip SetCompanionPet|GameTooltip:SetCompanionPet]]()
 
: [[API GameTooltip SetCompareAzeritePower|GameTooltip:SetCompareAzeritePower]](itemID, itemLevel, powerID[, owningItemLink])
 
: [[API GameTooltip SetCompareItem|GameTooltip:SetCompareItem]](shoppingTooltipTwo, primaryMouseover)
 
: [[API GameTooltip SetConduit|GameTooltip:SetConduit]](id, rank)
 
: [[API GameTooltip SetCurrencyByID|GameTooltip:SetCurrencyByID]](id)
 
: [[API GameTooltip SetCurrencyToken|GameTooltip:SetCurrencyToken]](tokenId) - Shows the tooltip for the specified token
 
: [[API GameTooltip SetCurrencyTokenByID|GameTooltip:SetCurrencyTokenByID]](currencyID)
 
: [[API GameTooltip SetEquipmentSet|GameTooltip:SetEquipmentSet]](name) - Shows details for the equipment manager set identified by "name".
 
: [[API GameTooltip SetExistingSocketGem|GameTooltip:SetExistingSocketGem]](index, [toDestroy])
 
: [[API GameTooltip SetFrameStack|GameTooltip:SetFrameStack]](showhidden) - Shows the mouseover frame stack, used for debugging.
 
: [[API GameTooltip SetGuildBankItem|GameTooltip:SetGuildBankItem]](tab, id) - Shows the tooltip for the specified guild bank item
 
: [[API GameTooltip SetHeirloomByItemID|GameTooltip:SetHeirloomByItemID]](itemID)
 
: [[API GameTooltip SetHyperlink|GameTooltip:SetHyperlink]](itemString or itemLink) - Changes the item which is displayed in the tooltip according to the passed argument.
 
: [[API GameTooltip SetInboxItem|GameTooltip:SetInboxItem]](index) - Shows the tooltip for the specified mail inbox item.
 
: [[API GameTooltip SetInstanceLockEncountersComplete|GameTooltip:SetInstanceLockEncountersComplete]](index)
 
: [[API GameTooltip SetInventoryItem|GameTooltip:SetInventoryItem]](unit, slot[, nameOnly, hideUselessStats])
 
: [[API GameTooltip SetInventoryItemByID|GameTooltip:SetInventoryItemByID]](itemID)
 
: [[API GameTooltip SetItemByID|GameTooltip:SetItemByID]](itemID) - Shows the tooltip for a specified Item ID. (added in [http://github.com/tekkub/wow-ui-source/commit/bd6faf4e8ccc4138d3c686bf9ee361e20f4a6531#L48R641 4.2.0.14002] along with the [[World_of_Warcraft_API#Encounter_Journal_Functions|Encounter Journal]])
 
: [[API GameTooltip SetItemKey|GameTooltip:SetItemKey]](itemID, itemLevel, itemSuffix)
 
: [[API GameTooltip SetLFGDungeonReward|GameTooltip:SetLFGDungeonReward]](dungeonID, lootIndex)
 
: [[API GameTooltip SetLFGDungeonShortageReward|GameTooltip:SetLFGDungeonShortageReward]](dungeonID, shortageSeverity, lootIndex)
 
: [[API GameTooltip SetLootCurrency|GameTooltip:SetLootCurrency]](lootSlot)
 
: [[API GameTooltip SetLootItem|GameTooltip:SetLootItem]](lootSlot)
 
: [[API GameTooltip SetLootRollItem|GameTooltip:SetLootRollItem]](id) - Shows the tooltip for the specified loot roll item.
 
: [[API GameTooltip SetMerchantCostItem|GameTooltip:SetMerchantCostItem]](index, item)
 
: [[API GameTooltip SetMerchantItem|GameTooltip:SetMerchantItem]](merchantSlot)
 
: [[API GameTooltip SetMinimumWidth|GameTooltip:SetMinimumWidth]](width) - (Formerly SetMoneyWidth)
 
: [[API GameTooltip SetMountBySpellID|GameTooltip:SetMountBySpellID]]()
 
: [[API GameTooltip SetOwnedItemByID|GameTooltip:SetOwnedItemByID]](ID)
 
: [[API GameTooltip SetOwner|GameTooltip:SetOwner]](owner, anchor[, x, y])
 
: [[API GameTooltip SetPadding|GameTooltip:SetPadding]](width, height)
 
: [[API GameTooltip SetPetAction|GameTooltip:SetPetAction]](slot) - Shows the tooltip for the specified pet action.
 
: [[API GameTooltip SetPossession|GameTooltip:SetPossession]](slot)
 
: [[API GameTooltip SetPvpBrawl|GameTooltip:SetPvpBrawl]]()
 
: [[API GameTooltip SetPvpTalent|GameTooltip:SetPvpTalent]](talentID[, talentIndex])
 
: [[API GameTooltip SetQuestCurrency|GameTooltip:SetQuestCurrency]](type, index)
 
: [[API GameTooltip SetQuestItem|GameTooltip:SetQuestItem]](type, index)
 
: [[API GameTooltip SetQuestLogCurrency|GameTooltip:SetQuestLogCurrency]](type, index)
 
: [[API GameTooltip SetQuestLogItem|GameTooltip:SetQuestLogItem]](type, index)
 
: [[API GameTooltip SetQuestLogRewardSpell|GameTooltip:SetQuestLogRewardSpell]](rewardSpellIndex[, questID])
 
: [[API GameTooltip SetQuestLogSpecialItem|GameTooltip:SetQuestLogSpecialItem]](index)
 
: [[API GameTooltip SetQuestPartyProgress|GameTooltip:SetQuestPartyProgress]](questID, omitTitle, ignoreActivePlayer)
 
: [[API GameTooltip SetQuestRewardSpell|GameTooltip:SetQuestRewardSpell]](rewardSpellIndex)
 
: [[API GameTooltip SetRecipeRankInfo|GameTooltip:SetRecipeRankInfo]](recipeID, learnedRank)
 
: [[API GameTooltip SetRecipeReagentItem|GameTooltip:SetRecipeReagentItem]](recipeID, reagentIndex)
 
: [[API GameTooltip SetRecipeResultItem|GameTooltip:SetRecipeResultItem]](recipeID)
 
: [[API GameTooltip SetRuneforgeResultItem|GameTooltip:SetRuneforgeResultItem]](itemID, itemLevel [, powerID, modifiers])
 
: [[API GameTooltip SetSendMailItem|GameTooltip:SetSendMailItem]]()
 
: [[API GameTooltip SetShapeshift|GameTooltip:SetShapeshift]](slot) - Shows the tooltip for the specified shapeshift form.
 
: [[API GameTooltip SetShrinkToFitWrapped|GameTooltip:SetShrinkToFitWrapped]]()
 
: [[API GameTooltip SetSocketedItem|GameTooltip:SetSocketedItem]]()
 
: [[API GameTooltip SetSocketedRelic|GameTooltip:SetSocketedRelic]](relicSlotIndex)
 
: [[API GameTooltip SetSocketGem|GameTooltip:SetSocketGem]](index)
 
: [[API GameTooltip SetSpellBookItem|GameTooltip:SetSpellBookItem]](spellId, bookType) - Shows the tooltip for the specified spell in the spellbook.
 
: [[API GameTooltip SetSpellByID|GameTooltip:SetSpellByID]](spellId) - Shows the tooltip for the specified spell by global spell ID.
 
: [[API GameTooltip SetTalent|GameTooltip:SetTalent]](talentIndex [, isInspect, talentGroup, inspectedUnit, classId]) - Shows the tooltip for the specified talent.
 
: [[API GameTooltip SetText|GameTooltip:SetText]](text, r, g, b[, alphaValue[, textWrap]]) - Set the text of the tooltip.
 
: [[API GameTooltip SetTotem|GameTooltip:SetTotem]](slot)
 
: [[API GameTooltip SetToyByItemID|GameTooltip:SetToyByItemID]](itemID)
 
: [[API GameTooltip SetTradePlayerItem|GameTooltip:SetTradePlayerItem]](tradeSlot)
 
: [[API GameTooltip SetTradeTargetItem|GameTooltip:SetTradeTargetItem]](tradeSlot)
 
: [[API GameTooltip SetTrainerService|GameTooltip:SetTrainerService]](index)
 
: [[API GameTooltip SetTransmogrifyItem|GameTooltip:SetTransmogrifyItem]](slotId) - Shows the tooltip when there is a pending (de)transmogrification
 
: [[API GameTooltip SetUnit|GameTooltip:SetUnit]](unit[, hideStatus])
 
: [[API GameTooltip SetUnitAura|GameTooltip:SetUnitAura]](unit, auraIndex [, filter]) - Shows the tooltip for a unit's aura. (Exclusive to 3.x.x / WotLK)
 
: [[API GameTooltip SetUnitBuff|GameTooltip:SetUnitBuff]](unit, buffIndex [, raidFilter]) - Shows the tooltip for a unit's buff.
 
: [[API GameTooltip SetUnitDebuff|GameTooltip:SetUnitDebuff]](unit, buffIndex [, raidFilter]) - Shows the tooltip for a unit's debuff.
 
: [[API GameTooltip SetUpgradeItem|GameTooltip:SetUpgradeItem]]()
 
: [[API GameTooltip SetVoidDepositItem|GameTooltip:SetVoidDepositItem]](slotIndex) - Shows the tooltip for the specified Void Transfer [[API_GetVoidTransferDepositInfo|deposit slot]] (added in 4.3.0)
 
: [[API GameTooltip SetVoidItem|GameTooltip:SetVoidItem]](slotIndex) - Shows the tooltip for the specified Void Storage [[API_GetVoidItemInfo|slot]] (added in 4.3.0)
 
: [[API GameTooltip SetVoidWithdrawalItem|GameTooltip:SetVoidWithdrawalItem]](slotIndex) - Shows the tooltip for the specified Void Transfer [[API_GetVoidTransferWithdrawalInfo|withdrawal slot]] (added in 4.3.0)
 
: [[API GameTooltip SetWeeklyReward|GameTooltip:SetWeeklyReward]](itemDBID)
 
: {{Wow-inline}} [[API GameTooltip SetAuctionItem|GameTooltip:SetAuctionItem]](type, index) - Shows the tooltip for the specified auction item.
 
: {{Wow-inline}} [[API GameTooltip SetAuctionSellItem|GameTooltip:SetAuctionSellItem]]()
 
: {{Wow-inline}} [[API GameTooltip SetCraftItem|GameTooltip:SetCraftItem]](index, reagent)
 
: {{Wow-inline}} [[API GameTooltip SetCraftSpell|GameTooltip:SetCraftSpell]](index)
 
: {{Wow-inline}} [[API GameTooltip SetTrackingSpell|GameTooltip:SetTrackingSpell]]()
 
: {{Wow-inline}} [[API GameTooltip SetTradeSkillItem|GameTooltip:SetTradeSkillItem]](index [, reagent])
 
   
 
===MessageFrame===
 
===MessageFrame===
 
[[UIOBJECT MessageFrame|MessageFrame]] has all the methods from [[#Frame|Frame]] and [[#FontInstance|FontInstance]], plus the following:
 
[[UIOBJECT MessageFrame|MessageFrame]] has all the methods from [[#Frame|Frame]] and [[#FontInstance|FontInstance]], plus the following:
: [[API MessageFrame AddMessage|MessageFrame:AddMessage]](text, r, g, b, messageGroup, holdTime) - Add a message to the frame which will fade eventually.
+
: [[API MessageFrame AddMessage|MessageFrame:AddMessage]](<span class="apiarg">text, r, g, b, messageGroup, holdTime</span>) - Add a message to the frame which will fade eventually.
 
: [[API MessageFrame Clear|MessageFrame:Clear]]() - Clear the messages from the frame - New in 1.11.
 
: [[API MessageFrame Clear|MessageFrame:Clear]]() - Clear the messages from the frame - New in 1.11.
 
: [[API MessageFrame GetFadeDuration|MessageFrame:GetFadeDuration]]() - Gets the fade duration in seconds - New in 1.11.
 
: [[API MessageFrame GetFadeDuration|MessageFrame:GetFadeDuration]]() - Gets the fade duration in seconds - New in 1.11.
 
: [[API MessageFrame GetFadePower|MessageFrame:GetFadePower]]()
 
: [[API MessageFrame GetFadePower|MessageFrame:GetFadePower]]()
 
: [[API MessageFrame GetFading|MessageFrame:GetFading]]() - Get whether the frame is fading - New in 1.11.
 
: [[API MessageFrame GetFading|MessageFrame:GetFading]]() - Get whether the frame is fading - New in 1.11.
: [[API MessageFrame GetFontStringByID|MessageFrame:GetFontStringByID]](messageID)
+
: [[API MessageFrame GetFontStringByID|MessageFrame:GetFontStringByID]](<span class="apiarg">messageID</span>)
 
: [[API MessageFrame GetInsertMode|MessageFrame:GetInsertMode]]() - Get the insert mode for the frame - New in 1.11.
 
: [[API MessageFrame GetInsertMode|MessageFrame:GetInsertMode]]() - Get the insert mode for the frame - New in 1.11.
 
: [[API MessageFrame GetTimeVisible|MessageFrame:GetTimeVisible]]() - Get the message visibility time in seconds - New in 1.11.
 
: [[API MessageFrame GetTimeVisible|MessageFrame:GetTimeVisible]]() - Get the message visibility time in seconds - New in 1.11.
 
: [[API MessageFrame HasMessageByID|MessageFrame:HasMessageByID]]()
 
: [[API MessageFrame HasMessageByID|MessageFrame:HasMessageByID]]()
: [[API MessageFrame ResetMessageFadeByID|MessageFrame:ResetMessageFadeByID]](messageID)
+
: [[API MessageFrame ResetMessageFadeByID|MessageFrame:ResetMessageFadeByID]](<span class="apiarg">messageID</span>)
: [[API MessageFrame SetFadeDuration|MessageFrame:SetFadeDuration]](seconds) - Set the fade duration - New in 1.11.
+
: [[API MessageFrame SetFadeDuration|MessageFrame:SetFadeDuration]](<span class="apiarg">seconds</span>) - Set the fade duration - New in 1.11.
: [[API MessageFrame SetFadePower|MessageFrame:SetFadePower]](power)
+
: [[API MessageFrame SetFadePower|MessageFrame:SetFadePower]](<span class="apiarg">power</span>)
: [[API MessageFrame SetFading|MessageFrame:SetFading]](status) - Set whether the frame fades messages - New in 1.11.
+
: [[API MessageFrame SetFading|MessageFrame:SetFading]](<span class="apiarg">status</span>) - Set whether the frame fades messages - New in 1.11.
: [[API MessageFrame SetInsertMode|MessageFrame:SetInsertMode]](TOP or BOTTOM) - Set where new messages are inserted - New in 1.11.
+
: [[API MessageFrame SetInsertMode|MessageFrame:SetInsertMode]](<span class="apiarg">TOP or BOTTOM</span>) - Set where new messages are inserted - New in 1.11.
: [[API MessageFrame SetTimeVisible|MessageFrame:SetTimeVisible]](seconds) - Sets the message visibility time - New in 1.11.
+
: [[API MessageFrame SetTimeVisible|MessageFrame:SetTimeVisible]](<span class="apiarg">seconds</span>) - Sets the message visibility time - New in 1.11.
   
 
===Minimap===
 
===Minimap===
  +
{{:UIOBJECT Minimap}}
Addons are not able to create additional Minimap frames.
 
  +
-->
   
  +
===CinematicModel===
[[UIOBJECT Minimap|Minimap]] has all the methods from [[#Frame|Frame]], plus the following:
 
: [[API Minimap GetPingPosition|Minimap:GetPingPosition]]() - Get the last ping location.
 
: [[API Minimap GetZoom|Minimap:GetZoom]]() - Get the current zoom level.
 
: [[API Minimap GetZoomLevels|Minimap:GetZoomLevels]]() - Get the maximum zoom level.
 
: [[API Minimap PingLocation|Minimap:PingLocation]](x, y) - Perform a ping at the specified location. As of 2.4.2 protected while targeting area of effect spells.
 
: [[API Minimap SetArchBlobInsideAlpha|Minimap:SetArchBlobInsideAlpha]](alpha)
 
: [[API Minimap SetArchBlobInsideTexture|Minimap:SetArchBlobInsideTexture]](textureFile)
 
: [[API Minimap SetArchBlobOutsideAlpha|Minimap:SetArchBlobOutsideAlpha]](alpha)
 
: [[API Minimap SetArchBlobOutsideTexture|Minimap:SetArchBlobOutsideTexture]](textureFile)
 
: [[API Minimap SetArchBlobRingAlpha|Minimap:SetArchBlobRingAlpha]](alpha)
 
: [[API Minimap SetArchBlobRingScalar|Minimap:SetArchBlobRingScalar]](scalar)
 
: [[API Minimap SetArchBlobRingTexture|Minimap:SetArchBlobRingTexture]](textureFile)
 
: [[API Minimap SetBlipTexture|Minimap:SetBlipTexture]](textureFile) - Set the file to use for blips (ObjectIcons)
 
: [[API Minimap SetCorpsePOIArrowTexture|Minimap:SetCorpsePOIArrowTexture]](textureFile)
 
: [[API Minimap SetIconTexture|Minimap:SetIconTexture]](textureFile)
 
: [[API Minimap SetMaskTexture|Minimap:SetMaskTexture]](file or fileDataID)
 
: [[API Minimap SetPOIArrowTexture|Minimap:SetPOIArrowTexture]](textureFile)
 
: [[API Minimap SetPlayerTexture|Minimap:SetPlayerTexture]](textureFile) - Set the file to use for the player arrow texture.
 
: [[API Minimap SetQuestBlobInsideAlpha|Minimap:SetQuestBlobInsideAlpha]](alpha)
 
: [[API Minimap SetQuestBlobInsideTexture|Minimap:SetQuestBlobInsideTexture]](textureFile)
 
: [[API Minimap SetQuestBlobOutsideAlpha|Minimap:SetQuestBlobOutsideAlpha]](alpha)
 
: [[API Minimap SetQuestBlobOutsideSelectedTexture|Minimap:SetQuestBlobOutsideSelectedTexture]](textureFile)
 
: [[API Minimap SetQuestBlobOutsideTexture|Minimap:SetQuestBlobOutsideTexture]](textureFile)
 
: [[API Minimap SetQuestBlobRingAlpha|Minimap:SetQuestBlobRingAlpha]](alpha)
 
: [[API Minimap SetQuestBlobRingScalar|Minimap:SetQuestBlobRingScalar]](scalar)
 
: [[API Minimap SetQuestBlobRingTexture|Minimap:SetQuestBlobRingTexture]](textureFile)
 
: [[API Minimap SetStaticPOIArrowTexture|Minimap:SetStaticPOIArrowTexture]](textureFile)
 
: [[API Minimap SetTaskBlobInsideAlpha|Minimap:SetTaskBlobInsideAlpha]](alpha)
 
: [[API Minimap SetTaskBlobInsideTexture|Minimap:SetTaskBlobInsideTexture]](textureFile)
 
: [[API Minimap SetTaskBlobOutsideAlpha|Minimap:SetTaskBlobOutsideAlpha]](alpha)
 
: [[API Minimap SetTaskBlobOutsideSelectedTexture|Minimap:SetTaskBlobOutsideSelectedTexture]](file)
 
: [[API Minimap SetTaskBlobOutsideTexture|Minimap:SetTaskBlobOutsideTexture]](textureFile)
 
: [[API Minimap SetTaskBlobRingAlpha|Minimap:SetTaskBlobRingAlpha]](alpha)
 
: [[API Minimap SetTaskBlobRingScalar|Minimap:SetTaskBlobRingScalar]](scalar)
 
: [[API Minimap SetTaskBlobRingTexture|Minimap:SetTaskBlobRingTexture]](textureFile)
 
: [[API Minimap SetZoom|Minimap:SetZoom]](level) - Set the current zoom level.
 
: [[API Minimap UpdateBlips|Minimap:UpdateBlips]]()
 
 
===Model===
 
Used to display real 3D-mesh geometry as part of the UI.
 
 
[[UIOBJECT Model|Model]] has all the methods from [[#Frame|Frame]], plus the following:
 
: [[API Model AdvanceTime|Model:AdvanceTime]]()
 
: [[API Model ClearFog|Model:ClearFog]]() - Removes all fogging effects currently active in rendering.
 
: [[API Model ClearModel|Model:ClearModel]]() - Removes all geometry from the Model (i.e. makes it empty)
 
: [[API Model ClearTransform|Model:ClearTransform]]()
 
: [[API Model GetCameraDistance|Model:GetCameraDistance]]()
 
: [[API Model GetCameraFacing|Model:GetCameraFacing]]()
 
: [[API Model GetCameraPosition|Model:GetCameraPosition]]()
 
: [[API Model GetCameraRoll|Model:GetCameraRoll]]()
 
: [[API Model GetCameraTarget|Model:GetCameraTarget]]()
 
: [[API Model GetDesaturation|Model:GetDesaturation]]()
 
: [[API Model GetFacing|Model:GetFacing]]() - Returns the direction the model is facing.
 
: [[API Model GetFogColor|Model:GetFogColor]]() - Gets the fog color (r, g, b, a) - New in 1.11.
 
: [[API Model GetFogFar|Model:GetFogFar]]() - Gets the fog far distance - New in 1.11.
 
: [[API Model GetFogNear|Model:GetFogNear]]() - Gets the fog near distance - New in 1.11.
 
: [[API Model GetLight|Model:GetLight]]() - Gets the light specification for the model, returns a list of results compatible with the SetLight method - New in 1.11.
 
: [[API Model GetModelAlpha|Model:GetModelAlpha]]()
 
: [[API Model GetModelDrawLayer|Model:GetModelDrawLayer]]()
 
: [[API Model GetModelFileID|Model:GetModelFileID]]() - Gets the model file ID for this Model - New in 7.0, replaces [[API Model GetModel|Model:GetModel]]().
 
: [[API Model GetModelScale|Model:GetModelScale]]() - Returns the current mesh scaling factor.
 
: [[API Model GetPaused|Model:GetPaused]]()
 
: [[API Model GetPitch|Model:GetPitch]]()
 
: [[API Model GetPosition|Model:GetPosition]]() - Returns the current position of the mesh as x, y, z
 
: [[API Model GetRoll|Model:GetRoll]]()
 
: [[API Model GetShadowEffect|Model:GetShadowEffect]]()
 
: [[API Model GetViewInsets|Model:GetViewInsets]]()
 
: [[API Model GetViewTranslation|Model:GetViewTranslation]]()
 
: [[API Model GetWorldScale|Model:GetWorldScale]]()
 
: [[API Model HasAttachmentPoints|Model:HasAttachmentPoints]]()
 
: [[API Model HasCustomCamera|Model:HasCustomCamera]]()
 
: [[API Model IsUsingModelCenterToTransform|Model:IsUsingModelCenterToTransform]]()
 
: [[API Model MakeCurrentCameraCustom|Model:MakeCurrentCameraCustom]]()
 
: [[API Model ReplaceIconTexture|Model:ReplaceIconTexture]](texture or fileDataID)
 
: [[API Model SetCamera|Model:SetCamera]](index) - Select a pre-defined camera.
 
: [[API Model SetCameraDistance|Model:SetCameraDistance]](distance)
 
: [[API Model SetCameraFacing|Model:SetCameraFacing]](radians)
 
: [[API Model SetCameraPosition|Model:SetCameraPosition]](x, y, z)
 
: [[API Model SetCameraRoll|Model:SetCameraRoll]](radians)
 
: [[API Model SetCameraTarget|Model:SetCameraTarget]](x, y, z)
 
: [[API Model SetCustomCamera|Model:SetCustomCamera]](defaultIndex)
 
: [[API Model SetDesaturation|Model:SetDesaturation]](strength)
 
: [[API Model SetFacing|Model:SetFacing]](facing) - Set the direction that the model is facing.
 
: [[API Model SetFogColor|Model:SetFogColor]](r, g, b[, a]) - Set the fog color and enable fogging.
 
: [[API Model SetFogFar|Model:SetFogFar]](value) - Set the far-clipping plane distance for fogging.
 
: [[API Model SetFogNear|Model:SetFogNear]](value) - Set the near-clipping plane distance for fogging.
 
: [[API Model SetGlow|Model:SetGlow]](...)
 
: [[API Model SetLight|Model:SetLight]](enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - Place the light source used for rendering
 
: [[API Model SetModel|Model:SetModel]](file) - Set the mesh that is displayed in the frame.
 
: [[API Model SetModelAlpha|Model:SetModelAlpha]](alpha)
 
: [[API Model SetModelDrawLayer|Model:SetModelDrawLayer]](layer)
 
: [[API Model SetModelScale|Model:SetModelScale]](scale) - Sets the scale factor for the mesh before rendering.
 
: [[API Model SetParticlesEnabled|Model:SetParticlesEnabled]](bool)
 
: [[API Model SetPaused|Model:SetPaused]](bool)
 
: [[API Model SetPitch|Model:SetPitch]](pitch)
 
: [[API Model SetPosition|Model:SetPosition]](x, y, z) - Set the position of the mesh inside the frame's coordinate system.
 
: [[API Model SetRoll|Model:SetRoll]](roll)
 
: [[API Model SetSequence|Model:SetSequence]](sequence) - Set the animation to be played.
 
: [[API Model SetSequenceTime|Model:SetSequenceTime]](sequence, time)
 
: [[API Model SetShadowEffect|Model:SetShadowEffect]](strength)
 
: [[API Model SetTransform|Model:SetTransform]]()
 
: [[API Model SetViewInsets|Model:SetViewInsets]](l, r, t, b)
 
: [[API Model SetViewTranslation|Model:SetViewTranslation]](x, y)
 
: [[API Model TransformCameraSpaceToModelSpace|Model:TransformCameraSpaceToModelSpace]](positionX, positionY, positionZ)
 
: [[API Model UseModelCenterToTransform|Model:UseModelCenterToTransform]]()
 
 
====PlayerModel====
 
[[UIOBJECT PlayerModel|PlayerModel]] has all the methods from [[#Model|Model]], plus the following:
 
: [[API PlayerModel ApplySpellVisualKit|PlayerModel:ApplySpellVisualKit]](id, [oneShot])
 
: [[API PlayerModel CanSetUnit|PlayerModel:CanSetUnit]](unit)
 
: [[API PlayerModel FreezeAnimation|PlayerModel:FreezeAnimation]](animation, variation, frame)
 
: [[API PlayerModel GetDisplayInfo|PlayerModel:GetDisplayInfo]]()
 
: [[API PlayerModel GetDoBlend|PlayerModel:GetDoBlend]]()
 
: [[API PlayerModel GetKeepModelOnHide|PlayerModel:GetKeepModelOnHide]]()
 
: [[API PlayerModel HasAnimation|PlayerModel:HasAnimation]](animation)
 
: [[API PlayerModel PlayAnimKit|PlayerModel:PlayAnimKit]](id, [loop])
 
: [[API PlayerModel RefreshCamera|PlayerModel:RefreshCamera]]()
 
: [[API PlayerModel RefreshUnit|PlayerModel:RefreshUnit]]()
 
: [[API PlayerModel SetAnimation|PlayerModel:SetAnimation]](animation[, variation])
 
: [[API PlayerModel SetBarberShopAlternateForm|PlayerModel:SetBarberShopAlternateForm]]()
 
: [[API PlayerModel SetCamDistanceScale|PlayerModel:SetCamDistanceScale]](scale)
 
: [[API PlayerModel SetCreature|PlayerModel:SetCreature]](CreatureId)
 
: [[API PlayerModel SetCustomRace|PlayerModel:SetCustomRace]]()
 
: [[API PlayerModel SetDisplayInfo|PlayerModel:SetDisplayInfo]](displayID)
 
: [[API PlayerModel SetDoBlend|PlayerModel:SetDoBlend]]()
 
: [[API PlayerModel SetItem|PlayerModel:SetItem]](itemID[, appearanceModID, itemVisualID])
 
: [[API PlayerModel SetItemAppearance|PlayerModel:SetItemAppearance]](itemAppearanceID[, itemVisualID])
 
: [[API PlayerModel SetKeepModelOnHide|PlayerModel:SetKeepModelOnHide]](bool)
 
: [[API PlayerModel SetPortraitZoom|PlayerModel:SetPortraitZoom]](zoom)
 
: [[API PlayerModel SetRotation|PlayerModel:SetRotation]](rotationRadians)
 
: [[API PlayerModel SetUnit|PlayerModel:SetUnit]](unit)
 
: [[API PlayerModel StopAnimKit|PlayerModel:StopAnimKit]]()
 
: [[API PlayerModel ZeroCachedCenterXY|PlayerModel:ZeroCachedCenterXY]]()
 
 
=====CinematicModel=====
 
 
[[UIOBJECT CinematicModel|CinematicModel]] was added in [[Patch 6.0.2]] and has all the methods from [[#PlayerModel|PlayerModel]], plus the following:
 
[[UIOBJECT CinematicModel|CinematicModel]] was added in [[Patch 6.0.2]] and has all the methods from [[#PlayerModel|PlayerModel]], plus the following:
: [[API CinematicModel EquipItem|CinematicModel:EquipItem]](itemID)
+
: [[API CinematicModel EquipItem|CinematicModel:EquipItem]](<span class="apiarg">itemID</span>)
 
: [[API CinematicModel InitializeCamera|CinematicModel:InitializeCamera]]()
 
: [[API CinematicModel InitializeCamera|CinematicModel:InitializeCamera]]()
 
: [[API CinematicModel InitializePanCamera|CinematicModel:InitializePanCamera]]()
 
: [[API CinematicModel InitializePanCamera|CinematicModel:InitializePanCamera]]()
: [[API CinematicModel SetAnimOffset|CinematicModel:SetAnimOffset]](offset)
+
: [[API CinematicModel SetAnimOffset|CinematicModel:SetAnimOffset]](<span class="apiarg">offset</span>)
: [[API CinematicModel SetCreatureData|CinematicModel:SetCreatureData]](creatureID)
+
: [[API CinematicModel SetCreatureData|CinematicModel:SetCreatureData]](<span class="apiarg">creatureID</span>)
: [[API CinematicModel SetFacingLeft|CinematicModel:SetFacingLeft]](isFacingLeft)
+
: [[API CinematicModel SetFacingLeft|CinematicModel:SetFacingLeft]](<span class="apiarg">isFacingLeft</span>)
: [[API CinematicModel SetFadeTimes|CinematicModel:SetFadeTimes]](fadeIn, fadeOut)
+
: [[API CinematicModel SetFadeTimes|CinematicModel:SetFadeTimes]](<span class="apiarg">fadeIn, fadeOut</span>)
: [[API CinematicModel SetHeightFactor|CinematicModel:SetHeightFactor]](factor)
+
: [[API CinematicModel SetHeightFactor|CinematicModel:SetHeightFactor]](<span class="apiarg">factor</span>)
: [[API CinematicModel SetJumpInfo|CinematicModel:SetJumpInfo]](length, height)
+
: [[API CinematicModel SetJumpInfo|CinematicModel:SetJumpInfo]](<span class="apiarg">length, height</span>)
: [[API CinematicModel SetPanDistance|CinematicModel:SetPanDistance]](scale)
+
: [[API CinematicModel SetPanDistance|CinematicModel:SetPanDistance]](<span class="apiarg">scale</span>)
: [[API CinematicModel SetSpellVisualKit|CinematicModel:SetSpellVisualKit]](kitID)
+
: [[API CinematicModel SetSpellVisualKit|CinematicModel:SetSpellVisualKit]](<span class="apiarg">kitID</span>)
: [[API CinematicModel SetTargetDistance|CinematicModel:SetTargetDistance]](scale)
+
: [[API CinematicModel SetTargetDistance|CinematicModel:SetTargetDistance]](<span class="apiarg">scale</span>)
: [[API CinematicModel StartPan|CinematicModel:StartPan]](panType, timeInSeconds[, doFade, visualKitID])
+
: [[API CinematicModel StartPan|CinematicModel:StartPan]](<span class="apiarg">panType, timeInSeconds[, doFade, visualKitID]</span>)
 
: [[API CinematicModel StopPan|CinematicModel:StopPan]]()
 
: [[API CinematicModel StopPan|CinematicModel:StopPan]]()
 
: [[API CinematicModel UnequipItems|CinematicModel:UnequipItems]]()
 
: [[API CinematicModel UnequipItems|CinematicModel:UnequipItems]]()
   
=====DressUpModel=====
+
===TabardModel===
[[UIOBJECT DressUpModel|DressUpModel]] has all the methods from [[#PlayerModel|PlayerModel]], plus the following:
 
: [[API DressUpModel Dress|DressUpModel:Dress]]() - Sets the model to reflect the character's current inventory.
 
: [[API DressUpModel GetAutoDress|DressUpModel:GetAutoDress]]()
 
: [[API DressUpModel GetSheathed|DressUpModel:GetSheathed]]()
 
: [[API DressUpModel GetSlotTransmogSources|DressUpModel:GetSlotTransmogSources]](slotIndex)
 
: [[API DressUpModel GetUseTransmogSkin|DressUpModel:GetUseTransmogSkin]]()
 
: [[API DressUpModel SetAutoDress|DressUpModel:SetAutoDress]](bool)
 
: [[API DressUpModel SetSheathed|DressUpModel:SetSheathed]](bool)
 
: [[API DressUpModel SetUseTransmogSkin|DressUpModel:SetUseTransmogSkin]](bool)
 
: [[API DressUpModel TryOn|DressUpModel:TryOn]](sourceID [, slotName, illusionID) - Adds the specified item to the model by sourceID.
 
: [[API DressUpModel Undress|DressUpModel:Undress]]() - Sets the model to reflect the character without inventory.
 
: [[API DressUpModel UndressSlot|DressUpModel:UndressSlot]](slotIndex)
 
 
=====TabardModel=====
 
 
[[UIOBJECT TabardModel|TabardModel]] has all the methods from [[#PlayerModel|PlayerModel]], plus the following:
 
[[UIOBJECT TabardModel|TabardModel]] has all the methods from [[#PlayerModel|PlayerModel]], plus the following:
 
: [[API TabardModel CanSaveTabardNow|TabardModel:CanSaveTabardNow]]() - Indicate if the tabard can be saved.
 
: [[API TabardModel CanSaveTabardNow|TabardModel:CanSaveTabardNow]]() - Indicate if the tabard can be saved.
: [[API TabardModel CycleVariation|TabardModel:CycleVariation]](variationIndex, delta)
+
: [[API TabardModel CycleVariation|TabardModel:CycleVariation]](<span class="apiarg">variationIndex, delta</span>)
 
: [[API TabardModel GetLowerBackgroundFileName|TabardModel:GetLowerBackgroundFileName]]()
 
: [[API TabardModel GetLowerBackgroundFileName|TabardModel:GetLowerBackgroundFileName]]()
 
: [[API TabardModel GetLowerEmblemFile|TabardModel:GetLowerEmblemFile]]()
 
: [[API TabardModel GetLowerEmblemFile|TabardModel:GetLowerEmblemFile]]()
: [[API TabardModel GetLowerEmblemTexture|TabardModel:GetLowerEmblemTexture]](textureName)
+
: [[API TabardModel GetLowerEmblemTexture|TabardModel:GetLowerEmblemTexture]](<span class="apiarg">textureName</span>)
 
: [[API TabardModel GetUpperBackgroundFileName|TabardModel:GetUpperBackgroundFileName]]()
 
: [[API TabardModel GetUpperBackgroundFileName|TabardModel:GetUpperBackgroundFileName]]()
 
: [[API TabardModel GetUpperEmblemFile|TabardModel:GetUpperEmblemFile]]()
 
: [[API TabardModel GetUpperEmblemFile|TabardModel:GetUpperEmblemFile]]()
: [[API TabardModel GetUpperEmblemTexture|TabardModel:GetUpperEmblemTexture]](textureName)
+
: [[API TabardModel GetUpperEmblemTexture|TabardModel:GetUpperEmblemTexture]](<span class="apiarg">textureName</span>)
 
: [[API TabardModel InitializeTabardColors|TabardModel:InitializeTabardColors]]()
 
: [[API TabardModel InitializeTabardColors|TabardModel:InitializeTabardColors]]()
 
: [[API TabardModel Save|TabardModel:Save]]() - Save the tabard.
 
: [[API TabardModel Save|TabardModel:Save]]() - Save the tabard.
Line 676: Line 799:
 
[[UIOBJECT ModelScene|ModelScene]] has all the methods from [[#Frame|Frame]], plus the following:
 
[[UIOBJECT ModelScene|ModelScene]] has all the methods from [[#Frame|Frame]], plus the following:
 
: [[API ModelScene ClearFog|ModelScene:ClearFog]]()
 
: [[API ModelScene ClearFog|ModelScene:ClearFog]]()
: [[API ModelScene CreateActor|ModelScene:CreateActor]]()
+
: [[API ModelScene CreateActor|ModelScene:CreateActor]](<span class="apiarg">[name, template]</span>)
: [[API ModelScene GetActorAtIndex|ModelScene:GetActorAtIndex]](actorIndex)
+
: [[API ModelScene GetActorAtIndex|ModelScene:GetActorAtIndex]](<span class="apiarg">actorIndex</span>)
 
: [[API ModelScene GetCameraFarClip|ModelScene:GetCameraFarClip]]()
 
: [[API ModelScene GetCameraFarClip|ModelScene:GetCameraFarClip]]()
 
: [[API ModelScene GetCameraFieldOfView|ModelScene:GetCameraFieldOfView]]()
 
: [[API ModelScene GetCameraFieldOfView|ModelScene:GetCameraFieldOfView]]()
Line 689: Line 812:
 
: [[API ModelScene GetFogFar|ModelScene:GetFogFar]]()
 
: [[API ModelScene GetFogFar|ModelScene:GetFogFar]]()
 
: [[API ModelScene GetFogNear|ModelScene:GetFogNear]]()
 
: [[API ModelScene GetFogNear|ModelScene:GetFogNear]]()
  +
: [[API ModelScene GetItemTransmogInfo|ModelScene:GetItemTransmogInfo]](<span class="apiarg">slotID</span>)
  +
: [[API ModelScene GetItemTransmogInfoList|ModelScene:GetItemTransmogInfoList]]()
 
: [[API ModelScene GetLightAmbientColor|ModelScene:GetLightAmbientColor]]()
 
: [[API ModelScene GetLightAmbientColor|ModelScene:GetLightAmbientColor]]()
 
: [[API ModelScene GetLightDiffuseColor|ModelScene:GetLightDiffuseColor]]()
 
: [[API ModelScene GetLightDiffuseColor|ModelScene:GetLightDiffuseColor]]()
Line 698: Line 823:
 
: [[API ModelScene GetViewTranslation|ModelScene:GetViewTranslation]]()
 
: [[API ModelScene GetViewTranslation|ModelScene:GetViewTranslation]]()
 
: [[API ModelScene IsLightVisible|ModelScene:IsLightVisible]]()
 
: [[API ModelScene IsLightVisible|ModelScene:IsLightVisible]]()
: [[API ModelScene Project3DPointTo2D|ModelScene:Project3DPointTo2D]](x, y, z)
+
: [[API ModelScene Project3DPointTo2D|ModelScene:Project3DPointTo2D]](<span class="apiarg">x, y, z</span>)
: [[API ModelScene SetCameraFarClip|ModelScene:SetCameraFarClip]](value)
+
: [[API ModelScene SetCameraFarClip|ModelScene:SetCameraFarClip]](<span class="apiarg">value</span>)
: [[API ModelScene SetCameraFieldOfView|ModelScene:SetCameraFieldOfView]](radians)
+
: [[API ModelScene SetCameraFieldOfView|ModelScene:SetCameraFieldOfView]](<span class="apiarg">radians</span>)
: [[API ModelScene SetCameraNearClip|ModelScene:SetCameraNearClip]](value)
+
: [[API ModelScene SetCameraNearClip|ModelScene:SetCameraNearClip]](<span class="apiarg">value</span>)
: [[API ModelScene SetCameraOrientationByAxisVectors|ModelScene:SetCameraOrientationByAxisVectors]](forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ) each vector must be orthonormal
+
: [[API ModelScene SetCameraOrientationByAxisVectors|ModelScene:SetCameraOrientationByAxisVectors]](<span class="apiarg">forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ</span>) each vector must be orthonormal
: [[API ModelScene SetCameraOrientationByYawPitchRoll|ModelScene:SetCameraOrientationByYawPitchRoll]](yaw, pitch, roll)
+
: [[API ModelScene SetCameraOrientationByYawPitchRoll|ModelScene:SetCameraOrientationByYawPitchRoll]](<span class="apiarg">yaw, pitch, roll</span>)
: [[API ModelScene SetCameraPosition|ModelScene:SetCameraPosition]](x, y, z)
+
: [[API ModelScene SetCameraPosition|ModelScene:SetCameraPosition]](<span class="apiarg">x, y, z</span>)
: [[API ModelScene SetDrawLayer|ModelScene:SetDrawLayer]](layer)
+
: [[API ModelScene SetDrawLayer|ModelScene:SetDrawLayer]](<span class="apiarg">layer</span>)
: [[API ModelScene SetFogColor|ModelScene:SetFogColor]](r, g, b)
+
: [[API ModelScene SetFogColor|ModelScene:SetFogColor]](<span class="apiarg">r, g, b</span>)
: [[API ModelScene SetFogFar|ModelScene:SetFogFar]](value)
+
: [[API ModelScene SetFogFar|ModelScene:SetFogFar]](<span class="apiarg">value</span>)
: [[API ModelScene SetFogNear|ModelScene:SetFogNear]](value)
+
: [[API ModelScene SetFogNear|ModelScene:SetFogNear]](<span class="apiarg">value</span>)
: [[API ModelScene SetLightAmbientColor|ModelScene:SetLightAmbientColor]](r, g, b)
+
: [[API ModelScene SetItemTransmogInfo|ModelScene:SetItemTransmogInfo]](<span class="apiarg">itemTransmogInfo [, weaponSlotID]</span>)
: [[API ModelScene SetLightDiffuseColor|ModelScene:SetLightDiffuseColor]](r, g, b)
+
: [[API ModelScene SetLightAmbientColor|ModelScene:SetLightAmbientColor]](<span class="apiarg">r, g, b</span>)
: [[API ModelScene SetLightDirection|ModelScene:SetLightDirection]](x, y, z)
+
: [[API ModelScene SetLightDiffuseColor|ModelScene:SetLightDiffuseColor]](<span class="apiarg">r, g, b</span>)
: [[API ModelScene SetLightPosition|ModelScene:SetLightPosition]](x, y, z)
+
: [[API ModelScene SetLightDirection|ModelScene:SetLightDirection]](<span class="apiarg">x, y, z</span>)
: [[API ModelScene SetLightType|ModelScene:SetLightType]](LE_MODEL_LIGHT_TYPE)
+
: [[API ModelScene SetLightPosition|ModelScene:SetLightPosition]](<span class="apiarg">x, y, z</span>)
  +
: [[API ModelScene SetLightType|ModelScene:SetLightType]](<span class="apiarg">LE_MODEL_LIGHT_TYPE</span>)
 
: [[API ModelScene SetLightVisible|ModelScene:SetLightVisible]]()
 
: [[API ModelScene SetLightVisible|ModelScene:SetLightVisible]]()
: [[API ModelScene SetPaused|ModelScene:SetPaused]](paused, [affectsGlobalPause])
+
: [[API ModelScene SetPaused|ModelScene:SetPaused]](<span class="apiarg">paused, [affectsGlobalPause]</span>)
: [[API ModelScene SetViewInsets|ModelScene:SetViewInsets]](l, r, t, b)
+
: [[API ModelScene SetViewInsets|ModelScene:SetViewInsets]](<span class="apiarg">l, r, t, b</span>)
: [[API ModelScene SetViewTranslation|ModelScene:SetViewTranslation]](x, y)
+
: [[API ModelScene SetViewTranslation|ModelScene:SetViewTranslation]](<span class="apiarg">x, y</span>)
 
: [[API ModelScene TakeActor|ModelScene:TakeActor]]()
 
: [[API ModelScene TakeActor|ModelScene:TakeActor]]()
   
Line 738: Line 864:
 
: [[API ModelSceneActor GetModelPath|ModelSceneActor:GetModelPath]]()
 
: [[API ModelSceneActor GetModelPath|ModelSceneActor:GetModelPath]]()
 
: [[API ModelSceneActor GetModelUnitGUID|ModelSceneActor:GetModelUnitGUID]]()
 
: [[API ModelSceneActor GetModelUnitGUID|ModelSceneActor:GetModelUnitGUID]]()
  +
: [[API ModelSceneActor GetObeyHideInTransmogFlag|ModelSceneActor:GetObeyHideInTransmogFlag]]()
 
: [[API ModelSceneActor GetParent|ModelSceneActor:GetParent]]()
 
: [[API ModelSceneActor GetParent|ModelSceneActor:GetParent]]()
 
: [[API ModelSceneActor GetParticleOverrideScale|ModelSceneActor:GetParticleOverrideScale]]()
 
: [[API ModelSceneActor GetParticleOverrideScale|ModelSceneActor:GetParticleOverrideScale]]()
Line 746: Line 873:
 
: [[API ModelSceneActor GetScale|ModelSceneActor:GetScale]]()
 
: [[API ModelSceneActor GetScale|ModelSceneActor:GetScale]]()
 
: [[API ModelSceneActor GetSheathed|ModelSceneActor:GetSheathed]]()
 
: [[API ModelSceneActor GetSheathed|ModelSceneActor:GetSheathed]]()
: [[API ModelSceneActor GetSlotTransmogSources|ModelSceneActor:GetSlotTransmogSources]]()
 
 
: [[API ModelSceneActor GetSpellVisualKit|ModelSceneActor:GetSpellVisualKit]]()
 
: [[API ModelSceneActor GetSpellVisualKit|ModelSceneActor:GetSpellVisualKit]]()
  +
: [[API ModelSceneActor GetUseTransmogChoices|ModelSceneActor:GetUseTransmogChoices]]()
 
: [[API ModelSceneActor GetUseTransmogSkin|ModelSceneActor:GetUseTransmogSkin]]()
 
: [[API ModelSceneActor GetUseTransmogSkin|ModelSceneActor:GetUseTransmogSkin]]()
 
: [[API ModelSceneActor GetYaw|ModelSceneActor:GetYaw]]()
 
: [[API ModelSceneActor GetYaw|ModelSceneActor:GetYaw]]()
Line 756: Line 883:
 
: [[API ModelSceneActor IsUsingCenterForOrigin|ModelSceneActor:IsUsingCenterForOrigin]]()
 
: [[API ModelSceneActor IsUsingCenterForOrigin|ModelSceneActor:IsUsingCenterForOrigin]]()
 
: [[API ModelSceneActor IsVisible|ModelSceneActor:IsVisible]]()
 
: [[API ModelSceneActor IsVisible|ModelSceneActor:IsVisible]]()
: [[API ModelSceneActor PlayAnimationKit|ModelSceneActor:PlayAnimationKit]]()
+
: [[API ModelSceneActor PlayAnimationKit|ModelSceneActor:PlayAnimationKit]](<span class="apiarg">id [, loop]</span>)
: [[API ModelSceneActor SetAlpha|ModelSceneActor:SetAlpha]]()
+
: [[API ModelSceneActor ReleaseFrontEndCharacterDisplays|ModelSceneActor:ReleaseFrontEndCharacterDisplays]]()
: [[API ModelSceneActor SetAnimation|ModelSceneActor:SetAnimation]]()
+
: [[API ModelSceneActor SetAlpha|ModelSceneActor:SetAlpha]](<span class="apiarg">alpha</span>)
: [[API ModelSceneActor SetAnimationBlendOperation|ModelSceneActor:SetAnimationBlendOperation]]()
+
: [[API ModelSceneActor SetAnimation|ModelSceneActor:SetAnimation]](<span class="apiarg">animation [, variation, animSpeed, timeOffsetSecs]</span>)
: [[API ModelSceneActor SetAutoDress|ModelSceneActor:SetAutoDress]]()
+
: [[API ModelSceneActor SetAnimationBlendOperation|ModelSceneActor:SetAnimationBlendOperation]](<span class="apiarg">LE_MODEL_BLEND_OPERATION</span>)
: [[API ModelSceneActor SetDesaturation|ModelSceneActor:SetDesaturation]]()
+
: [[API ModelSceneActor SetAutoDress|ModelSceneActor:SetAutoDress]](<span class="apiarg">true/false</span>)
: [[API ModelSceneActor SetForbidden|ModelSceneActor:SetForbidden]]()
+
: [[API ModelSceneActor SetDesaturation|ModelSceneActor:SetDesaturation]](<span class="apiarg">strength</span>)
: [[API ModelSceneActor SetModelByCreatureDisplayID|ModelSceneActor:SetModelByCreatureDisplayID]]()
+
: [[API ModelSceneActor SetForbidden|ModelSceneActor:SetForbidden]]() - Protected
: [[API ModelSceneActor SetModelByFileID|ModelSceneActor:SetModelByFileID]]()
+
: [[API ModelSceneActor SetFrontEndLobbyModelFromDefaultCharacterDisplay|ModelSceneActor:SetFrontEndLobbyModelFromDefaultCharacterDisplay]]()
: [[API ModelSceneActor SetModelByPath|ModelSceneActor:SetModelByPath]]()
+
: [[API ModelSceneActor SetModelByCreatureDisplayID|ModelSceneActor:SetModelByCreatureDisplayID]](<span class="apiarg">creatureDisplayID</span>)
: [[API ModelSceneActor SetModelByUnit|ModelSceneActor:SetModelByUnit]]("unit" [,sheatheWeapons, autoDress])
+
: [[API ModelSceneActor SetModelByFileID|ModelSceneActor:SetModelByFileID]](<span class="apiarg">fileID [, enableMips]</span>)
  +
: [[API ModelSceneActor SetModelByPath|ModelSceneActor:SetModelByPath]](<span class="apiarg">filePath [, enableMips]</span>)
  +
: [[API ModelSceneActor SetModelByUnit|ModelSceneActor:SetModelByUnit]](<span class="apiarg">"unit" [,sheatheWeapons, autoDress]</span>)
  +
: [[API ModelSceneActor SetObeyHideInTransmogFlag|ModelSceneActor:SetObeyHideInTransmogFlag]](<span class="apiarg">bool</span>)
 
: [[API ModelSceneActor SetParticleOverrideScale|ModelSceneActor:SetParticleOverrideScale]]()
 
: [[API ModelSceneActor SetParticleOverrideScale|ModelSceneActor:SetParticleOverrideScale]]()
: [[API ModelSceneActor SetPaused|ModelSceneActor:SetPaused]](paused [, affectsGlobalPause = true])
+
: [[API ModelSceneActor SetPaused|ModelSceneActor:SetPaused]](<span class="apiarg">paused [, affectsGlobalPause = true]</span>)
: [[API ModelSceneActor SetPitch|ModelSceneActor:SetPitch]]()
+
: [[API ModelSceneActor SetPitch|ModelSceneActor:SetPitch]](<span class="apiarg">pitch</span>)
 
: [[API ModelSceneActor SetPlayerModelFromGlues|ModelSceneActor:SetPlayerModelFromGlues]]()
 
: [[API ModelSceneActor SetPlayerModelFromGlues|ModelSceneActor:SetPlayerModelFromGlues]]()
: [[API ModelSceneActor SetPosition|ModelSceneActor:SetPosition]]()
+
: [[API ModelSceneActor SetPosition|ModelSceneActor:SetPosition]](<span class="apiarg">x, y, z</span>)
: [[API ModelSceneActor SetRoll|ModelSceneActor:SetRoll]]()
+
: [[API ModelSceneActor SetRoll|ModelSceneActor:SetRoll]](<span class="apiarg">roll</span>)
: [[API ModelSceneActor SetScale|ModelSceneActor:SetScale]]()
+
: [[API ModelSceneActor SetScale|ModelSceneActor:SetScale]](<span class="apiarg">scale</span>)
: [[API ModelSceneActor SetSheathed|ModelSceneActor:SetSheathed]]()
+
: [[API ModelSceneActor SetSheathed|ModelSceneActor:SetSheathed]](<span class="apiarg">true/false</span>)
: [[API ModelSceneActor SetShown|ModelSceneActor:SetShown]]()
+
: [[API ModelSceneActor SetShown|ModelSceneActor:SetShown]](<span class="apiarg">true/false</span>)
 
: [[API ModelSceneActor SetSpellVisualKit|ModelSceneActor:SetSpellVisualKit]]()
 
: [[API ModelSceneActor SetSpellVisualKit|ModelSceneActor:SetSpellVisualKit]]()
 
: [[API ModelSceneActor SetUseCenterForOrigin|ModelSceneActor:SetUseCenterForOrigin]]()
 
: [[API ModelSceneActor SetUseCenterForOrigin|ModelSceneActor:SetUseCenterForOrigin]]()
: [[API ModelSceneActor SetUseTransmogSkin|ModelSceneActor:SetUseTransmogSkin]]()
+
: [[API ModelSceneActor SetUseTransmogChoices|ModelSceneActor:SetUseTransmogChoices]](<span class="apiarg">bool</span>)
: [[API ModelSceneActor SetYaw|ModelSceneActor:SetYaw]]()
+
: [[API ModelSceneActor SetUseTransmogSkin|ModelSceneActor:SetUseTransmogSkin]](<span class="apiarg">true/false</span>)
  +
: [[API ModelSceneActor SetYaw|ModelSceneActor:SetYaw]](<span class="apiarg">facing</span>)
 
: [[API ModelSceneActor Show|ModelSceneActor:Show]]()
 
: [[API ModelSceneActor Show|ModelSceneActor:Show]]()
 
: [[API ModelSceneActor StopAnimationKit|ModelSceneActor:StopAnimationKit]]()
 
: [[API ModelSceneActor StopAnimationKit|ModelSceneActor:StopAnimationKit]]()
 
: [[API ModelSceneActor TryOn|ModelSceneActor:TryOn]]()
 
: [[API ModelSceneActor TryOn|ModelSceneActor:TryOn]]()
 
: [[API ModelSceneActor Undress|ModelSceneActor:Undress]]()
 
: [[API ModelSceneActor Undress|ModelSceneActor:Undress]]()
: [[API ModelSceneActor UndressSlot|ModelSceneActor:UndressSlot]]()
+
: [[API ModelSceneActor UndressSlot|ModelSceneActor:UndressSlot]](<span class="apiarg">slotIndex</span>)
  +
<!-- ===MovieFrame===
 
===MovieFrame===
 
 
[[UIOBJECT MovieFrame|MovieFrame]] has all the methods from [[#Frame|Frame]], plus the following:
 
[[UIOBJECT MovieFrame|MovieFrame]] has all the methods from [[#Frame|Frame]], plus the following:
: [[API MovieFrame EnableSubtitles|MovieFrame:EnableSubtitles]](enable) - Enables or disables subtitles for movies played in the frame.
+
: [[API MovieFrame EnableSubtitles|MovieFrame:EnableSubtitles]](<span class="apiarg">enable</span>) - Enables or disables subtitles for movies played in the frame.
: [[API MovieFrame StartMovie|MovieFrame:StartMovie]](movieID [, loop]) - Plays a specified movie in the frame
+
: [[API MovieFrame StartMovie|MovieFrame:StartMovie]](<span class="apiarg">movieID [, loop]</span>) - Plays a specified movie in the frame
: [[API MovieFrame StopMovie|MovieFrame:StopMovie]](enable) - Stops the movie currently playing in the frame
+
: [[API MovieFrame StopMovie|MovieFrame:StopMovie]](<span class="apiarg">enable</span>) - Stops the movie currently playing in the frame
   
 
===OffScreenFrame===
 
===OffScreenFrame===
 
[[UIOBJECT OffScreenFrame|OffScreenFrame]] has all the methods from [[#Frame|Frame]], plus the following:
 
[[UIOBJECT OffScreenFrame|OffScreenFrame]] has all the methods from [[#Frame|Frame]], plus the following:
: [[API OffScreenFrame ApplySnapshot|OffScreenFrame:ApplySnapshot]](texture, ID)
+
: [[API OffScreenFrame ApplySnapshot|OffScreenFrame:ApplySnapshot]](<span class="apiarg">texture, ID</span>)
 
: [[API OffScreenFrame Flush|OffScreenFrame:Flush]]()
 
: [[API OffScreenFrame Flush|OffScreenFrame:Flush]]()
 
: [[API OffScreenFrame GetMaxSnapshots|OffScreenFrame:GetMaxSnapshots]]()
 
: [[API OffScreenFrame GetMaxSnapshots|OffScreenFrame:GetMaxSnapshots]]()
: [[API OffScreenFrame IsSnapshotValid|OffScreenFrame:IsSnapshotValid]](ID)
+
: [[API OffScreenFrame IsSnapshotValid|OffScreenFrame:IsSnapshotValid]](<span class="apiarg">ID</span>)
: [[API OffScreenFrame SetMaxSnapshots|OffScreenFrame:SetMaxSnapshots]](maxSnapshots)
+
: [[API OffScreenFrame SetMaxSnapshots|OffScreenFrame:SetMaxSnapshots]](<span class="apiarg">maxSnapshots</span>)
 
: [[API OffScreenFrame TakeSnapshot|OffScreenFrame:TakeSnapshot]]()
 
: [[API OffScreenFrame TakeSnapshot|OffScreenFrame:TakeSnapshot]]()
 
: [[API OffScreenFrame UsesNPOT|OffScreenFrame:UsesNPOT]]()
 
: [[API OffScreenFrame UsesNPOT|OffScreenFrame:UsesNPOT]]()
Line 812: Line 942:
 
: [[API POIFrame SetBorderAlpha|POIFrame:SetBorderAlpha]]()
 
: [[API POIFrame SetBorderAlpha|POIFrame:SetBorderAlpha]]()
 
: [[API POIFrame SetBorderScalar|POIFrame:SetBorderScalar]]()
 
: [[API POIFrame SetBorderScalar|POIFrame:SetBorderScalar]]()
: [[API POIFrame SetBorderTexture|POIFrame:SetBorderTexture]]([texture or fileDataID])
+
: [[API POIFrame SetBorderTexture|POIFrame:SetBorderTexture]](<span class="apiarg">[texture or fileDataID]</span>)
 
: [[API POIFrame SetFillAlpha|POIFrame:SetFillAlpha]]()
 
: [[API POIFrame SetFillAlpha|POIFrame:SetFillAlpha]]()
 
: [[API POIFrame SetFillTexture|POIFrame:SetFillTexture]]()
 
: [[API POIFrame SetFillTexture|POIFrame:SetFillTexture]]()
Line 834: Line 964:
   
 
===ScrollFrame===
 
===ScrollFrame===
[[UIOBJECT ScrollFrame|ScrollFrame]] has all the methods from [[#Frame|Frame]], plus the following:
+
{{:UIOBJECT ScrollFrame|t=w}}
: [[API ScrollFrame GetHorizontalScroll|ScrollFrame:GetHorizontalScroll]]()
 
: [[API ScrollFrame GetHorizontalScrollRange|ScrollFrame:GetHorizontalScrollRange]]()
 
: [[API ScrollFrame GetScrollChild|ScrollFrame:GetScrollChild]]()
 
: [[API ScrollFrame GetVerticalScroll|ScrollFrame:GetVerticalScroll]]()
 
: [[API ScrollFrame GetVerticalScrollRange|ScrollFrame:GetVerticalScrollRange]]()
 
: [[API ScrollFrame SetHorizontalScroll|ScrollFrame:SetHorizontalScroll]](offset)
 
: [[API ScrollFrame SetScrollChild|ScrollFrame:SetScrollChild]]()
 
: [[API ScrollFrame SetVerticalScroll|ScrollFrame:SetVerticalScroll]](offset)
 
: [[API ScrollFrame UpdateScrollChildRect|ScrollFrame:UpdateScrollChildRect]]() - no longer required after patch 2.3
 
   
 
===ScrollingMessageFrame===
 
===ScrollingMessageFrame===
[[UIOBJECT ScrollingMessageFrame|ScrollingMessageFrame]] is an [[XML_properties#intrinsic|intrinsic]] frame.
+
[[UIOBJECT ScrollingMessageFrame|ScrollingMessageFrame]] is an [[intrinsic frame]].
   
 
It has all the methods from [[#Frame|Frame]], [[#FontInstance|FontInstance]] and [https://www.townlong-yak.com/framexml/go/ScrollingMessageFrameMixin ScrollingMessageFrameMixin].
 
It has all the methods from [[#Frame|Frame]], [[#FontInstance|FontInstance]] and [https://www.townlong-yak.com/framexml/go/ScrollingMessageFrameMixin ScrollingMessageFrameMixin].
Line 855: Line 976:
 
: [[API SimpleHTML GetHyperlinkFormat|SimpleHTML:GetHyperlinkFormat]]() - Set the string.format format to use for displaying hyperlinks - New in 1.11.
 
: [[API SimpleHTML GetHyperlinkFormat|SimpleHTML:GetHyperlinkFormat]]() - Set the string.format format to use for displaying hyperlinks - New in 1.11.
 
: [[API SimpleHTML GetTextData|SimpleHTML:GetTextData]]()
 
: [[API SimpleHTML GetTextData|SimpleHTML:GetTextData]]()
: [[API SimpleHTML SetHyperlinkFormat|SimpleHTML:SetHyperlinkFormat]](format) - Set the string.format format to use for displaying hyperlinks.
+
: [[API SimpleHTML SetHyperlinkFormat|SimpleHTML:SetHyperlinkFormat]](<span class="apiarg">format</span>) - Set the string.format format to use for displaying hyperlinks.
: [[API SimpleHTML SetText|SimpleHTML:SetText]](text) - Set the HTML markup to be displayed (note: if there is ''any'' markup error, it will be displayed as plain text)
+
: [[API SimpleHTML SetText|SimpleHTML:SetText]](<span class="apiarg">text</span>) - Set the HTML markup to be displayed (note: if there is ''any'' markup error, it will be displayed as plain text)
   
 
===Slider===
 
===Slider===
Line 872: Line 993:
 
: [[API Slider IsEnabled|Slider:IsEnabled]]() - Returns enabled status of the slider.
 
: [[API Slider IsEnabled|Slider:IsEnabled]]() - Returns enabled status of the slider.
 
: [[API Slider SetEnabled|Slider:SetEnabled]]()
 
: [[API Slider SetEnabled|Slider:SetEnabled]]()
: [[API Slider SetMinMaxValues|Slider:SetMinMaxValues]](min, max) - Set the bounds of the slider.
+
: [[API Slider SetMinMaxValues|Slider:SetMinMaxValues]](<span class="apiarg">min, max</span>) - Set the bounds of the slider.
: [[API Slider SetObeyStepOnDrag|Slider:SetObeyStepOnDrag]](obeyStep) - Sets whether the slider constrains values to to value steps when dragged.
+
: [[API Slider SetObeyStepOnDrag|Slider:SetObeyStepOnDrag]](<span class="apiarg">obeyStep</span>) - Sets whether the slider constrains values to to value steps when dragged.
: [[API Slider SetOrientation|Slider:SetOrientation]](orientation) - "HORIZONTAL" or "VERTICAL".
+
: [[API Slider SetOrientation|Slider:SetOrientation]](<span class="apiarg">orientation</span>) - "HORIZONTAL" or "VERTICAL".
: [[API Slider SetStepsPerPage|Slider:SetStepsPerPage]](steps) - Controls slider behavior when the user clicks within the slider's tracking area.
+
: [[API Slider SetStepsPerPage|Slider:SetStepsPerPage]](<span class="apiarg">steps</span>) - Controls slider behavior when the user clicks within the slider's tracking area.
: [[API Slider SetThumbTexture|Slider:SetThumbTexture]](texture or fileDataIDbool)
+
: [[API Slider SetThumbTexture|Slider:SetThumbTexture]](<span class="apiarg">texture or fileDataIDbool</span>)
: [[API Slider SetValue|Slider:SetValue]](value) - Set the value of the slider. Also causes the thumb to show on the first call.
+
: [[API Slider SetValue|Slider:SetValue]](<span class="apiarg">value</span>) - Set the value of the slider. Also causes the thumb to show on the first call.
: [[API Slider SetValueStep|Slider:SetValueStep]](value) - Set the step size of the slider.
+
: [[API Slider SetValueStep|Slider:SetValueStep]](<span class="apiarg">value</span>) - Set the step size of the slider.
   
 
===StatusBar===
 
===StatusBar===
Line 891: Line 1,012:
 
: [[API StatusBar GetStatusBarTexture|StatusBar:GetStatusBarTexture]]() - Returns the texture object for the bar - Before 1.11 it returned the filename.
 
: [[API StatusBar GetStatusBarTexture|StatusBar:GetStatusBarTexture]]() - Returns the texture object for the bar - Before 1.11 it returned the filename.
 
: [[API StatusBar GetValue|StatusBar:GetValue]]() - Get the current value of the bar.
 
: [[API StatusBar GetValue|StatusBar:GetValue]]() - Get the current value of the bar.
: [[API StatusBar SetFillStyle|StatusBar:SetFillStyle]](style) - Set the style in which the bar will be filled.
+
: [[API StatusBar SetFillStyle|StatusBar:SetFillStyle]](<span class="apiarg">style</span>) - Set the style in which the bar will be filled.
: [[API StatusBar SetMinMaxValues|StatusBar:SetMinMaxValues]](min, max) - Set the bounds of the bar.
+
: [[API StatusBar SetMinMaxValues|StatusBar:SetMinMaxValues]](<span class="apiarg">min, max</span>) - Set the bounds of the bar.
: [[API StatusBar SetOrientation|StatusBar:SetOrientation]](orientation) - "HORIZONTAL" or "VERTICAL".
+
: [[API StatusBar SetOrientation|StatusBar:SetOrientation]](<span class="apiarg">orientation</span>) - "HORIZONTAL" or "VERTICAL".
: [[API StatusBar SetReverseFill|StatusBar:SetReverseFill]](state) - Sets the fill direction.
+
: [[API StatusBar SetReverseFill|StatusBar:SetReverseFill]](<span class="apiarg">state</span>) - Sets the fill direction.
 
: [[API StatusBar SetRotatesTexture|StatusBar:SetRotatesTexture]]()
 
: [[API StatusBar SetRotatesTexture|StatusBar:SetRotatesTexture]]()
: [[API StatusBar SetStatusBarAtlas|StatusBar:SetStatusBarAtlas]](atlasName)
+
: [[API StatusBar SetStatusBarAtlas|StatusBar:SetStatusBarAtlas]](<span class="apiarg">atlasName</span>)
: [[API StatusBar SetStatusBarColor|StatusBar:SetStatusBarColor]](r, g, b[, alpha]) - Set the color of the bar.
+
: [[API StatusBar SetStatusBarColor|StatusBar:SetStatusBarColor]](<span class="apiarg">r, g, b[, alpha]</span>) - Set the color of the bar.
: [[API StatusBar SetStatusBarTexture|StatusBar:SetStatusBarTexture]](texture or fileDataIDbool [, layer[, subLayer]]) - Sets the texture of the bar - Added texture as valid arg in 1.11.
+
: [[API StatusBar SetStatusBarTexture|StatusBar:SetStatusBarTexture]](<span class="apiarg">texture or fileDataIDbool [, layer[, subLayer]]</span>) - Sets the texture of the bar - Added texture as valid arg in 1.11.
: [[API StatusBar SetValue|StatusBar:SetValue]](value) - Set the value of the bar.
+
: [[API StatusBar SetValue|StatusBar:SetValue]](<span class="apiarg">value</span>) - Set the value of the bar. -->
  +
  +
===FogOfWarFrame===
  +
[[UIOBJECT FogOfWarFrame|FogOfWarFrame]] has all the methods from [[#Frame|Frame]], plus the following:
  +
: [[API FogOfWarFrame GetFogOfWarBackgroundAtlas|FogOfWarFrame:GetFogOfWarBackgroundAtlas]]()
  +
: [[API FogOfWarFrame GetFogOfWarBackgroundTexture|FogOfWarFrame:GetFogOfWarBackgroundTexture]]()
  +
: [[API FogOfWarFrame GetFogOfWarMaskAtlas|FogOfWarFrame:GetFogOfWarMaskAtlas]]()
  +
: [[API FogOfWarFrame GetFogOfWarMaskTexture|FogOfWarFrame:GetFogOfWarMaskTexture]]()
  +
: [[API FogOfWarFrame GetMaskScalar|FogOfWarFrame:GetMaskScalar]]()
  +
: [[API FogOfWarFrame GetUiMapID|FogOfWarFrame:GetUiMapID]]()
  +
: [[API FogOfWarFrame SetFogOfWarBackgroundAtlas|FogOfWarFrame:SetFogOfWarBackgroundAtlas]](<span class="apiarg">atlasName</span>)
  +
: [[API FogOfWarFrame SetFogOfWarBackgroundTexture|FogOfWarFrame:SetFogOfWarBackgroundTexture]](<span class="apiarg">textureName or FileDataID, [horizontalTile, verticalTile]</span>)
  +
: [[API FogOfWarFrame SetFogOfWarMaskAtlas|FogOfWarFrame:SetFogOfWarMaskAtlas]](<span class="apiarg">atlasName</span>)
  +
: [[API FogOfWarFrame SetFogOfWarMaskTexture|FogOfWarFrame:SetFogOfWarMaskTexture]](<span class="apiarg">textureName</span>)
  +
: [[API FogOfWarFrame SetMaskScalar|FogOfWarFrame:SetMaskScalar]](<span class="apiarg">mapID</span>)
  +
: [[API FogOfWarFrame SetUiMapID|FogOfWarFrame:SetUiMapID]]()
   
 
===UnitPositionFrame===
 
===UnitPositionFrame===
 
[[UIOBJECT UnitPositionFrame|UnitPositionFrame]] has all the methods from [[#Frame|Frame]], plus the following:
 
[[UIOBJECT UnitPositionFrame|UnitPositionFrame]] has all the methods from [[#Frame|Frame]], plus the following:
: [[API UnitPositionFrame AddUnit|UnitPositionFrame:AddUnit]](unit, texture, width, height, r, g, b, a, subLayer, showFacing)
+
: [[API UnitPositionFrame AddUnit|UnitPositionFrame:AddUnit]](<span class="apiarg">unit, texture, width, height, r, g, b, a, subLayer, showFacing</span>)
: [[API UnitPositionFrame AddUnitAtlas|UnitPositionFrame:AddUnitAtlas]](unit, texture, width, height, r, g, b, a, subLayer)
+
: [[API UnitPositionFrame AddUnitAtlas|UnitPositionFrame:AddUnitAtlas]](<span class="apiarg">unit, texture, width, height, r, g, b, a, subLayer</span>)
: [[API UnitPositionFrame AddUnitFileID|UnitPositionFrame:AddUnitFileID]](unit, fileID, width, height, r, g, b, a, subLayer, showFacing)
+
: [[API UnitPositionFrame AddUnitFileID|UnitPositionFrame:AddUnitFileID]](<span class="apiarg">unit, fileID, width, height, r, g, b, a, subLayer, showFacing</span>)
 
: [[API UnitPositionFrame ClearUnits|UnitPositionFrame:ClearUnits]]()
 
: [[API UnitPositionFrame ClearUnits|UnitPositionFrame:ClearUnits]]()
 
: [[API UnitPositionFrame FinalizeUnits|UnitPositionFrame:FinalizeUnits]]()
 
: [[API UnitPositionFrame FinalizeUnits|UnitPositionFrame:FinalizeUnits]]()
Line 911: Line 1,047:
 
: [[API UnitPositionFrame GetPlayerPingScale|UnitPositionFrame:GetPlayerPingScale]]()
 
: [[API UnitPositionFrame GetPlayerPingScale|UnitPositionFrame:GetPlayerPingScale]]()
 
: [[API UnitPositionFrame GetUiMapID|UnitPositionFrame:GetUiMapID]]()
 
: [[API UnitPositionFrame GetUiMapID|UnitPositionFrame:GetUiMapID]]()
: [[API UnitPositionFrame SetPlayerPingScale|UnitPositionFrame:SetPlayerPingScale]](scale)
+
: [[API UnitPositionFrame SetPlayerPingScale|UnitPositionFrame:SetPlayerPingScale]](<span class="apiarg">scale</span>)
: [[API UnitPositionFrame SetPlayerPingTexture|UnitPositionFrame:SetPlayerPingTexture]](textureIndex, textureName or fileDataID, [width, height])
+
: [[API UnitPositionFrame SetPlayerPingTexture|UnitPositionFrame:SetPlayerPingTexture]](<span class="apiarg">textureIndex, textureName or fileDataID, [width, height]</span>)
: [[API UnitPositionFrame SetUiMapID|UnitPositionFrame:SetUiMapID]](mapID)
+
: [[API UnitPositionFrame SetUiMapID|UnitPositionFrame:SetUiMapID]](<span class="apiarg">mapID</span>)
: [[API UnitPositionFrame SetUnitColor|UnitPositionFrame:SetUnitColor]](unit, r, g, b, a)
+
: [[API UnitPositionFrame SetUnitColor|UnitPositionFrame:SetUnitColor]](<span class="apiarg">unit, r, g, b, a</span>)
 
: [[API UnitPositionFrame StartPlayerPing|UnitPositionFrame:StartPlayerPing]]()
 
: [[API UnitPositionFrame StartPlayerPing|UnitPositionFrame:StartPlayerPing]]()
 
: [[API UnitPositionFrame StopPlayerPing|UnitPositionFrame:StopPlayerPing]]()
 
: [[API UnitPositionFrame StopPlayerPing|UnitPositionFrame:StopPlayerPing]]()
  +
<!-- ===WorldFrame===
 
===WorldFrame===
+
{{:UIOBJECT WorldFrame|t=w}} -->
WorldFrame is the frame which is used to display 3D world itself; it inherits methods of a normal frame widget. The frame is initially nonprotected, but because nameplates are protected children of the world frame, becomes protected when the first nameplate is seen. No additional WorldFrames may be created by addons.
 
 
The 3D content of this frame is rendered while keeping the '''vertical''' field of vision. So, if you widen (or flatten) WorldFrame, you'll indeed gain a wider horizontal vision angle. Also, if you're designing interface elements covering large areas of valuable screen estate, you might consider sizing WorldFrame down and thus moving it out from under your interface, so that they do not overlap too much.
 
   
 
[[Category:Widgets]]
 
[[Category:Widgets]]

Latest revision as of 15:44, 14 October 2023

Widgets are graphical elements created in Lua with CreateFrame() or via XML. Widget objects can be extended with templates, mixins and intrinsics. The user interface may be inspected with /fstack, /tinspect and development addons like DevTool and Spew.

Note
Note: This list is up to date as of Patch 10.1.0 (49365) Apr 27 2023
Warning Warning: The docs are being migrated to Blizzard's official documentation

Abstract Classes

FrameScriptObject

FrameScriptObject:GetName() : name - Returns the object's global name.
FrameScriptObject:GetObjectType() : objectType - Returns the object's widget type.
FrameScriptObject:IsForbidden() : isForbidden - Returns true if insecure interaction with the object is forbidden.
FrameScriptObject:IsObjectType(objectType) : isType - Returns true if the object belongs to a given widget type or its subtypes.
FrameScriptObject:SetForbidden() #protected - Sets the object to be forbidden from an insecure execution path.

Object

Object:GetDebugName([preferParentKey]) : debugName - Returns the object's debug name.
Object:GetParent() : parent - Returns the parent object.
Object:GetParentKey() : parentKey - Returns the key on the parent that references this object.
Object:SetParentKey(parentKey) - Sets a key on the parent to the child object.

ScriptRegion

ScriptRegion:CanChangeProtectedState() : canChange - Returns true if protected properties of the region can be changed by non-secure scripts.
ScriptRegion:EnableMouse([enable]) - Sets whether the region should receive mouse input.
ScriptRegion:EnableMouseMotion([enable]) - Sets whether the region should receive mouse hover events.
ScriptRegion:EnableMouseWheel([enable]) - Sets whether the region should receive mouse wheel input.
ScriptRegion:GetBottom() : bottom #restrictedframe - Returns the offset in pixels to the bottom edge of the region.
ScriptRegion:GetCenter() : x, y #restrictedframe - Returns the offset in pixels to the center of the region.
ScriptRegion:GetHeight([ignoreRect]) : height - Returns the height of the region.
ScriptRegion:GetLeft() : left #restrictedframe - Returns the offset in pixels to the left edge of the region.
ScriptRegion:GetRect() : left, bottom, width, height #restrictedframe - Returns the coords and size of the region.
ScriptRegion:GetRight() : right #restrictedframe - Returns the offset in pixels to the right edge of the region.
ScriptRegion:GetScaledRect() : left, bottom, width, height - Returns the scaled coords and size of the region.
ScriptRegion:GetScript(scriptTypeName [, bindingType]) : script - Returns the widget script handler.
ScriptRegion:GetSize([ignoreRect]) : width, height - Returns the width and height of the region.
ScriptRegion:GetSourceLocation() : location - Returns the script name and line number where the region was created.
ScriptRegion:GetTop() : top #restrictedframe - Returns the offset in pixels to the top edge of the region.
ScriptRegion:GetWidth([ignoreRect]) : width - Returns the width of the region.
ScriptRegion:HasScript(scriptName) : hasScript - Returns true if the region supports the given script type.
ScriptRegion:Hide() #secureframe - Hides the region.
ScriptRegion:HookScript(scriptTypeName, script [, bindingType]) - Securely post-hooks a widget script handler.
ScriptRegion:IsAnchoringRestricted() : isRestricted - Returns true if the region has cross-region anchoring restrictions applied.
ScriptRegion:IsDragging() : isDragging - Returns true if the region is being dragged.
ScriptRegion:IsMouseClickEnabled() : enabled - Returns true if the region can receive mouse clicks.
ScriptRegion:IsMouseEnabled() : enabled - Returns true if the region can receive mouse input.
ScriptRegion:IsMouseMotionEnabled() : enabled - Returns true if the region can receive mouse hover events.
ScriptRegion:IsMouseMotionFocus() : isMouseMotionFocus - Returns true if the mouse cursor is hovering over the region.
ScriptRegion:IsMouseOver([offsetTop, offsetBottom, offsetLeft, offsetRight]) : isMouseOver - Returns true if the mouse cursor is hovering over the region.
ScriptRegion:IsMouseWheelEnabled() : enabled - Returns true if the region can receive mouse wheel input.
ScriptRegion:IsProtected() : isProtected, isProtectedExplicitly - Returns whether the region is currently protected.
ScriptRegion:IsRectValid() : isValid - Returns true if the region can be positioned on the screen.
ScriptRegion:IsShown() : isShown - Returns true if the region should be shown; it depends on the parents if it's visible.
ScriptRegion:IsVisible() : isVisible - Returns true if the region and its parents are shown.
ScriptRegion:SetMouseClickEnabled([enabled]) - Sets whether the region should receive mouse clicks.
ScriptRegion:SetMouseMotionEnabled([enabled]) - Sets whether the region should receive mouse hover events.
ScriptRegion:SetParent([parent]) - Sets the parent of the region.
ScriptRegion:SetPassThroughButtons([button1, ...]) #nocombat - Allows the region to propagate mouse clicks to underlying regions or the world frame.
ScriptRegion:SetScript(scriptTypeName [, script]) - Sets the widget script handler.
ScriptRegion:SetShown([show]) #secureframe - Shows or hides the region.
ScriptRegion:Show() #secureframe - Shows the region.
ScriptRegionResizing:AdjustPointsOffset(x, y) #secureframe - Adjusts the x and y offset of the region.
ScriptRegionResizing:ClearAllPoints() - Removes all anchor points from the region.
ScriptRegionResizing:ClearPoint(point) - Removes an anchor point from the region by name.
ScriptRegionResizing:ClearPointsOffset() #secureframe - Resets the x and y offset on the region to zero.
ScriptRegionResizing:GetNumPoints() : numPoints - Returns the number of anchor points for the region.
ScriptRegionResizing:GetPoint([anchorIndex]) : point, relativeTo, relativePoint, offsetX, offsetY #restrictedframe - Returns an anchor point for the region.
ScriptRegionResizing:GetPointByName(point) : point, relativeTo, relativePoint, offsetX, offsetY - Returns an anchor point by name for the region.
ScriptRegionResizing:SetAllPoints(relativeTo [, doResize]) - Positions the region the same as another region.
ScriptRegionResizing:SetHeight(height) - Sets the height of the region.
ScriptRegionResizing:SetPoint(point, relativeTo, relativePoint, offsetX, offsetY) #anchorfamily - Sets an anchor point for the region.
ScriptRegionResizing:SetSize(x, y) - Sets the width and height of the region.
ScriptRegionResizing:SetWidth(width) - Sets the width of the region.
AnimatableObject:CreateAnimationGroup([name, templateName]) : group - Creates an animation group.
AnimatableObject:GetAnimationGroups() : scriptObject, ... - Returns the animation groups of this region.
AnimatableObject:StopAnimating() - Stops any active animations on this region.

Region

Region:GetAlpha() : alpha - Returns the region's opacity.
Region:GetDrawLayer() : layer, sublayer - Returns the layer in which the region is drawn.
Region:GetEffectiveScale() : effectiveScale - Returns the scale of the region after propagating from its parents.
Region:GetScale() : scale - Returns the scale of the region.
Region:GetVertexColor() : colorR, colorG, colorB, colorA - Returns the vertex color shading of the region.
Region:IsIgnoringParentAlpha() : isIgnoring - Returns true if the region is ignoring parent alpha.
Region:IsIgnoringParentScale() : isIgnoring - Returns true if the region is ignoring parent scale.
Region:IsObjectLoaded() : isLoaded - Returns true if the region is fully loaded.
Region:SetAlpha(alpha) - Sets the opacity of the region.
Region:SetDrawLayer(layer [, sublevel]) - Sets the layer in which the region is drawn.
Region:SetIgnoreParentAlpha(ignore) - Sets whether the region should ignore its parent's alpha.
Region:SetIgnoreParentScale(ignore) - Sets whether the region should ignore its parent's scale.
Region:SetScale(scale) - Sets the size scaling of the region.
Region:SetVertexColor(colorR, colorG, colorB [, a]) - Sets the vertex shading color of the region.

TextureBase

TextureBase:GetAtlas() : atlas - Returns the atlas for the texture.
TextureBase:GetBlendMode() : blendMode - Returns the blend mode of the texture.
TextureBase:GetDesaturation() : desaturation - Returns the desaturation level of the texture.
TextureBase:GetHorizTile() : tiling - Returns true if the texture is tiling horizontally.
TextureBase:GetRotation() : radians, normalizedRotationPoint - Returns the rotation of the texture.
TextureBase:GetTexCoord() : ULx, ULy, LLx, LLy, URx, URy, LRx, LRy - Returns the texture space coordinates of the texture.
TextureBase:GetTexelSnappingBias() : bias - Returns the texel snapping bias for the texture.
TextureBase:GetTexture() : textureFile - Returns the FileID for the texture.
TextureBase:GetTextureFileID() : textureFile - Returns the FileID for the texture.
TextureBase:GetTextureFilePath() : textureFile - Returns the FileID for the texture.
TextureBase:GetVertTile() : tiling - Returns true if the texture is tiling vertically.
TextureBase:GetVertexOffset(vertexIndex) : offsetX, offsetY - Returns a vertex offset for the texture.
TextureBase:IsBlockingLoadRequested() : blocking
TextureBase:IsDesaturated() : desaturated - Returns true if the texture is desaturated.
TextureBase:IsSnappingToPixelGrid() : snap - Returns true if the texture is snapping to the pixel grid.
TextureBase:SetAtlas(atlas [, useAtlasSize, filterMode, resetTexCoords]) - Sets the texture to an atlas.
TextureBase:SetBlendMode(blendMode) - Sets the blend mode of the texture.
TextureBase:SetBlockingLoadsRequested([blocking])
TextureBase:SetColorTexture(colorR, colorG, colorB [, a]) - Sets the texture to a solid color.
TextureBase:SetDesaturated([desaturated]) - Sets the texture to be desaturated.
TextureBase:SetDesaturation(desaturation) - Sets the desaturation level of the texture.
TextureBase:SetGradient(orientation, minColor, maxColor) - Sets a gradient color shading for the texture.
TextureBase:SetHorizTile([tiling]) - Sets whether the texture should tile horizontally.
TextureBase:SetMask(file) - Applies a mask to the texture.
TextureBase:SetRotation(radians [, normalizedRotationPoint]) - Applies a rotation to the texture.
TextureBase:SetSnapToPixelGrid([snap]) - Sets the texture to snap to the pixel grid.
TextureBase:SetTexCoord(left, right, bottom, top) - Sets the coordinates for cropping or transforming the texture.
TextureBase:SetTexelSnappingBias(bias) - Returns the texel snapping bias for the texture.
TextureBase:SetTexture([textureAsset, wrapModeHorizontal, wrapModeVertical, filterMode]) - Sets the texture to an image.
TextureBase:SetVertTile([tiling]) - Sets whether the texture should tile vertically.
TextureBase:SetVertexOffset(vertexIndex, offsetX, offsetY) - Sets a vertex offset for the texture.

Textures

Texture

Texture:AddMaskTexture(mask)
Texture:GetMaskTexture(index) : mask
Texture:GetNumMaskTextures() : count
Texture:RemoveMaskTexture(mask)

MaskTexture

Line

Line:ClearAllPoints()
Line:GetEndPoint() : relativePoint, relativeTo, offsetX, offsetY
Line:GetStartPoint() : relativePoint, relativeTo, offsetX, offsetY
Line:GetThickness() : thickness
Line:SetEndPoint(relativePoint, relativeTo [, offsetX, offsetY])
Line:SetStartPoint(relativePoint, relativeTo [, offsetX, offsetY])
Line:SetThickness(thickness)

Fonts

Font

Font:CopyFontObject(sourceFont)
Font:GetAlpha() : alpha
Font:GetFont() : fontFile, height, flags
Font:GetFontObject() : font
Font:GetIndentedWordWrap() : wordWrap
Font:GetJustifyH() : justifyH
Font:GetJustifyV() : justifyV
Font:GetShadowColor() : colorR, colorG, colorB, colorA
Font:GetShadowOffset() : offsetX, offsetY
Font:GetSpacing() : spacing
Font:GetTextColor() : colorR, colorG, colorB, colorA
Font:SetAlpha(alpha)
Font:SetFont(fontFile, height, flags)
Font:SetFontObject(font)
Font:SetIndentedWordWrap(wordWrap)
Font:SetJustifyH(justifyH)
Font:SetJustifyV(justifyV)
Font:SetShadowColor(colorR, colorG, colorB [, a])
Font:SetShadowOffset(offsetX, offsetY)
Font:SetSpacing(spacing)
Font:SetTextColor(colorR, colorG, colorB [, a])

FontString

FontString:CalculateScreenAreaFromCharacterSpan(leftIndex, rightIndex) : areas
FontString:CanNonSpaceWrap() : wrap
FontString:CanWordWrap() : wrap
FontString:FindCharacterIndexAtCoordinate(x, y) : characterIndex, inside
FontString:GetFieldSize() : fieldSize
FontString:GetFont() : fontFile, fontHeight, flags
FontString:GetFontObject() : font
FontString:GetIndentedWordWrap() : wrap
FontString:GetJustifyH() : justifyH
FontString:GetJustifyV() : justifyH
FontString:GetLineHeight() : lineHeight
FontString:GetMaxLines() : maxLines
FontString:GetNumLines() : numLines
FontString:GetRotation() : radians
FontString:GetShadowColor() : colorR, colorG, colorB, colorA
FontString:GetShadowOffset() : offsetX, offsetY
FontString:GetSpacing() : spacing
FontString:GetStringHeight() : height
FontString:GetStringWidth() : width
FontString:GetText() : text
FontString:GetTextColor() : colorR, colorG, colorB, colorA
FontString:GetTextScale() : textScale
FontString:GetUnboundedStringWidth() : width
FontString:GetWrappedWidth() : width
FontString:IsTruncated() : isTruncated
FontString:SetAlphaGradient(start, length) : isWithinText
FontString:SetFixedColor(fixedColor)
FontString:SetFont(fontFile, fontHeight, flags)
FontString:SetFontObject(font)
FontString:SetFormattedText(text)
FontString:SetIndentedWordWrap(wrap)
FontString:SetJustifyH(justifyH)
FontString:SetJustifyV(justifyV)
FontString:SetMaxLines(maxLines)
FontString:SetNonSpaceWrap(wrap)
FontString:SetRotation(radians)
FontString:SetShadowColor(colorR, colorG, colorB [, a])
FontString:SetShadowOffset(offsetX, offsetY)
FontString:SetSpacing(spacing)
FontString:SetText([text])
FontString:SetTextColor(colorR, colorG, colorB [, a])
FontString:SetTextHeight(height)
FontString:SetTextScale(textScale)
FontString:SetWordWrap(wrap)

Animations

AnimationGroup

AnimationGroup:CreateAnimation([animationType, name, templateName]) : anim
AnimationGroup:Finish()
AnimationGroup:GetAnimationSpeedMultiplier() : animationSpeedMultiplier
AnimationGroup:GetAnimations() : scriptObject, ...
AnimationGroup:GetDuration() : durationSec
AnimationGroup:GetElapsed() : elapsedSec
AnimationGroup:GetLoopState() : loopState
AnimationGroup:GetLooping() : loopType
AnimationGroup:GetProgress() : progress
AnimationGroup:GetScript(scriptTypeName [, bindingType]) : script
AnimationGroup:HasScript(scriptName) : hasScript
AnimationGroup:HookScript(scriptTypeName, script [, bindingType])
AnimationGroup:IsDone() : isDone
AnimationGroup:IsPaused() : isPaused
AnimationGroup:IsPendingFinish() : isPendingFinish
AnimationGroup:IsPlaying() : isPlaying
AnimationGroup:IsReverse() : isReverse
AnimationGroup:IsSetToFinalAlpha() : isSetToFinalAlpha
AnimationGroup:Pause()
AnimationGroup:Play([reverse, offset])
AnimationGroup:RemoveAnimations()
AnimationGroup:Restart([reverse, offset])
AnimationGroup:SetAnimationSpeedMultiplier(animationSpeedMultiplier)
AnimationGroup:SetLooping(loopType)
AnimationGroup:SetPlaying(play)
AnimationGroup:SetScript(scriptTypeName [, script])
AnimationGroup:SetToFinalAlpha(setToFinalAlpha)
AnimationGroup:Stop()

Animation

Animation:GetDuration() : durationSec
Animation:GetElapsed() : elapsedSec
Animation:GetEndDelay() : delaySec
Animation:GetOrder() : order
Animation:GetProgress() : progress
Animation:GetRegionParent() : region
Animation:GetScript(scriptTypeName [, bindingType]) : script
Animation:GetSmoothProgress() : progress
Animation:GetSmoothing() : weights
Animation:GetStartDelay() : delaySec
Animation:GetTarget() : target
Animation:HasScript(scriptName) : hasScript
Animation:HookScript(scriptTypeName, script [, bindingType])
Animation:IsDelaying() : isDelaying
Animation:IsDone() : isDone
Animation:IsPaused() : isPaused
Animation:IsPlaying() : isPlaying
Animation:IsStopped() : isStopped
Animation:Pause()
Animation:Play()
Animation:Restart()
Animation:SetChildKey(childKey) : success
Animation:SetDuration(durationSec [, recomputeGroupDuration])
Animation:SetEndDelay(delaySec [, recomputeGroupDuration])
Animation:SetOrder(newOrder)
Animation:SetParent(parent [, order])
Animation:SetPlaying(play)
Animation:SetScript(scriptTypeName [, script])
Animation:SetSmoothProgress(durationSec)
Animation:SetSmoothing(weights)
Animation:SetStartDelay(delaySec [, recomputeGroupDuration])
Animation:SetTarget(target) : success
Animation:SetTargetKey(key) : success
Animation:SetTargetName(name) : success
Animation:SetTargetParent() : success
Animation:Stop()

Alpha

Alpha:GetFromAlpha() : normalizedAlpha
Alpha:GetToAlpha() : normalizedAlpha
Alpha:SetFromAlpha(normalizedAlpha)
Alpha:SetToAlpha(normalizedAlpha)

FlipBook

FlipBook:GetFlipBookColumns() : columns
FlipBook:GetFlipBookFrameHeight() : height
FlipBook:GetFlipBookFrameWidth() : width
FlipBook:GetFlipBookFrames() : frames
FlipBook:GetFlipBookRows() : rows
FlipBook:SetFlipBookColumns(columns)
FlipBook:SetFlipBookFrameHeight(height)
FlipBook:SetFlipBookFrameWidth(width)
FlipBook:SetFlipBookFrames(frames)
FlipBook:SetFlipBookRows(rows)

Path

Path:CreateControlPoint([name, templateName, order]) : point
Path:GetControlPoints() : scriptObject, ...
Path:GetCurveType() : curveType
Path:GetMaxControlPointOrder() : maxOrder
Path:SetCurveType(curveType)

ControlPoint

ControlPoint:GetOffset() : offsetX, offsetY
ControlPoint:GetOrder() : order
ControlPoint:SetOffset(offsetX, offsetY)
ControlPoint:SetOrder(order)
ControlPoint:SetParent(parent [, order])

Rotation

Rotation:GetDegrees() : angle
Rotation:GetOrigin() : point, originX, originY
Rotation:GetRadians() : angle
Rotation:SetDegrees(angle)
Rotation:SetOrigin(point, originX, originY)
Rotation:SetRadians(angle)

Scale

Scale:GetOrigin() : point, originX, originY
Scale:GetScale() : scaleX, scaleY
Scale:GetScaleFrom() : scaleX, scaleY
Scale:GetScaleTo() : scaleX, scaleY
Scale:SetOrigin(point, originX, originY)
Scale:SetScale(scaleX, scaleY)
Scale:SetScaleFrom(scaleX, scaleY)
Scale:SetScaleTo(scaleX, scaleY)

TextureCoordTranslation

TextureCoordTranslation:GetOffset() : offsetU, offsetV
TextureCoordTranslation:SetOffset(offsetU, offsetV)

Translation

Translation:GetOffset() : offsetX, offsetY
Translation:SetOffset(offsetX, offsetY)

Frames

Frame

Frame:AbortDrag()
Frame:CanChangeAttribute() : canChangeAttributes
Frame:CreateFontString([name, drawLayer, templateName]) : line - Creates a fontstring.
Frame:CreateLine([name, drawLayer, templateName, subLevel]) : line - Draws a line.
Frame:CreateMaskTexture([name, drawLayer, templateName, subLevel]) : maskTexture - Creates a mask texture.
Frame:CreateTexture([name, drawLayer, templateName, subLevel]) : texture - Creates a texture.
Frame:DesaturateHierarchy(desaturation [, excludeRoot])
Frame:DisableDrawLayer(layer) - Prevents display of the frame on the specified draw layer.
Frame:DoesClipChildren() : clipsChildren
Frame:EnableDrawLayer(layer) - Allows display of the frame on the specified draw layer.
Frame:EnableGamePadButton([enable]) - Allows the receipt of gamepad button inputs for this frame.
Frame:EnableGamePadStick([enable]) - Allows the receipt of gamepad stick inputs for this frame.
Frame:EnableKeyboard([enable]) - Allows this frame to receive keyboard input.
Frame:ExecuteAttribute(attributeName, unpackedPrimitiveType, ...) : success, unpackedPrimitiveType, ...
Frame:GetAlpha() : alpha -> Region:GetAlpha
Frame:GetAttribute(attributeName) : value - Returns the value of a secure frame attribute.
Frame:GetBoundsRect() : left, bottom, width, height
Frame:GetChildren() : child1, ... - Returns a list of child frames belonging to the frame.
Frame:GetClampRectInsets() : left, right, top, bottom - Returns the frame's clamp rectangle offsets.
Frame:GetDontSavePosition() : dontSave
Frame:GetEffectiveAlpha() : effectiveAlpha - Returns the effective alpha after propagating from the parent region.
Frame:GetEffectiveScale() : effectiveScale - Returns the effective scale after propagating from the parent region.
Frame:GetEffectivelyFlattensRenderLayers() : flatten - Returns true if render layer flattening has been implicitly enabled.
Frame:GetFlattensRenderLayers() : flatten - Returns true if render layer flattening has been enabled.
Frame:GetFrameLevel() : frameLevel - Returns the frame level of the frame.
Frame:GetFrameStrata() : strata - Returns the layering strata of the frame.
Frame:GetHitRectInsets() : left, right, top, bottom - Returns the insets of the frame's hit rectangle.
Frame:GetHyperlinksEnabled() : enabled - Returns true if mouse interaction with hyperlinks on the frame is enabled.
Frame:GetID() : id - Returns the frame's numeric identifier.
Frame:GetNumChildren() : numChildren - Returns the number of child frames belonging to the frame.
Frame:GetNumRegions() : numRegions - Returns the number of non-Frame child regions belonging to the frame.
Frame:GetPropagateKeyboardInput() : propagate - Returns whether the frame propagates keyboard events.
Frame:GetRegions() : region1, ... - Returns a list of non-Frame child regions belonging to the frame.
Frame:GetResizeBounds() : minWidth, minHeight, maxWidth, maxHeight - Returns the minimum and maximum size of the frame for user resizing.
Frame:GetScale() : frameScale -> Region:GetScale
Frame:HasFixedFrameLevel() : isFixed
Frame:HasFixedFrameStrata() : isFixed
Frame:Hide() -> ScriptRegion:Hide
Frame:InterceptStartDrag(delegate)
Frame:IsClampedToScreen() : clampedToScreen - Returns whether a frame is prevented from being moved off-screen.
Frame:IsEventRegistered(eventName) : isRegistered, unit1, ... - Returns whether a frame is registered to an event.
Frame:IsGamePadButtonEnabled() : enabled - Checks if this frame is configured to receive gamepad button inputs.
Frame:IsGamePadStickEnabled() : enabled - Checks if this frame is configured to receive gamepad stick inputs.
Frame:IsIgnoringParentAlpha() : ignore -> Region:IsIgnoringParentAlpha
Frame:IsIgnoringParentScale() : ignore -> Region:IsIgnoringParentScale
Frame:IsKeyboardEnabled() : enabled - Returns true if keyboard interactivity is enabled for the frame.
Frame:IsMovable() : isMovable - Returns true if the frame is movable.
Frame:IsObjectLoaded() : isLoaded -> Region:IsObjectLoaded
Frame:IsResizable() : resizable - Returns true if the frame can be resized by the user.
Frame:IsShown() : isShown -> ScriptRegion:IsShown
Frame:IsToplevel() : isTopLevel - Returns whether this frame should raise its frame level on mouse interaction.
Frame:IsUserPlaced() : isUserPlaced - Returns whether the frame has been moved by the user.
Frame:IsVisible() : isVisible -> ScriptRegion:IsVisible
Frame:Lower() - Reduces the frame's frame level below all other frames in its strata.
Frame:Raise() - Increases the frame's frame level above all other frames in its strata.
Frame:RegisterAllEvents() - Flags the frame to receive all events.
Frame:RegisterEvent(eventName) : registered - Registers the frame to an event.
Frame:RegisterForDrag([button1, ...]) - Registers the frame for dragging with a mouse button.
Frame:RegisterUnitEvent(eventName [, unit1, ...]) : registered - Registers the frame for a specific event, triggering only for the specified units.
Frame:RotateTextures(radians [, x, y])
Frame:SetAlpha(alpha) -> Region:SetAlpha
Frame:SetAttribute(attributeName, value) - Sets an attribute on the frame.
Frame:SetAttributeNoHandler(attributeName, value) - Sets an attribute on the frame without triggering the OnAttributeChanged script handler.
Frame:SetClampRectInsets(left, right, top, bottom) - Controls how much of the frame may be moved off-screen.
Frame:SetClampedToScreen(clampedToScreen) - Prevents the frame from moving off-screen.
Frame:SetClipsChildren(clipsChildren)
Frame:SetDontSavePosition(dontSave)
Frame:SetDrawLayerEnabled(layer [, isEnabled])
Frame:SetFixedFrameLevel(isFixed)
Frame:SetFixedFrameStrata(isFixed)
Frame:SetFlattensRenderLayers(flatten) - Controls whether all subregions are composited into a single render layer.
Frame:SetFrameLevel(frameLevel) - Sets the level at which the frame is layered relative to others in its strata.
Frame:SetFrameStrata(strata) - Sets the layering strata of the frame.
Frame:SetHitRectInsets(left, right, top, bottom) #secureframe - Returns the insets of the frame's hit rectangle.
Frame:SetHyperlinksEnabled([enabled]) - Allows mouse interaction with hyperlinks on the frame.
Frame:SetID(id) - Returns the frame's numeric identifier.
Frame:SetIgnoreParentAlpha(ignore) -> Region:SetIgnoreParentAlpha
Frame:SetIgnoreParentScale(ignore) -> Region:SetIgnoreParentScale
Frame:SetIsFrameBuffer(isFrameBuffer) - Controls whether or not a frame is rendered to its own framebuffer prior to being composited atop the UI.
Frame:SetMovable(movable) - Sets whether the frame can be moved.
Frame:SetPropagateKeyboardInput(propagate) #nocombat - Sets whether keyboard input is consumed by this frame or propagates to further frames.
Frame:SetResizable(resizable) - Sets whether the frame can be resized by the user.
Frame:SetResizeBounds(minWidth, minHeight [, maxWidth, maxHeight]) - Sets the minimum and maximum size of the frame for user resizing.
Frame:SetScale(scale) -> Region:SetScale
Frame:SetShown([shown]) -> ScriptRegion:SetShown
Frame:SetToplevel(topLevel) #secureframe - Controls whether or not a frame should raise its frame level on mouse interaction.
Frame:SetUserPlaced(userPlaced) - Sets whether a frame has been moved by the user and will be saved in the layout cache.
Frame:Show() -> ScriptRegion:Show
Frame:StartMoving([alwaysStartFromMouse]) - Begins repositioning the frame via mouse movement.
Frame:StartSizing([resizePoint, alwaysStartFromMouse]) - Begins resizing the frame via mouse movement.
Frame:StopMovingOrSizing() - Stops moving or resizing the frame.
Frame:UnregisterAllEvents() - Unregisters all events from the frame.
Frame:UnregisterEvent(eventName) : registered - Unregisters an event from the frame.

Button

Button:ClearDisabledTexture()
Button:ClearHighlightTexture()
Button:ClearNormalTexture()
Button:ClearPushedTexture()
Button:Click([button, isDown]) - Performs a virtual mouse click on the button.
Button:Disable()
Button:Enable()
Button:GetButtonState() : buttonState
Button:GetDisabledFontObject() : font
Button:GetDisabledTexture() : texture
Button:GetFontString() : fontString
Button:GetHighlightFontObject() : font
Button:GetHighlightTexture() : texture - Returns the highlight texture for the button.
Button:GetMotionScriptsWhileDisabled() : motionScriptsWhileDisabled
Button:GetNormalFontObject() : font - Returns the font object for the button's normal state.
Button:GetNormalTexture() : texture
Button:GetPushedTextOffset() : offsetX, offsetY
Button:GetPushedTexture() : texture
Button:GetText() : text - Returns the text on the button.
Button:GetTextHeight() : height
Button:GetTextWidth() : width
Button:IsEnabled() : isEnabled - Returns true if the button is enabled.
Button:LockHighlight()
Button:RegisterForClicks([button1, ...]) - Registers the button widget to receive mouse clicks.
Button:RegisterForMouse(unpackedPrimitiveType, ...)
Button:SetButtonState(buttonState [, lock])
Button:SetDisabledAtlas(atlas)
Button:SetDisabledFontObject(font)
Button:SetDisabledTexture(asset)
Button:SetEnabled([enabled])
Button:SetFontString(fontString)
Button:SetFormattedText(text)
Button:SetHighlightAtlas(atlas [, blendMode])
Button:SetHighlightFontObject(font)
Button:SetHighlightLocked(locked)
Button:SetHighlightTexture(asset [, blendMode])
Button:SetMotionScriptsWhileDisabled(motionScriptsWhileDisabled)
Button:SetNormalAtlas(atlas)
Button:SetNormalFontObject(font) - Sets the font object used for the button's normal state.
Button:SetNormalTexture(asset) - Sets the normal texture for a button.
Button:SetPushedAtlas(atlas)
Button:SetPushedTextOffset(offsetX, offsetY)
Button:SetPushedTexture(asset)
Button:SetText([text]) - Sets the text of the button.
Button:UnlockHighlight()

CheckButton

CheckButton:GetChecked() : checked - Returns true if the checkbutton is checked.
CheckButton:GetCheckedTexture() : texture
CheckButton:GetDisabledCheckedTexture() : texture
CheckButton:SetChecked([checked]) - Sets whether the checkbutton is checked.
CheckButton:SetCheckedTexture(asset)
CheckButton:SetDisabledCheckedTexture(asset)

Model

Model:AdvanceTime()
Model:ClearFog()
Model:ClearModel()
Model:ClearTransform()
Model:GetCameraDistance() : distance
Model:GetCameraFacing() : radians
Model:GetCameraPosition() : positionX, positionY, positionZ
Model:GetCameraRoll() : radians
Model:GetCameraTarget() : targetX, targetY, targetZ
Model:GetDesaturation() : strength
Model:GetFacing() : facing - Returns the offset of the rotation angle.
Model:GetFogColor() : colorR, colorG, colorB, colorA
Model:GetFogFar() : fogFar
Model:GetFogNear() : fogNear
Model:GetLight() : enabled, light
Model:GetModelAlpha() : alpha
Model:GetModelDrawLayer() : layer, sublayer
Model:GetModelFileID() : modelFileID - Returns the file ID associated with the currently displayed model.
Model:GetModelScale() : scale
Model:GetPaused() : paused
Model:GetPitch() : pitch
Model:GetPosition() : positionX, positionY, positionZ
Model:GetRoll() : roll
Model:GetShadowEffect() : strength
Model:GetViewInsets() : left, right, top, bottom
Model:GetViewTranslation() : x, y
Model:GetWorldScale() : worldScale
Model:HasAttachmentPoints() : hasAttachmentPoints
Model:HasCustomCamera() : hasCustomCamera
Model:IsUsingModelCenterToTransform() : useCenter
Model:MakeCurrentCameraCustom()
Model:ReplaceIconTexture(asset)
Model:SetCamera(cameraIndex) - Selects a predefined camera.
Model:SetCameraDistance(distance)
Model:SetCameraFacing(radians)
Model:SetCameraPosition(positionX, positionY, positionZ)
Model:SetCameraRoll(radians)
Model:SetCameraTarget(targetX, targetY, targetZ)
Model:SetCustomCamera(cameraIndex)
Model:SetDesaturation(strength)
Model:SetFacing(facing) - Rotates the displayed model for the given angle in counter-clockwise direction.
Model:SetFogColor(colorR, colorG, colorB [, a]) - Sets the color used for the fogging in the model frame.
Model:SetFogFar(fogFar) - Sets the far clipping plane for fogging.
Model:SetFogNear(fogNear) - Sets the near clipping plane for fogging.
Model:SetGlow(glow)
Model:SetLight(enabled, light) - Specifies model lighting.
Model:SetModel(asset [, noMip]) - Sets the model to display a certain mesh.
Model:SetModelAlpha(alpha)
Model:SetModelDrawLayer(layer)
Model:SetModelScale(scale)
Model:SetParticlesEnabled(enabled)
Model:SetPaused(paused)
Model:SetPitch(pitch)
Model:SetPosition(positionX, positionY, positionZ) - Positions a model relative to the bottom-left corner.
Model:SetRoll(roll)
Model:SetSequence(sequence) - Sets the animation-sequence to be played.
Model:SetSequenceTime(sequence, timeOffset)
Model:SetShadowEffect(strength)
Model:SetTransform([translation, rotation, scale])
Model:SetViewInsets(left, right, top, bottom)
Model:SetViewTranslation(x, y)
Model:TransformCameraSpaceToModelSpace(cameraPosition) : modelPosition
Model:UseModelCenterToTransform(useCenter)

PlayerModel

PlayerModel is officially documented as CharacterModelBase.

CharacterModelBase:ApplySpellVisualKit(spellVisualKitID [, oneShot])
CharacterModelBase:CanSetUnit(unit)
CharacterModelBase:FreezeAnimation(anim, variation, frame) - Freezes an animation at a specific animation frame on the model.
CharacterModelBase:GetDisplayInfo() : displayID
CharacterModelBase:GetDoBlend() : doBlend
CharacterModelBase:GetKeepModelOnHide() : keepModelOnHide
CharacterModelBase:HasAnimation(anim) : hasAnimation - Returns true if the currently displayed model supports the given animation ID.
CharacterModelBase:PlayAnimKit(animKit [, loop])
CharacterModelBase:RefreshCamera()
CharacterModelBase:RefreshUnit()
CharacterModelBase:SetAnimation(anim [, variation]) - Sets the animation to be played by the model.
CharacterModelBase:SetBarberShopAlternateForm()
CharacterModelBase:SetCamDistanceScale(scale)
CharacterModelBase:SetCreature(creatureID [, displayID])
CharacterModelBase:SetDisplayInfo(displayID [, mountDisplayID])
CharacterModelBase:SetDoBlend([doBlend])
CharacterModelBase:SetItem(itemID [, appearanceModID, itemVisualID])
CharacterModelBase:SetItemAppearance(itemAppearanceID [, itemVisualID, itemSubclass])
CharacterModelBase:SetKeepModelOnHide(keepModelOnHide)
CharacterModelBase:SetPortraitZoom(zoom)
CharacterModelBase:SetRotation(radians [, animate])
CharacterModelBase:SetUnit(unit [, blend, useNativeForm]) : success - Sets the model to display the specified unit.
CharacterModelBase:StopAnimKit()
CharacterModelBase:ZeroCachedCenterXY()

DressUpModel

DressUpModel:Dress()
DressUpModel:GetAutoDress() : enabled
DressUpModel:GetItemTransmogInfo(inventorySlot) : itemTransmogInfo
DressUpModel:GetItemTransmogInfoList() : infoList
DressUpModel:GetObeyHideInTransmogFlag() : enabled
DressUpModel:GetSheathed() : sheathed
DressUpModel:GetUseTransmogChoices() : enabled
DressUpModel:GetUseTransmogSkin() : enabled
DressUpModel:IsGeoReady() : ready
DressUpModel:IsSlotAllowed(slot) : allowed
DressUpModel:IsSlotVisible(slot) : visible
DressUpModel:SetAutoDress([enabled])
DressUpModel:SetItemTransmogInfo(itemTransmogInfo [, inventorySlot, ignoreChildItems]) : result
DressUpModel:SetObeyHideInTransmogFlag([enabled])
DressUpModel:SetSheathed([sheathed, hideWeapons])
DressUpModel:SetUseTransmogChoices([enabled])
DressUpModel:SetUseTransmogSkin([enabled])
DressUpModel:TryOn(linkOrItemModifiedAppearanceID [, handSlotName, spellEnchantID]) : result - Previews an item on the model.
DressUpModel:Undress()
DressUpModel:UndressSlot(inventorySlot)

ColorSelect

ColorSelect:ClearColorWheelTexture()
ColorSelect:GetColorHSV() : hsvX, hsvY, hsvZ - Returns the HSV values of the selected color.
ColorSelect:GetColorRGB() : rgbR, rgbG, rgbB - Returns the RGB values of the selected color.
ColorSelect:GetColorValueTexture() : texture - Returns the texture for the color picker's value slider background.
ColorSelect:GetColorValueThumbTexture() : texture - Returns the texture for the color picker's value slider thumb.
ColorSelect:GetColorWheelTexture() : texture - Returns the texture for the color picker's hue/saturation wheel.
ColorSelect:GetColorWheelThumbTexture() : texture - Returns the texture for the selection indicator on the color picker's hue/saturation wheel.
ColorSelect:SetColorHSV(hsvX, hsvY, hsvZ) - Selects this HSV color in the color picker.
ColorSelect:SetColorRGB(rgbR, rgbG, rgbB) - Selects this RGB color in the color picker.
ColorSelect:SetColorValueTexture(texture) - Sets the texture used to display the color picker's value slider.
ColorSelect:SetColorValueThumbTexture(texture) - Sets the texture for the color picker's value slider thumb.
ColorSelect:SetColorWheelTexture(texture) - Sets the texture used to display the color picker's hue/saturation wheel.
ColorSelect:SetColorWheelThumbTexture(texture) - Sets the texture for the selection indicator on the color picker's hue/saturation wheel.

Cooldown

Cooldown:Clear()
Cooldown:GetCooldownDisplayDuration() : duration
Cooldown:GetCooldownDuration() : duration
Cooldown:GetCooldownTimes() : start, duration
Cooldown:GetDrawBling() : drawBling
Cooldown:GetDrawEdge() : drawEdge
Cooldown:GetDrawSwipe() : drawSwipe
Cooldown:GetEdgeScale() : edgeScale
Cooldown:GetReverse() : reverse
Cooldown:GetRotation() : rotationRadians
Cooldown:IsPaused() : isPaused
Cooldown:Pause()
Cooldown:Resume()
Cooldown:SetBlingTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetCooldown(start, duration, modRate?)
Cooldown:SetCooldownDuration(duration, modRate?)
Cooldown:SetCooldownUNIX(start, duration, modRate?)
Cooldown:SetCountdownAbbrevThreshold(seconds)
Cooldown:SetCountdownFont(fontName)
Cooldown:SetDrawBling(drawBling?)
Cooldown:SetDrawEdge(drawEdge?)
Cooldown:SetDrawSwipe(drawSwipe?)
Cooldown:SetEdgeScale(scale)
Cooldown:SetEdgeTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetHideCountdownNumbers(hideNumbers?)
Cooldown:SetReverse(reverse?)
Cooldown:SetRotation(rotationRadians)
Cooldown:SetSwipeColor(colorR, colorG, colorB, a?)
Cooldown:SetSwipeTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetTexCoordRange(low, high)
Cooldown:SetUseCircularEdge(useCircularEdge?)

EditBox

EditBox:AddHistoryLine(text)
EditBox:ClearFocus()
EditBox:ClearHighlightText()
EditBox:ClearHistory()
EditBox:Disable()
EditBox:Enable()
EditBox:GetAltArrowKeyMode() : altMode
EditBox:GetBlinkSpeed() : cursorBlinkSpeedSec
EditBox:GetCursorPosition() : cursorPosition
EditBox:GetDisplayText() : displayText
EditBox:GetFont() : name, fontHeight, flags
EditBox:GetFontObject() : font
EditBox:GetHighlightColor() : colorR, colorG, colorB, colorA
EditBox:GetHistoryLines() : numHistoryLines
EditBox:GetIndentedWordWrap() : isIndented
EditBox:GetInputLanguage() : language
EditBox:GetJustifyH() : justifyH
EditBox:GetJustifyV() : justifyV
EditBox:GetMaxBytes() : maxBytes
EditBox:GetMaxLetters() : maxLetters
EditBox:GetNumLetters() : numLetters
EditBox:GetNumber() : number?
EditBox:GetShadowColor() : colorR, colorG, colorB, colorA
EditBox:GetShadowOffset() : offsetX, offsetY
EditBox:GetSpacing() : fontHeight
EditBox:GetText() : text
EditBox:GetTextColor() : colorR, colorG, colorB, colorA
EditBox:GetTextInsets() : left, right, top, bottom
EditBox:GetUTF8CursorPosition() : cursorPosition
EditBox:GetVisibleTextByteLimit() : maxVisibleBytes
EditBox:HasFocus() : hasFocus
EditBox:HasText() : hasText
EditBox:HighlightText(start?, stop?)
EditBox:Insert(text)
EditBox:IsAutoFocus() : autoFocus
EditBox:IsCountInvisibleLetters() : countInvisibleLetters
EditBox:IsEnabled() : isEnabled
EditBox:IsInIMECompositionMode() : isInIMECompositionMode
EditBox:IsMultiLine() : multiline
EditBox:IsNumeric() : isNumeric
EditBox:IsPassword() : isPassword
EditBox:IsSecureText() : isSecure
EditBox:SetAltArrowKeyMode(altMode?)
EditBox:SetAutoFocus(autoFocus?)
EditBox:SetBlinkSpeed(cursorBlinkSpeedSec)
EditBox:SetCountInvisibleLetters(countInvisibleLetters?)
EditBox:SetCursorPosition(cursorPosition)
EditBox:SetEnabled(enabled?)
EditBox:SetFocus()
EditBox:SetFont(fontFile, height, flags) : success
EditBox:SetFontObject(font)
EditBox:SetHighlightColor(colorR, colorG, colorB, a?)
EditBox:SetHistoryLines(numHistoryLines)
EditBox:SetIndentedWordWrap(isIndented?)
EditBox:SetJustifyH(justifyH)
EditBox:SetJustifyV(justifyV)
EditBox:SetMaxBytes(maxBytes)
EditBox:SetMaxLetters(maxLetters)
EditBox:SetMultiLine(multiline?)
EditBox:SetNumber(number)
EditBox:SetNumeric(isNumeric?)
EditBox:SetPassword(isPassword?)
EditBox:SetSecureText(isSecure?)
EditBox:SetSecurityDisablePaste()
EditBox:SetSecurityDisableSetText()
EditBox:SetShadowColor(colorR, colorG, colorB, a?)
EditBox:SetShadowOffset(offsetX, offsetY)
EditBox:SetSpacing(fontHeight)
EditBox:SetText(text)
EditBox:SetTextColor(colorR, colorG, colorB, a?)
EditBox:SetTextInsets(left, right, top, bottom)
EditBox:SetVisibleTextByteLimit(maxVisibleBytes)
EditBox:ToggleInputLanguage()

GameTooltip

In patch 10.0.2 any addons that are creating GameTooltip frames should now ensure they inherit GameTooltipTemplate. This template has been updated to include the new GameTooltipDataMixin mixin, which provides automatic updates of tooltip contents from the TOOLTIP_DATA_UPDATE event as well as a subset of backwards-compatible methods for retrieving or populating tooltip contents from the new C_TooltipInfo APIs.

CreateFrame("GameTooltip") -- inherits `Frame`
GameTooltip:AddAtlas
GameTooltip:AddDoubleLine
GameTooltip:AddFontStrings
GameTooltip:AddLine
GameTooltip:AddTexture
GameTooltip:AppendText
GameTooltip:ClearLines
GameTooltip:CopyTooltip
GameTooltip:FadeOut
GameTooltip:GetAnchorType
GameTooltip:GetCustomLineSpacing
GameTooltip:GetMinimumWidth
GameTooltip:GetOwner
GameTooltip:GetPadding
GameTooltip:IsOwned
GameTooltip:NumLines
GameTooltip:SetAllowShowWithNoLines
GameTooltip:SetAnchorType
GameTooltip:SetCustomLineSpacing
GameTooltip:SetCustomWordWrapMinWidth
GameTooltip:SetFrameStack
GameTooltip:SetMinimumWidth
GameTooltip:SetObjectTooltipPosition
GameTooltip:SetOwner
GameTooltip:SetPadding
GameTooltip:SetShrinkToFitWrapped
GameTooltip:SetText
CreateFrame("GameTooltip", nil, nil, "GameTooltipTemplate") -- includes `GameTooltipDataMixin`

See also C_TooltipInfo

GameTooltip:SetAchievementByID
GameTooltip:SetAction
GameTooltip:SetArtifactItem
GameTooltip:SetArtifactPowerByID
GameTooltip:SetAzeriteEssence
GameTooltip:SetAzeriteEssenceSlot
GameTooltip:SetAzeritePower
GameTooltip:SetBackpackToken
GameTooltip:SetBagItem
GameTooltip:SetBagItemChild
GameTooltip:SetBuybackItem
GameTooltip:SetCompanionPet
GameTooltip:SetConduit
GameTooltip:SetCurrencyByID
GameTooltip:SetCurrencyToken
GameTooltip:SetEnhancedConduit
GameTooltip:SetEquipmentSet
GameTooltip:SetExistingSocketGem
GameTooltip:SetGuildBankItem
GameTooltip:SetHeirloomByItemID
GameTooltip:SetHyperlink
GameTooltip:SetInboxItem
GameTooltip:SetInstanceLockEncountersComplete
GameTooltip:SetInventoryItem
GameTooltip:SetInventoryItemByID
GameTooltip:SetItemByGUID
GameTooltip:SetItemByID
GameTooltip:SetItemInteractionItem
GameTooltip:SetItemKey
GameTooltip:SetLFGDungeonReward
GameTooltip:SetLFGDungeonShortageReward
GameTooltip:SetLootCurrency
GameTooltip:SetLootItem
GameTooltip:SetLootRollItem
GameTooltip:SetMerchantCostItem
GameTooltip:SetMerchantItem
GameTooltip:SetMinimapMouseover
GameTooltip:SetMountBySpellID
GameTooltip:SetOwnedItemByID
GameTooltip:SetPetAction
GameTooltip:SetPossession
GameTooltip:SetPvpBrawl
GameTooltip:SetPvpTalent
GameTooltip:SetQuestCurrency
GameTooltip:SetQuestItem
GameTooltip:SetQuestLogCurrency
GameTooltip:SetQuestLogItem
GameTooltip:SetQuestLogRewardSpell
GameTooltip:SetQuestLogSpecialItem
GameTooltip:SetQuestPartyProgress
GameTooltip:SetQuestRewardSpell
GameTooltip:SetRecipeRankInfo
GameTooltip:SetRecipeReagentItem
GameTooltip:SetRecipeResultItem
GameTooltip:SetRecipeResultItemForOrder
GameTooltip:SetRuneforgeResultItem
GameTooltip:SetSendMailItem
GameTooltip:SetShapeshift
GameTooltip:SetSlottedKeystone
GameTooltip:SetSocketedItem
GameTooltip:SetSocketedRelic
GameTooltip:SetSocketGem
GameTooltip:SetSpellBookItem
GameTooltip:SetSpellByID
GameTooltip:SetTalent
GameTooltip:SetTotem
GameTooltip:SetToyByItemID
GameTooltip:SetTradePlayerItem
GameTooltip:SetTradeTargetItem
GameTooltip:SetTrainerService
GameTooltip:SetTraitEntry
GameTooltip:SetTransmogrifyItem
GameTooltip:SetUnit
GameTooltip:SetUnitAura
GameTooltip:SetUnitBuff
GameTooltip:SetUnitBuffByAuraInstanceID
GameTooltip:SetUnitDebuff
GameTooltip:SetUnitDebuffByAuraInstanceID
GameTooltip:SetUpgradeItem
GameTooltip:SetVoidDepositItem
GameTooltip:SetVoidItem
GameTooltip:SetVoidWithdrawalItem
GameTooltip:SetWeeklyReward

MessageFrame

MessageFrame:AddMessage(text, colorR, colorG, colorB, a?, messageID?)
MessageFrame:Clear()
MessageFrame:GetFadeDuration() : fadeDurationSeconds
MessageFrame:GetFadePower() : fadePower
MessageFrame:GetFading() : isFading
MessageFrame:GetFont() : fontFile, height, flags
MessageFrame:GetFontObject() : font
MessageFrame:GetFontStringByID(messageID) : fontString
MessageFrame:GetIndentedWordWrap() : wordWrap
MessageFrame:GetInsertMode() : mode
MessageFrame:GetJustifyH() : justifyH
MessageFrame:GetJustifyV() : justifyV
MessageFrame:GetShadowColor() : colorR, colorG, colorB, colorA
MessageFrame:GetShadowOffset() : offsetX, offsetY
MessageFrame:GetSpacing() : spacing
MessageFrame:GetTextColor() : colorR, colorG, colorB, colorA
MessageFrame:GetTimeVisible() : timeVisibleSeconds
MessageFrame:HasMessageByID(messageID) : hasMessage
MessageFrame:ResetMessageFadeByID(messageID)
MessageFrame:SetFadeDuration(fadeDurationSeconds)
MessageFrame:SetFadePower(fadePower)
MessageFrame:SetFading(fading)
MessageFrame:SetFont(fontFile, height, flags)
MessageFrame:SetFontObject(font)
MessageFrame:SetIndentedWordWrap(wordWrap)
MessageFrame:SetInsertMode(mode)
MessageFrame:SetJustifyH(justifyH)
MessageFrame:SetJustifyV(justifyV)
MessageFrame:SetShadowColor(colorR, colorG, colorB, a?)
MessageFrame:SetShadowOffset(offsetX, offsetY)
MessageFrame:SetSpacing(spacing)
MessageFrame:SetTextColor(colorR, colorG, colorB, a?)
MessageFrame:SetTimeVisible(timeVisibleSeconds)

Minimap

unique widget

Minimap:GetPingPosition() : positionX, positionY
Minimap:GetZoom() : zoomFactor
Minimap:GetZoomLevels() : zoomLevels
Minimap:PingLocation(locationX, locationY)
Minimap:SetArchBlobInsideAlpha(alpha)
Minimap:SetArchBlobInsideTexture(asset)
Minimap:SetArchBlobOutsideAlpha(alpha)
Minimap:SetArchBlobOutsideTexture(asset)
Minimap:SetArchBlobRingAlpha(alpha)
Minimap:SetArchBlobRingScalar(scalar)
Minimap:SetArchBlobRingTexture(asset)
Minimap:SetBlipTexture(asset)
Minimap:SetCorpsePOIArrowTexture(asset)
Minimap:SetIconTexture(asset)
Minimap:SetMaskTexture(asset)
Minimap:SetPOIArrowTexture(asset)
Minimap:SetPlayerTexture(asset)
Minimap:SetQuestBlobInsideAlpha(alpha)
Minimap:SetQuestBlobInsideTexture(asset)
Minimap:SetQuestBlobOutsideAlpha(alpha)
Minimap:SetQuestBlobOutsideTexture(asset)
Minimap:SetQuestBlobRingAlpha(alpha)
Minimap:SetQuestBlobRingScalar(scalar)
Minimap:SetQuestBlobRingTexture(asset)
Minimap:SetStaticPOIArrowTexture(asset)
Minimap:SetTaskBlobInsideAlpha(alpha)
Minimap:SetTaskBlobInsideTexture(asset)
Minimap:SetTaskBlobOutsideAlpha(alpha)
Minimap:SetTaskBlobOutsideTexture(asset)
Minimap:SetTaskBlobRingAlpha(alpha)
Minimap:SetTaskBlobRingScalar(scalar)
Minimap:SetTaskBlobRingTexture(asset)
Minimap:SetZoom(zoomFactor)
Minimap:UpdateBlips()

MovieFrame

MovieFrame:EnableSubtitles(enable)
MovieFrame:StartMovie(movieID, looping?) : success, returnCode
MovieFrame:StartMovieByName(movieName, looping?, resolution?) : success, returnCode
MovieFrame:StopMovie()

ScrollFrame

ScrollFrame:GetHorizontalScroll() : offset
ScrollFrame:GetHorizontalScrollRange() : range
ScrollFrame:GetScrollChild() : scrollChild
ScrollFrame:GetVerticalScroll() : offset
ScrollFrame:GetVerticalScrollRange() : range
ScrollFrame:SetHorizontalScroll(offset)
ScrollFrame:SetScrollChild(scrollChild)
ScrollFrame:SetVerticalScroll(offset)
ScrollFrame:UpdateScrollChildRect()

SimpleHTML

SimpleHTML:GetContentHeight() : height
SimpleHTML:GetFont(textType) : fontFile, height, flags
SimpleHTML:GetFontObject(textType) : font
SimpleHTML:GetHyperlinkFormat() : format
SimpleHTML:GetIndentedWordWrap(textType) : wordWrap
SimpleHTML:GetJustifyH(textType) : justifyH
SimpleHTML:GetJustifyV(textType) : justifyV
SimpleHTML:GetShadowColor(textType) : colorR, colorG, colorB, colorA
SimpleHTML:GetShadowOffset(textType) : offsetX, offsetY
SimpleHTML:GetSpacing(textType) : spacing
SimpleHTML:GetTextColor(textType) : colorR, colorG, colorB, colorA
SimpleHTML:GetTextData() : content
SimpleHTML:SetFont(textType, fontFile, height, flags)
SimpleHTML:SetFontObject(textType, font)
SimpleHTML:SetHyperlinkFormat(format)
SimpleHTML:SetIndentedWordWrap(textType, wordWrap)
SimpleHTML:SetJustifyH(textType, justifyH)
SimpleHTML:SetJustifyV(textType, justifyV)
SimpleHTML:SetShadowColor(textType, colorR, colorG, colorB, a?)
SimpleHTML:SetShadowOffset(textType, offsetX, offsetY)
SimpleHTML:SetSpacing(textType, spacing)
SimpleHTML:SetText(text, ignoreMarkup?)
SimpleHTML:SetTextColor(textType, colorR, colorG, colorB, a?)

Slider

Slider:Disable()
Slider:Enable()
Slider:GetMinMaxValues() : minValue, maxValue
Slider:GetObeyStepOnDrag() : isObeyStepOnDrag
Slider:GetOrientation() : orientation
Slider:GetStepsPerPage() : stepsPerPage
Slider:GetThumbTexture() : texture
Slider:GetValue() : value
Slider:GetValueStep() : valueStep
Slider:IsDraggingThumb() : isDraggingThumb
Slider:IsEnabled() : enabled
Slider:SetEnabled(enabled)
Slider:SetMinMaxValues(minValue, maxValue)
Slider:SetObeyStepOnDrag(obeyStepOnDrag)
Slider:SetOrientation(orientation)
Slider:SetStepsPerPage(stepsPerPage)
Slider:SetThumbTexture(asset)
Slider:SetValue(value, treatAsMouseEvent?)
Slider:SetValueStep(valueStep)

StatusBar

StatusBar:GetFillStyle() : fillStyle
StatusBar:GetMinMaxValues() : minValue, maxValue
StatusBar:GetOrientation() : orientation
StatusBar:GetReverseFill() : isReverseFill
StatusBar:GetRotatesTexture() : rotatesTexture
StatusBar:GetStatusBarColor() : colorR, colorG, colorB, colorA
StatusBar:GetStatusBarDesaturation() : desaturation
StatusBar:GetStatusBarTexture() : texture
StatusBar:GetValue() : value
StatusBar:IsStatusBarDesaturated() : desaturated
StatusBar:SetColorFill(colorR, colorG, colorB, a?)
StatusBar:SetFillStyle(fillStyle)
StatusBar:SetMinMaxValues(minValue, maxValue)
StatusBar:SetOrientation(orientation)
StatusBar:SetReverseFill(isReverseFill)
StatusBar:SetRotatesTexture(rotatesTexture)
StatusBar:SetStatusBarColor(colorR, colorG, colorB, a?)
StatusBar:SetStatusBarDesaturated(desaturated?)
StatusBar:SetStatusBarDesaturation(desaturation)
StatusBar:SetStatusBarTexture(asset)
StatusBar:SetValue(value)

Undocumented

These widget types have yet to be documented on the wiki.

CinematicModel

CinematicModel was added in Patch 6.0.2 and has all the methods from PlayerModel, plus the following:

CinematicModel:EquipItem(itemID)
CinematicModel:InitializeCamera()
CinematicModel:InitializePanCamera()
CinematicModel:SetAnimOffset(offset)
CinematicModel:SetCreatureData(creatureID)
CinematicModel:SetFacingLeft(isFacingLeft)
CinematicModel:SetFadeTimes(fadeIn, fadeOut)
CinematicModel:SetHeightFactor(factor)
CinematicModel:SetJumpInfo(length, height)
CinematicModel:SetPanDistance(scale)
CinematicModel:SetSpellVisualKit(kitID)
CinematicModel:SetTargetDistance(scale)
CinematicModel:StartPan(panType, timeInSeconds[, doFade, visualKitID])
CinematicModel:StopPan()
CinematicModel:UnequipItems()

TabardModel

TabardModel has all the methods from PlayerModel, plus the following:

TabardModel:CanSaveTabardNow() - Indicate if the tabard can be saved.
TabardModel:CycleVariation(variationIndex, delta)
TabardModel:GetLowerBackgroundFileName()
TabardModel:GetLowerEmblemFile()
TabardModel:GetLowerEmblemTexture(textureName)
TabardModel:GetUpperBackgroundFileName()
TabardModel:GetUpperEmblemFile()
TabardModel:GetUpperEmblemTexture(textureName)
TabardModel:InitializeTabardColors()
TabardModel:Save() - Save the tabard.

ModelScene

ModelScene has all the methods from Frame, plus the following:

ModelScene:ClearFog()
ModelScene:CreateActor([name, template])
ModelScene:GetActorAtIndex(actorIndex)
ModelScene:GetCameraFarClip()
ModelScene:GetCameraFieldOfView()
ModelScene:GetCameraForward()
ModelScene:GetCameraNearClip()
ModelScene:GetCameraPosition()
ModelScene:GetCameraRight()
ModelScene:GetCameraUp()
ModelScene:GetDrawLayer()
ModelScene:GetFogColor()
ModelScene:GetFogFar()
ModelScene:GetFogNear()
ModelScene:GetItemTransmogInfo(slotID)
ModelScene:GetItemTransmogInfoList()
ModelScene:GetLightAmbientColor()
ModelScene:GetLightDiffuseColor()
ModelScene:GetLightDirection()
ModelScene:GetLightPosition()
ModelScene:GetLightType()
ModelScene:GetNumActors()
ModelScene:GetViewInsets()
ModelScene:GetViewTranslation()
ModelScene:IsLightVisible()
ModelScene:Project3DPointTo2D(x, y, z)
ModelScene:SetCameraFarClip(value)
ModelScene:SetCameraFieldOfView(radians)
ModelScene:SetCameraNearClip(value)
ModelScene:SetCameraOrientationByAxisVectors(forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ) each vector must be orthonormal
ModelScene:SetCameraOrientationByYawPitchRoll(yaw, pitch, roll)
ModelScene:SetCameraPosition(x, y, z)
ModelScene:SetDrawLayer(layer)
ModelScene:SetFogColor(r, g, b)
ModelScene:SetFogFar(value)
ModelScene:SetFogNear(value)
ModelScene:SetItemTransmogInfo(itemTransmogInfo [, weaponSlotID])
ModelScene:SetLightAmbientColor(r, g, b)
ModelScene:SetLightDiffuseColor(r, g, b)
ModelScene:SetLightDirection(x, y, z)
ModelScene:SetLightPosition(x, y, z)
ModelScene:SetLightType(LE_MODEL_LIGHT_TYPE)
ModelScene:SetLightVisible()
ModelScene:SetPaused(paused, [affectsGlobalPause])
ModelScene:SetViewInsets(l, r, t, b)
ModelScene:SetViewTranslation(x, y)
ModelScene:TakeActor()

ModelSceneActor

ModelSceneActor can be created from ModelScene:CreateActor. It has the following methods:

ModelSceneActor:AttachToMount()
ModelSceneActor:CalculateMountScale()
ModelSceneActor:ClearModel()
ModelSceneActor:Dress()
ModelSceneActor:GetActiveBoundingBox()
ModelSceneActor:GetAlpha()
ModelSceneActor:GetAnimation()
ModelSceneActor:GetAnimationBlendOperation()
ModelSceneActor:GetAnimationVariation()
ModelSceneActor:GetAutoDress()
ModelSceneActor:GetDebugName()
ModelSceneActor:GetDesaturation()
ModelSceneActor:GetMaxBoundingBox()
ModelSceneActor:GetModelFileID()
ModelSceneActor:GetModelPath()
ModelSceneActor:GetModelUnitGUID()
ModelSceneActor:GetObeyHideInTransmogFlag()
ModelSceneActor:GetParent()
ModelSceneActor:GetParticleOverrideScale()
ModelSceneActor:GetPaused()
ModelSceneActor:GetPitch()
ModelSceneActor:GetPosition()
ModelSceneActor:GetRoll()
ModelSceneActor:GetScale()
ModelSceneActor:GetSheathed()
ModelSceneActor:GetSpellVisualKit()
ModelSceneActor:GetUseTransmogChoices()
ModelSceneActor:GetUseTransmogSkin()
ModelSceneActor:GetYaw()
ModelSceneActor:Hide()
ModelSceneActor:IsForbidden()
ModelSceneActor:IsLoaded()
ModelSceneActor:IsShown()
ModelSceneActor:IsUsingCenterForOrigin()
ModelSceneActor:IsVisible()
ModelSceneActor:PlayAnimationKit(id [, loop])
ModelSceneActor:ReleaseFrontEndCharacterDisplays()
ModelSceneActor:SetAlpha(alpha)
ModelSceneActor:SetAnimation(animation [, variation, animSpeed, timeOffsetSecs])
ModelSceneActor:SetAnimationBlendOperation(LE_MODEL_BLEND_OPERATION)
ModelSceneActor:SetAutoDress(true/false)
ModelSceneActor:SetDesaturation(strength)
ModelSceneActor:SetForbidden() - Protected
ModelSceneActor:SetFrontEndLobbyModelFromDefaultCharacterDisplay()
ModelSceneActor:SetModelByCreatureDisplayID(creatureDisplayID)
ModelSceneActor:SetModelByFileID(fileID [, enableMips])
ModelSceneActor:SetModelByPath(filePath [, enableMips])
ModelSceneActor:SetModelByUnit("unit" [,sheatheWeapons, autoDress])
ModelSceneActor:SetObeyHideInTransmogFlag(bool)
ModelSceneActor:SetParticleOverrideScale()
ModelSceneActor:SetPaused(paused [, affectsGlobalPause = true])
ModelSceneActor:SetPitch(pitch)
ModelSceneActor:SetPlayerModelFromGlues()
ModelSceneActor:SetPosition(x, y, z)
ModelSceneActor:SetRoll(roll)
ModelSceneActor:SetScale(scale)
ModelSceneActor:SetSheathed(true/false)
ModelSceneActor:SetShown(true/false)
ModelSceneActor:SetSpellVisualKit()
ModelSceneActor:SetUseCenterForOrigin()
ModelSceneActor:SetUseTransmogChoices(bool)
ModelSceneActor:SetUseTransmogSkin(true/false)
ModelSceneActor:SetYaw(facing)
ModelSceneActor:Show()
ModelSceneActor:StopAnimationKit()
ModelSceneActor:TryOn()
ModelSceneActor:Undress()
ModelSceneActor:UndressSlot(slotIndex)

FogOfWarFrame

FogOfWarFrame has all the methods from Frame, plus the following:

FogOfWarFrame:GetFogOfWarBackgroundAtlas()
FogOfWarFrame:GetFogOfWarBackgroundTexture()
FogOfWarFrame:GetFogOfWarMaskAtlas()
FogOfWarFrame:GetFogOfWarMaskTexture()
FogOfWarFrame:GetMaskScalar()
FogOfWarFrame:GetUiMapID()
FogOfWarFrame:SetFogOfWarBackgroundAtlas(atlasName)
FogOfWarFrame:SetFogOfWarBackgroundTexture(textureName or FileDataID, [horizontalTile, verticalTile])
FogOfWarFrame:SetFogOfWarMaskAtlas(atlasName)
FogOfWarFrame:SetFogOfWarMaskTexture(textureName)
FogOfWarFrame:SetMaskScalar(mapID)
FogOfWarFrame:SetUiMapID()

UnitPositionFrame

UnitPositionFrame has all the methods from Frame, plus the following:

UnitPositionFrame:AddUnit(unit, texture, width, height, r, g, b, a, subLayer, showFacing)
UnitPositionFrame:AddUnitAtlas(unit, texture, width, height, r, g, b, a, subLayer)
UnitPositionFrame:AddUnitFileID(unit, fileID, width, height, r, g, b, a, subLayer, showFacing)
UnitPositionFrame:ClearUnits()
UnitPositionFrame:FinalizeUnits()
UnitPositionFrame:GetMouseOverUnits()
UnitPositionFrame:GetPlayerPingScale()
UnitPositionFrame:GetUiMapID()
UnitPositionFrame:SetPlayerPingScale(scale)
UnitPositionFrame:SetPlayerPingTexture(textureIndex, textureName or fileDataID, [width, height])
UnitPositionFrame:SetUiMapID(mapID)
UnitPositionFrame:SetUnitColor(unit, r, g, b, a)
UnitPositionFrame:StartPlayerPing()
UnitPositionFrame:StopPlayerPing()