WoW:API UnitThreatSituation

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← 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:

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.
• 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

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.

See also

• API UnitDetailedThreatSituation
• API GetThreatStatusColor