WoW:API UnitRangedAttack: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{wowapi}}, format)
Line 1: Line 1:
<center>'''UnitRangedAttack''' ''-Documentation by [[user:geekgirljess|geekgirljess]]-''</center>
{{wowapi}} __NOTOC__
 
Returns the unit's ranged attack and modifier.
  base, modifier = UnitRangedAttack("unit");
  base, modifier = UnitRangedAttack("unit");
 
==Parameters==
Returns the unit's ranged attack and modifier.
===Arguments===
 
----
;''Arguments''
 
:("unit")
:;unit : String - The [[API TYPE UnitId|UnitId]] to get information from. (Likely only works for <tt>"player"</tt> and <tt>"pet"</tt>)
:;unit : String - The [[API TYPE UnitId|UnitId]] to get information from. (Likely only works for <tt>"player"</tt> and <tt>"pet"</tt>)
 
===Returns===
----
;''Returns''
 
:base, modifier
:;base : Number - The unit's base ranged attack number (0 if no ranged weapon is equipped)
:;base : Number - The unit's base ranged attack number (0 if no ranged weapon is equipped)
:;modifier : Number - The total effect of all modifiers (positive and negative) to ranged attack.
:;modifier : Number - The total effect of all modifiers (positive and negative) to ranged attack.


----
==Example==
;''Example''
 
  local base, modifier = UnitRangedAttack("player");
  local base, modifier = UnitRangedAttack("player");
  local effective = base + modifier;
  local effective = base + modifier;
 
message(effective);
 
===Result===
----
Displays a message containing your effective ranged attack skill(?).
{{WoW API}}

Revision as of 23:46, 23 December 2006

WoW API < UnitRangedAttack

Returns the unit's ranged attack and modifier.

base, modifier = UnitRangedAttack("unit");

Parameters

Arguments

unit
String - The UnitId to get information from. (Likely only works for "player" and "pet")

Returns

base
Number - The unit's base ranged attack number (0 if no ranged weapon is equipped)
modifier
Number - The total effect of all modifiers (positive and negative) to ranged attack.

Example

local base, modifier = UnitRangedAttack("player");
local effective = base + modifier;
message(effective);

Result

Displays a message containing your effective ranged attack skill(?).