WoW:API UnitThreatSituation: Difference between revisions

m
Fixed typo's
(slight formatting changes)
m (Fixed typo's)
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]]
Anonymous user