WoW:API UnitAffectingCombat: Difference between revisions

WoW:API UnitAffectingCombat (source)

36 bytes added , 15 August 2023

m

Move page script moved page API UnitAffectingCombat to WoW:API UnitAffectingCombat without leaving a redirect

Anonymous user

@@ Line 1: / Line 1: @@
-<center>'''UnitAffectingCombat''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
+{{wowapi}} __NOTOC__
 Determine whether a unit is in combat or has aggro.
@@ Line 12: / Line 13: @@
 === Returns ===
-;''Returns''
-:affectingCombat
-:;affectingCombat : Flag - Returns 1 if the unit is in combat or has aggro, nil otherwise.
+;affectingCombat : Flag - Returns true if the unit is in combat or has aggro, false otherwise.
 ==Details==
-:Goes true when initiating combat.
+:Returns true when initiating combat.
-:Goes true if aggroed, even if enemy doesn't land a blow.
+:Returns true if aggroed, even if enemy doesn't land a blow.
-:If a hunter, then goes true shortly after pet enters combat.
+:If a hunter, then returns true shortly after pet enters combat.
-:If using timed spell such as aimed shot, goes true when spell fires (not during charge up).
+:If using timed spell such as aimed shot, returns true when spell fires (not during charge up).
-:Goes to false on death.
+:Returns to false on death.
+:Returns false if the unit being checked for aggro is out of range, or in another zone.
+''Note: returns false if a unit is proximity-aggroed. It wont return true until it either attacks or is attacked.''
 ----
-__NOTOC__
-{{Template:WoW API}}
-[[Category:API Unit Functions|UnitAffectingCombat]]