WoW:API GetItemQualityColor: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Linked to related articles)
Line 1: Line 1:
{{wowapi}}__NOTOC__
{{wowapi}}__NOTOC__


Returns RGB color codes for an item quality.
Returns RGB color codes for an item [[quality]].


  r, g, b, hex = GetItemQualityColor(quality)
  r, g, b, hex = GetItemQualityColor(quality)
Line 19: Line 19:


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


====Result====
=== Result ===
: Will print all qualities, in their individual colors.
: Will print all qualities, in their individual colors (example result from version 3.0.3).
{{Example/Begin}}
0 <span style="color: #9d9d9d">Poor #9d9d9d</span><br />
1 <span style="color: #ffffff">Common #ffffff</span><br />
2 <span style="color: #1eff00">Uncommon #1eff00</span><br />
3 <span style="color: #0070dd">Rare #0070dd</span><br />
4 <span style="color: #a335ee">Epic #a335ee</span><br />
5 <span style="color: #ff8000">Legendary #ff8000</span><br />
6 <span style="color: #e6cc80">Artifact #e6cc80</span><br />
7 <span style="color: #e6cc80">nil #e6cc80</span>
{{Example/End}}


==Details==
==Details==
Line 31: Line 41:


:If an invalid quality index is specified, GetItemQualityColor() returns white (same as index 1):
:If an invalid quality index is specified, GetItemQualityColor() returns white (same as index 1):
:r = 1
::r = 1
:g = 1
::g = 1
:b = 1
::b = 1
:hex = |cffffffff
::hex = |cffffffff
 
:Quality #7 was added in version 3.0 for heirloom items, although ITEM_QUALITY7_DESC has not yet been defined.
 
== See also ==
* [[API ITEM_QUALITY_COLORS]]
* [[API TYPE Quality]]

Revision as of 23:24, 7 January 2009

WoW API < GetItemQualityColor

Returns RGB color codes for an item quality.

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

Parameters

Arguments

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

Returns

r, g, b, hex
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

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.0.3).

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 nil #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, although ITEM_QUALITY7_DESC has not yet been defined.

See also