WoW:API UnitDamage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Updated the {{wowapi}} tag on the top of the page.)
(Formatting mostly)
Line 1: Line 1:
{{wowapi}}
{{wowapi}} __NOTOC__
<center>'''UnitDamage''' ''-Documentation by [[User:The_ED|The_ED]]-''</center>


Unit damage returns information about your current damage stats. Doesn't seem to return usable values for mobs, NPCs, or other players. The method returns 7 values, only some of which appear to be useful.
Unit damage returns information about your current damage stats. Doesn't seem to return usable values for mobs, NPCs, or other players. The method returns 7 values, only some of which appear to be useful.
Line 6: Line 5:
  lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod = UnitDamage("unit");
  lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod = UnitDamage("unit");


----
== Parameters ==
;''Arguments''
=== Arguments ===


:("unit")
:;unit : String - The [[unitId]] to get information for. (Likely only works for <tt>"player"</tt> and <tt>"pet"</tt>. Possibly for [[Beast Lore]]'d <tt>"target"</tt>s. -- unconfirmed)
:;unit : String - The [[API TYPE UnitId|UnitId]] to get information from. (Likely only works for <tt>"player"</tt> and <tt>"pet"</tt> -- unconfirmed)
 
----
=== Returns ===
;''Returns''


: lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod
: lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod
:;lowDmg : Number - The unit's minimum melee damage.
:;lowDmg : Number - The unit's minimum melee damage.
:;hiDmg : Number - The unit's maximum melee damage.
:;hiDmg : Number - The unit's maximum melee damage.
Line 22: Line 21:
:;negBuff : Number - negative physical Bonus (should be <= 0)
:;negBuff : Number - negative physical Bonus (should be <= 0)
:;percentmod : Number - percentage modifier (usually 1)
:;percentmod : Number - percentage modifier (usually 1)
----

Revision as of 09:46, 11 August 2006

WoW API < UnitDamage

Unit damage returns information about your current damage stats. Doesn't seem to return usable values for mobs, NPCs, or other players. The method returns 7 values, only some of which appear to be useful.

lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod = UnitDamage("unit");

Parameters

Arguments

unit
String - The unitId to get information for. (Likely only works for "player" and "pet". Possibly for Beast Lore'd "target"s. -- unconfirmed)

Returns

lowDmg, hiDmg, offlowDmg, offhiDmg, posBuff, negBuff, percentmod
lowDmg
Number - The unit's minimum melee damage.
hiDmg
Number - The unit's maximum melee damage.
offlowDmg
Number - The unit's minimum offhand melee damage.
offhiDmg
Number - The unit's maximum offhand melee damage. (same as above)
posBuff
Number - positive physical Bonus (should be >= 0)
negBuff
Number - negative physical Bonus (should be <= 0)
percentmod
Number - percentage modifier (usually 1)