AddOn Studio

WoW:API GetThreatStatusColor: Difference between revisions

WoW Talk

WoW:API GetThreatStatusColor (source)

Revision as of 09:11, 5 March 2009

405 bytes removed ,  5 March 2009
Cleanup, add details on return values for each threat level
(New page: {{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> Returns RGB color values relating to a threat status. New in [Patc...)
 
(Cleanup, add details on return values for each threat level)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Returns RGB color values relating to a threat status.  New in [[Patch 3.0]].
Returns RGB color values relating to a threat status.  New in [[Patch 3.0]].


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  r, g, b = GetThreatStatusColor([[API TYPE ThreatStatus|status]])
  r, g, b = GetThreatStatusColor([[API TYPE ThreatStatus|status]])


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


== Parameters ==
==Returns==
=== Arguments ===
:;r : number - a value between 0 and 1 for the red content of the color
<!-- List each argument, together with its type -->
:;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
:;status : Integer - the [[API TYPE ThreatStatus|threat status]] value to get colors for.
 
=== Returns ===
<!-- List each return value, together with its type -->
:;r : Number - Returns a value between 0 and 1 for the red content of the color.
:;g : Number - Returns a value between 0 and 1 for the green content of the color.
:;b : Number - Returns a value between 0 and 1 for the blue content of the color.


== Example ==
==Example==
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
  local status, statustxts = UnitThreatSituation("player", "target"), { "low on threat",  "overnuking", "losing threat", "tanking securely" }
<!-- begin code -->
  local r, g, b = GetThreatStatusColor(status)
  local status, statustxts = UnitThreatSituation("player", "target"), {"low on threat",  "overnuking", "losing threat", "tanking securely"};
  print("You are " .. statustxts[status + 1] .. ".", r, g, b)
  local r, g, b = GetThreatStatusColor(status);
===Result===
  ChatFrame1:AddMessage('You are ' .. statustxts[status+1] .. '.', r, g, b);
Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g.
<!-- end code -->
<font color="AFAFAF">You are low on threat.</font>
<font color="FFFF77">You are overnuking.</font>
<font color="FF9900">You are losing threat.</font>
<font color="FF0000">You are tanking securely.</font>


====Result====
==Notes==
<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
As of [[Patch 3.0.9]], the following r, g, b values are returned for each threat level:
:Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g.
:;0 : 0.69, 0.69, 0.69
<!-- begin code -->
:;1 : 1, 1, 0.47
<font color="yellow">You are overnuking.</font>
:;2 : 1, 0.6, 0
<!-- end code -->
:;3 : 1, 0, 0


== See also ==
==See also==


[[API UnitThreatSituation]] | [[API UnitDetailedThreatSituation]]
[[API UnitThreatSituation]] | [[API UnitDetailedThreatSituation]]
Anonymous user
Retrieved from "https://addonstudio.org/wiki/Special:MobileDiff/4424"