Frame:GetAttribute

From Warcraft Wiki
Jump to navigation Jump to search
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png  Wowprogramming.png Frame:GetAttribute
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png  Wowprogramming.png Frame:SetAttribute
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png Frame:SetAttributeNoHandler
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png  Wowprogramming.png Frame:CanChangeAttribute
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png Frame:ExecuteAttribute
GitHub Octocat.png  Dragonflight-Icon-Inline.png  BTNTemp.png OnAttributeChanged

Returns the value of a secure frame attribute.

value = Frame:GetAttribute(attributeName)
      = Frame:GetAttribute(prefix, attributeName, suffix)

Arguments

prefix
string - modifier prefix string: a concatenation of alt-, ctrl-, and shift-, whichever apply, in that order.
attributeName
string - Attribute name. If passed as the only argument, this may be a fully qualified value; otherwise, it is the unmodified name of the attribute being retrieved.
suffix
string - Button suffix string: either a numeric string or a dash followed by an arbitrary button name.

Returns

value
any? - The value of the matching attribute; nil if no attribute matched the arguments.

Details

Matching order

When invoked with three arguments, this function attempts to return attributes in the following order (returning the first attribute that exists):

  1. prefix .. name .. suffix
  2. "*" .. name .. suffix
  3. prefix .. name .. "*"
  4. "*" .. name .. "*"
  5. name