WoW:API UnitThreatSituation: Difference between revisions
Jump to navigation
Jump to search
(Add notes regarding the optional omission of the second argument to this function. Also cleaned up some inconsistent formatting, etc.) |
(slight formatting changes) |
||
| 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.) | |||
;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 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. | |||
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.'' | ||
== See also == | == See also == | ||
* [[API UnitDetailedThreatSituation]] | |||
[[API UnitDetailedThreatSituation]] | * [[API GetThreatStatusColor]] | ||
[[Category:Interface customization]] | [[Category:Interface customization]] | ||
[[Category:World of Warcraft API]] | [[Category:World of Warcraft API]] | ||
Revision as of 22:04, 29 March 2009
← WoW API < UnitThreatSituation
Returns brief information about a unit's standing in another unit's threat table. Added in Patch 3.0.
status = UnitThreatSituation("unit"[, "otherunit"])
Parameters
Arguments
- unit
- string - the unit token of the unit whose threat to query (e.g. "player", "party2", "pet", etc.)
- otherunit
- string (optional) - the unit token of the unit whose threat table to query (e.g. "target", "pettarget" etc.)
Returns
- 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
local status, statustxts = UnitThreatSituation("player", "target"), { "low on threat", "overnuking", "losing threat", "tanking securely" }
print("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
- 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.