WoW:API Frame GetAttribute: Difference between revisions

Revision as of 01:44, 18 July 2009

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns the value of a specific attribute (or an attribute matching the prefix/suffix arguments).

value = frame:GetAttribute(name);
value = frame:GetAttribute(prefix, name, suffix);

prefix: String - modifier prefix string: a concatenation of alt-, ctrl-, and shift-, whichever apply, in that order.
name: 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.

value: Mixed - the value of the matching attribute; nil if no attribute matched the arguments.

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

@@ Line 6: / Line 6: @@
 ==Arguments==
 ; prefix : String - modifier prefix string: a concatenation of alt-, ctrl-, and shift-, whichever apply, in that order.
-; name : Attribute name. If passes as the only attribute, this may be a fully qualified value; otherwise, it is the unmodified name of the attribute being retrieved.
+; name : 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.