18 lines
2.0 KiB
Lua
18 lines
2.0 KiB
Lua
---@diagnostic disable: missing-return, lowercase-global
|
||
---@meta
|
||
|
||
---@param unit unitid
|
||
---@param name string
|
||
---@param mobUnit unitid
|
||
---@return 1nil isTanking
|
||
---@return mobUnit status
|
||
---@return 0
|
||
---@return 1
|
||
---@return mobUnit 2
|
||
---@return mobUnit 3
|
||
---@return number scaledPercent
|
||
---@return number rawPercent
|
||
---@return number threatValue
|
||
---Returns detailed information about the threat status of one unit against another. The different values returned by this function reflect the complexity of NPC threat management: Raw threat roughly equates to the amount of damage a unit has caused to the NPC plus the amount of healing the unit has performed in the NPC's presence. (Each quantity that goes into this sum may be modified, however; such as by a paladin's Righteous Fury self-buff, a priest's Silent Resolve talent, or a player whose cloak is enchanted with Subtlety.) Generally, whichever unit has the highest raw threat against an NPC becomes its primary target, and raw threat percentage simplifies this comparison. However, most NPCs are designed to maintain some degree of target focus -- so that they don't rapidly switch targets if, for example, a unit other than the primary target suddenly reaches 101% raw threat. The amount by which a unit must surpass the primary target's threat to become the new primary target varies by distance from the NPC. Thus, a scaled percentage value is given to provide clarity. The rawPercent value returned from this function can be greater than 100 (indicating that unit has greater threat against mobUnit than mobUnit's primary target, and is thus in danger of becoming the primary target), but the scaledPercent value will always be 100 or lower. Threat information for a pair of units is only returned if the player has threat against the NPC unit in question. (For example, no threat data is provided if the player's pet is attacking an NPC but the player himself has taken no action, even though the pet has threat against the NPC.)
|
||
function UnitDetailedThreatSituation(unit, name, mobUnit) end
|