WoW:API GetThreatStatusColor - Revision history

Move page script: Move page script moved page API GetThreatStatusColor to WoW:API GetThreatStatusColor without leaving a redirect

2023-08-15T04:46:30Z

Move page script moved page API GetThreatStatusColor to API GetThreatStatusColor without leaving a redirect

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

Bear at 03:45, 4 June 2020

2020-06-04T03:45:21Z

← Older revision		Revision as of 03:45, 4 June 2020
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]]

WoWWiki>Starlightblunder: slight formatting updates

2009-03-29T22:00:32Z

slight formatting updates

← Older revision		Revision as of 22:00, 29 March 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
			Returns RGB color values corresponding to a threat status returned by [[API UnitThreatSituation\|UnitThreatSituation]]. Added in [[Patch 3.0]].
	Returns RGB color values ~~relating~~ to a threat status. ~~New~~ in [[Patch 3.0]].		r, g, b = GetThreatStatusColor(statusIndex)

	r, g, b = GetThreatStatusColor(~~[[API TYPE ThreatStatus\|status]]~~)

	==Arguments==		==Arguments==
	:;status : integer - the [[API TYPE ThreatStatus\|threat status]] value to get colors for		;status : integer - the [[API TYPE ThreatStatus\|threat status]] 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==		==Example==
Line 26:		Line 24:
	==Notes==		==Notes==
	As of [[Patch 3.0.9]], the following r, g, b values are returned for each threat level:		As of [[Patch 3.0.9]], the following r, g, b values are returned for each threat level:
	:;0 : 0.69, 0.69, 0.69		: '''0''': <span style="color: #AFAFAF">0.69, 0.69, 0.69</span>
	:;1 : 1, 1, 0.47		: '''1''': <span style="color: #FFFF77">1, 1, 0.47</span>
	:;2 : 1, 0.6, 0		: '''2''': <span style="color: #FF9900">1, 0.6, 0</span>
	:;3 : 1, 0, 0		: '''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]]

WoWWiki>Phanx: Cleanup, add details on return values for each threat level

2009-03-05T09:11:14Z

Cleanup, add details on return values for each threat level

← Older revision		Revision as of 09:11, 5 March 2009
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]]

WoWWiki>Scudmarx: New page: {{wowapi}} NOTOC Returns RGB color values relating to a threat status. New in [Patc...

2008-10-12T21:40:51Z

New page: {{wowapi}} __NOTOC__  Returns RGB color values relating to a threat status. New in [Patc...

New page

{{wowapi}} __NOTOC__


Returns RGB color values relating to a threat status. New in [[Patch 3.0]].


r, g, b = GetThreatStatusColor([[API TYPE ThreatStatus|status]])

== Parameters ==
=== Arguments ===


:;status : Integer - the [[API TYPE ThreatStatus|threat status]] value to get colors for.

=== Returns ===

:;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 ==


local status, statustxts = UnitThreatSituation("player", "target"), {"low on threat", "overnuking", "losing threat", "tanking securely"};
local r, g, b = GetThreatStatusColor(status);
ChatFrame1:AddMessage('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.

<font color="yellow">You are overnuking.</font>


== See also ==

[[API UnitThreatSituation]] | [[API UnitDetailedThreatSituation]]

[[Category:Interface customization]]
[[Category:World of Warcraft API]]

WoW:API GetThreatStatusColor - Revision history

Move page script: Move page script moved page API GetThreatStatusColor to WoW:API GetThreatStatusColor without leaving a redirect

Bear at 03:45, 4 June 2020

WoWWiki>Starlightblunder: slight formatting updates

WoWWiki>Phanx: Cleanup, add details on return values for each threat level

WoWWiki>Scudmarx: New page: {{wowapi}} __NOTOC__ Returns RGB color values relating to a threat status. New in [Patc...

WoWWiki>Scudmarx: New page: {{wowapi}} NOTOC Returns RGB color values relating to a threat status. New in [Patc...