WoW:API GetItemQualityColor: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(There is no '#' in GetItemQualityColor() output)
(→‎Parameters: boilerplate)
Line 4: Line 4:


  r, g, b, hex = GetItemQualityColor(quality)
  r, g, b, hex = GetItemQualityColor(quality)
== Parameters ==
== Arguments ==
=== Arguments ===
;quality : Number - The numeric ID of the quality from 0 (Poor) to 7 (Heirloom).
:quality


:;quality : Integer - The numeric ID of the quality from 0 (Poor) to 7 (Heirloom).
== Returns ==
 
;r : Number - The Red component of the color (0 to 1, inclusive).
=== Returns ===
;g : Number - The Green component of the color (0 to 1, inclusive).
:r, g, b, hex
;b : Number - The Blue component of the color (0 to 1, inclusive).
 
;hex : String - The [[UI escape sequences|UI escape sequence]] for this color.
:;r : Float - The Red component of the color
:;g : Float - The Green component of the color
:;b : Float - The Blue component of the color
:;hex : String - Contains the hexidecimal representation of the string, as well as "|c" in the beginning.


== Example ==
== Example ==

Revision as of 00:06, 29 April 2010

WoW API < GetItemQualityColor

Returns RGB color codes for an item quality.

r, g, b, hex = GetItemQualityColor(quality)

Arguments

quality
Number - The numeric ID of the quality from 0 (Poor) to 7 (Heirloom).

Returns

r
Number - The Red component of the color (0 to 1, inclusive).
g
Number - The Green component of the color (0 to 1, inclusive).
b
Number - The Blue component of the color (0 to 1, inclusive).
hex
String - The UI escape sequence for this color.

Example

for i = 0, 7 do
  local r, g, b, hex = GetItemQualityColor(i);
  print(i, hex, getglobal("ITEM_QUALITY" .. i .. "_DESC"), string.sub(hex,5));
end

Result

Will print all qualities, in their individual colors (example result from version 3.1.1).

Template:Example/Begin 0 Poor 9d9d9d
1 Common ffffff
2 Uncommon 1eff00
3 Rare 0070dd
4 Epic a335ee
5 Legendary ff8000
6 Artifact e6cc80
7 Heirloom e6cc80 Template:Example/End

Details

GetItemQualityColor() was added in 1.9.1
If an invalid quality index is specified, GetItemQualityColor() returns white (same as index 1):
r = 1
g = 1
b = 1
hex = |cffffffff
Quality #7 was added in version 3.0 for heirloom items.
ITEM_QUALITY7_DESC is now defined as of 3.1.1.

See also