WoW:API GetThreatStatusColor: Difference between revisions

m
no edit summary
(slight formatting updates)
mNo edit summary
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi|toc=0}}
Returns RGB color values corresponding to a threat status returned by [[API UnitThreatSituation|UnitThreatSituation]].  Added in [[Patch 3.0]].
Returns RGB color value corresponding to a threat status returned by [[API UnitThreatSituation|UnitThreatSituation]].  Added in Patch 3.0.
  r, g, b = GetThreatStatusColor(statusIndex)
  r, g, b = GetThreatStatusColor(statusIndex)


==Arguments==
== Parameters ==
;status : integer - the [[API TYPE ThreatStatus|threat status]] value to get colors for
=== Arguments ===
* status (integer) - the [[API TYPE ThreatStatus|ThreatStatus]] value to get colors for


==Returns==
=== Returns ===
;r : number - a value between 0 and 1 for the red content of the color
* r (number) - a value between 0 and 1 for the red content of the color
;g : number - a value between 0 and 1 for the green content of the color
* g (number) - a value between 0 and 1 for the green content of the color
;b : number - a value between 0 and 1 for the blue content of the color
* b (number) - a value between 0 and 1 for the blue content of the color


==Example==
=== Result ===
local status, statustxts = UnitThreatSituation("player", "target"), { "low on threat",  "overnuking", "losing threat", "tanking securely" }
local r, g, b = GetThreatStatusColor(status)
print("You are " .. statustxts[status + 1] .. ".", r, g, b)
===Result===
Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g.
Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g.
  <font color="AFAFAF">You are low on threat.</font>
  <font color="AFAFAF">You are low on threat.</font>
Line 22: Line 19:
  <font color="FF0000">You are tanking securely.</font>
  <font color="FF0000">You are tanking securely.</font>


==Notes==
== Examples ==
As of [[Patch 3.0.9]], the following r, g, b values are returned for each threat level:
local status, statustxts = UnitThreatSituation("player", "target"), { "low on threat",  "overnuking", "losing threat", "tanking securely" }
: '''0''': <span style="color: #AFAFAF">0.69, 0.69, 0.69</span>
local r, g, b = GetThreatStatusColor(status)
: '''1''': <span style="color: #FFFF77">1, 1, 0.47</span>
print("You are " .. statustxts[status + 1] .. ".", r, g, b)
: '''2''': <span style="color: #FF9900">1, 0.6, 0</span>
 
: '''3''': <span style="color: #FF0000">1, 0, 0</span>
== Notes ==
As of Patch 3.0.9, the following r, g, b values are returned for each threat level:
* 0: <span style="color: #AFAFAF">0.69, 0.69, 0.69</span>
* 1: <span style="color: #FFFF77">1, 1, 0.47</span>
* 2: <span style="color: #FF9900">1, 0.6, 0</span>
* 3: <span style="color: #FF0000">1, 0, 0</span>


==See also==
== See also ==
* [[API UnitThreatSituation]]  
* [[API UnitThreatSituation]]  
* [[API UnitDetailedThreatSituation]]
* [[API UnitDetailedThreatSituation]]
[[Category:Interface customization]]
[[Category:Interface customization]]
[[Category:World of Warcraft API]]
[[Category:World of Warcraft API]]