WoW:API UnitThreatSituation - Revision history

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

2023-08-15T04:47:50Z

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

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Starlightblunder: fix cats

2010-03-25T01:03:34Z

fix cats

← Older revision		Revision as of 01:03, 25 March 2010
Line 41:		Line 41:
	* [[API UnitDetailedThreatSituation]]		* [[API UnitDetailedThreatSituation]]
	* [[API GetThreatStatusColor]]		* [[API GetThreatStatusColor]]
	~~[[Category:Interface customization]]~~
	~~[[Category:World of Warcraft API]]~~

WoWWiki>Makaijin: Some better clarification on "without other unit" description.

2010-01-15T05:33:25Z

Some better clarification on "without other unit" description.

← Older revision		Revision as of 05:33, 15 January 2010
Line 14:		Line 14:
	:;With otherunit specified		:;With otherunit specified

	::* nil = unit is not on otherunit's threat table		::* nil = unit is not on otherunit's threat table.
	::* 0 = not tanking, lower threat than tank.		::* 0 = not tanking, lower threat than tank.
	::* 1 = not tanking, higher threat than tank		::* 1 = not tanking, higher threat than tank.
	::* 2 = insecurely tanking.		::* 2 = insecurely tanking, another unit have higher threat but not tanking.
	::* 3 = securely tanking.		::* 3 = securely tanking, highest threat

	:;Without otherunit specified ~~("Overnuking" affects 1 & 2 as you have higher threat but not tanking)~~		:;Without otherunit specified

	::* nil = ~~Unit~~ is not on threat table		::* nil = unit is not on any other unit's threat table.
	::* 0 = ~~Not~~ tanking ~~something~~		::* 0 = not tanking anything.
	::* 1 = ~~Temporarily lost aggro (e~~.~~g. [[Mocking Blow]], [[Challenging Shout]], [[Righteous Defense]])~~		::* 1 = not tanking anything, but have higher threat than tank on at least one unit.
	::* 2 = ~~Temporarily have aggro (e~~.~~g. [[Mocking Blow]], [[Challenging Shout]], [[Righteous Defense]])~~		::* 2 = insecurely tanking at least one unit, but not securely tanking anything.
	::* 3 = ~~Tanking something~~		::* 3 = securely tanking at least one unit.

	== Example ==		== Example ==

WoWWiki>Yours truly: Fixed typo's

2009-10-15T10:03:31Z

Fixed typo's

← Older revision		Revision as of 10:03, 15 October 2009
Line 9:		Line 9:

	=== Returns ===		=== Returns ===
	;status : integer - returns the threat status for the unit ~~on the second unit~~:
	:* nil = unit is not on otherunit's threat table		;status : integer - returns the threat status for the unit:
	:* 0 = not tanking, lower threat than tank. ~~If otherunit is not specified this denotes "not tanking anything"~~
	:* 1 = not tanking, higher threat than tank		:;With otherunit specified
	:* 2 = insecurely tanking.
	:* 3 = securely tanking. If otherunit is not ~~specified~~, ~~this denotes "tanking~~ something"		::* nil = unit is not on otherunit's threat table
			::* 0 = not tanking, lower threat than tank.
			::* 1 = not tanking, higher threat than tank
			::* 2 = insecurely tanking.
			::* 3 = securely tanking.

			:;Without otherunit specified ("Overnuking" affects 1 & 2 as you have higher threat but not tanking)

			::* nil = Unit is not on threat table
			::* 0 = Not tanking something
			::* 1 = Temporarily lost aggro (e.g. [[Mocking Blow]], [[Challenging Shout]], [[Righteous Defense]])
			::* 2 = Temporarily have aggro (e.g. [[Mocking Blow]], [[Challenging Shout]], [[Righteous Defense]])
			::* 3 = Tanking something

	== Example ==		== Example ==
Line 25:		Line 37:
	== Details ==		== Details ==
	* This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.		* This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.
	* If the second argument is omitted, this function will return 3 if the unit has aggro on something, or 0 otherwise. ''Needs confirmation/additional testing.''

	== See also ==		== See also ==
	* [[API UnitDetailedThreatSituation]]		* [[API UnitDetailedThreatSituation]]
	* [[API GetThreatStatusColor]]		* [[API GetThreatStatusColor]]

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

WoWWiki>Starlightblunder: slight formatting changes

2009-03-29T22:04:27Z

slight formatting changes

← Older revision		Revision as of 22:04, 29 March 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

	Returns brief information about a unit's standing in another unit's threat table. Added in [[Patch 3.0]].		Returns brief information about a unit's standing in another unit's threat table. Added in [[Patch 3.0]].

	status = UnitThreatSituation("unit"[, "otherunit"])		status = UnitThreatSituation("unit"[, "otherunit"])

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:;unit : string - the [[API TYPE UnitId\|unit token]] of the unit whose threat to query (e.g. "player", "party2", "pet", etc.)		;unit : string - the [[API TYPE UnitId\|unit token]] of the unit whose threat to query (e.g. "player", "party2", "pet", etc.)
	:;otherunit : string ''(optional)'' - the [[API TYPE UnitId\|unit token]] of the unit whose threat table to query (e.g. "target", "pettarget" etc.)		;otherunit : string ''(optional)'' - the [[API TYPE UnitId\|unit token]] of the unit whose threat table to query (e.g. "target", "pettarget" etc.)

	=== Returns ===		=== Returns ===
	:;status : integer - returns the ~~[[API TYPE ThreatStatus\|~~threat status]] for the unit on the second unit~~, or~~ nil ~~if the~~ unit is not on ~~the second unit~~'s threat table, ~~or a [[API TYPE ThreatStatus\|~~threat ~~status]] or 0 or 3 if the second unit~~ is not specified ~~depending on whether the unit has aggro on~~ anything or not.		;status : integer - returns the threat status for the unit on the second unit:
			:* nil = unit is not on otherunit's threat table
			:* 0 = not tanking, lower threat than tank. If otherunit is not specified this denotes "not tanking anything"
			:* 1 = not tanking, higher threat than tank
			:* 2 = insecurely tanking.
			:* 3 = securely tanking. If otherunit is not specified, this denotes "tanking something"

	== Example ==		== Example ==
Line 17:		Line 20:
	print("You are " .. statustxts[status + 1] .. ".")		print("You are " .. statustxts[status + 1] .. ".")
	=== Result ===		=== Result ===
	:Prints a description of the player's threat situation to the chat frame. e.g.		Prints a description of the player's threat situation to the chat frame. e.g.
	You are overnuking.		You are overnuking.

Line 23:		Line 26:
	* This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.		* This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.
	* If the second argument is omitted, this function will return 3 if the unit has aggro on something, or 0 otherwise. ''Needs confirmation/additional testing.''		* If the second argument is omitted, this function will return 3 if the unit has aggro on something, or 0 otherwise. ''Needs confirmation/additional testing.''
	* The return value status may be one of:
	** 0 = not tanking, lower threat than tank
	** 1 = not tanking, higher threat than tank
	** 2 = insecurely tanking
	** 3 = securely tanking

	== See also ==		== See also ==
			* [[API UnitDetailedThreatSituation]]
	[[API UnitDetailedThreatSituation]] \| [[API GetThreatStatusColor]]		* [[API GetThreatStatusColor]]

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

WoWWiki>Phanx: Add notes regarding the optional omission of the second argument to this function. Also cleaned up some inconsistent formatting, etc.

2009-03-05T11:45:56Z

Add notes regarding the optional omission of the second argument to this function. Also cleaned up some inconsistent formatting, etc.

← Older revision		Revision as of 11:45, 5 March 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

			Returns brief information about a unit's standing in another unit's threat table. Added in [[Patch 3.0]].

	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~		status = UnitThreatSituation("unit"[, "otherunit"])
	~~Returns brief information about a unit's standing in another unit's threat table. New in [[Patch 3.0]].~~

	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	status = UnitThreatSituation("unit", "~~mob~~")


	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	~~<!-- List each argument, together with its type -->~~		:;unit : string - the [[API TYPE UnitId\|unit token]] of the unit whose threat to query (e.g. "player", "party2", "pet", etc.)
			:;otherunit : string ''(optional)'' - the [[API TYPE UnitId\|unit token]] of the unit whose threat table to query (e.g. "target", "pettarget" etc.)
	:;unit : ~~String~~ - ~~The~~ [[API TYPE UnitId\|~~UnitId~~]] whose threat to query (e.g. "player", "party2", "pet", etc.)

	:;~~mob~~ : ~~String~~ - ~~The~~ [[API TYPE UnitId\|~~UnitId~~]] of the unit whose threat table to query (e.g. "target", "pettarget" etc.)

	=== Returns ===		=== Returns ===
	~~<!-- List each return value, together with its type -->~~		:;status : integer - returns the [[API TYPE ThreatStatus\|threat status]] for the unit on the second unit, or nil if the unit is not on the second unit's threat table, or a [[API TYPE ThreatStatus\|threat status]] or 0 or 3 if the second unit is not specified depending on whether the unit has aggro on anything or not.
	:;status : ~~Integer~~ - returns the [[API TYPE ThreatStatus\|threat status]] for the unit on the ~~mob~~, or nil if unit is not on ~~mob~~'s threat table~~. (3 = securely tanking~~, ~~2 = insecurely tanking, 1 = not tanking but higher~~ threat ~~than tank,~~ 0 = not ~~tanking and lower threat than tank)~~

	== 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 -->~~		print("You are " .. statustxts[status + 1] .. ".")
	local status, statustxts = UnitThreatSituation("player", "target"), {"low on threat", "overnuking", "losing threat", "tanking securely"};		=== Result ===
	~~ChatFrame1:AddMessage~~('You are ' .. statustxts[status+1] .. '.');
	~~<!-- end code -->~~

	====Result====
	~~<!-- 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. -->~~
	:Prints a description of the player's threat situation to the chat frame. e.g.		:Prints a description of the player's threat situation to the chat frame. e.g.
	~~<!-- begin code -->~~
	You are overnuking.		You are overnuking.
	~~<!-- end code -->~~


	~~==Details==~~
	~~<!-- Details not appropriate for the main description can go here.~~
	~~REMOVE the section if you're just going to restate the intro line! -->~~

	* ~~The~~ function will return nil if the unit is not on the ~~mob~~'s threat list or if either unit isn't available.		== Details ==
			* This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.
			* If the second argument is omitted, this function will return 3 if the unit has aggro on something, or 0 otherwise. ''Needs confirmation/additional testing.''
			* The return value status may be one of:
			** 0 = not tanking, lower threat than tank
			** 1 = not tanking, higher threat than tank
			** 2 = insecurely tanking
			** 3 = securely tanking

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

WoWWiki>Scudmarx: New page: {{wowapi}} NOTOC Returns brief information about a unit's standing in another unit's...

2008-10-12T21:22:29Z

New page: {{wowapi}} __NOTOC__  Returns brief information about a unit's standing in another unit's...

New page

{{wowapi}} __NOTOC__


Returns brief information about a unit's standing in another unit's threat table. New in [[Patch 3.0]].


status = UnitThreatSituation("unit", "mob")

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


:;unit : String - The [[API TYPE UnitId|UnitId]] whose threat to query (e.g. "player", "party2", "pet", etc.)

:;mob : String - The [[API TYPE UnitId|UnitId]] of the unit whose threat table to query (e.g. "target", "pettarget" etc.)

=== Returns ===

:;status : Integer - returns the [[API TYPE ThreatStatus|threat status]] for the unit on the mob, or nil if unit is not on mob's threat table. (3 = securely tanking, 2 = insecurely tanking, 1 = not tanking but higher threat than tank, 0 = not tanking and lower threat than tank)

== Example ==


local status, statustxts = UnitThreatSituation("player", "target"), {"low on threat", "overnuking", "losing threat", "tanking securely"};
ChatFrame1:AddMessage('You are ' .. statustxts[status+1] .. '.');


====Result====

:Prints a description of the player's threat situation to the chat frame. e.g.

You are overnuking.


==Details==


* The function will return nil if the unit is not on the mob's threat list or if either unit isn't available.

== See also ==

[[API UnitDetailedThreatSituation]] | [[API GetThreatStatusColor]]

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