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.) |
m (Move page script moved page API UnitThreatSituation to API UnitThreatSituation without leaving a redirect) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| 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: | |||
:;With otherunit specified | |||
::* 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, another unit have higher threat but not tanking. | |||
::* 3 = securely tanking, highest threat | |||
:;Without otherunit specified | |||
::* nil = unit is not on any other unit's threat table. | |||
::* 0 = not tanking anything. | |||
::* 1 = not tanking anything, but have higher threat than tank on at least one unit. | |||
::* 2 = insecurely tanking at least one unit, but not securely tanking anything. | |||
::* 3 = securely tanking at least one unit. | |||
== Example == | == Example == | ||
| Line 17: | Line 32: | ||
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. | ||
== 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. | ||
== See also == | == See also == | ||
* [[API UnitDetailedThreatSituation]] | |||
[[API UnitDetailedThreatSituation]] | * [[API GetThreatStatusColor]] | ||
Latest revision as of 04:47, 15 August 2023
← 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[edit]
Arguments[edit]
- 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[edit]
- status
- integer - returns the threat status for the unit:
- With otherunit specified
- 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, another unit have higher threat but not tanking.
- 3 = securely tanking, highest threat
- Without otherunit specified
- nil = unit is not on any other unit's threat table.
- 0 = not tanking anything.
- 1 = not tanking anything, but have higher threat than tank on at least one unit.
- 2 = insecurely tanking at least one unit, but not securely tanking anything.
- 3 = securely tanking at least one unit.
Example[edit]
local status, statustxts = UnitThreatSituation("player", "target"), { "low on threat", "overnuking", "losing threat", "tanking securely" }
print("You are " .. statustxts[status + 1] .. ".")
Result[edit]
Prints a description of the player's threat situation to the chat frame. e.g.
You are overnuking.
Details[edit]
- This function will return nil if the unit is not on the second unit's threat list, or if either unit isn't available.