WoW:API UnitRangedAttackPower: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API UnitRangedAttackPower to API UnitRangedAttackPower without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<center>'''UnitRangedAttackPower''' ''-Documentation by [[user:geekgirljess|geekgirljess]]-''</center>
{{wowapi}} __NOTOC__
 
Returns the unit's ranged attack power and modifiers.
  base, posBuff, negBuff = UnitRangedAttackPower("unit");
  base, posBuff, negBuff = UnitRangedAttackPower("unit");


Returns the unit's ranged attack power and modifiers.
==Parameters==
 
===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, posBuff, negBuff
:;base : Number - The unit's base ranged attack power (seems to give a positive number even if no ranged weapon equipped)
:;base : Number - The unit's base ranged attack power (seems to give a positive number even if no ranged weapon equipped)
:;posBuff : Number - The total effect of positive buffs to ranged attack power.
:;posBuff : Number - The total effect of positive buffs to ranged attack power.
:;negBuff : Number - The total effect of negative buffs to the ranged attack power (a negative number)
:;negBuff : Number - The total effect of negative buffs to the ranged attack power (a negative number)


----
==Example==
;''Example''
 
  local base, posBuff, negBuff = UnitRangedAttackPower("player");
  local base, posBuff, negBuff = UnitRangedAttackPower("player");
  local effective = base + posBuff + negBuff;
  local effective = base + posBuff + negBuff;
 
message("Your current ranged attack power: " .. effective);
----
===Result===
{{Template:WoW API}}
A message with your current ranged attack power is displayed.
[[Category:API Unit Functions|UnitRangedAttackPower]]

Latest revision as of 04:47, 15 August 2023

WoW API < UnitRangedAttackPower

Returns the unit's ranged attack power and modifiers.

base, posBuff, negBuff = UnitRangedAttackPower("unit");

Parameters[edit]

Arguments[edit]

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

Returns[edit]

base
Number - The unit's base ranged attack power (seems to give a positive number even if no ranged weapon equipped)
posBuff
Number - The total effect of positive buffs to ranged attack power.
negBuff
Number - The total effect of negative buffs to the ranged attack power (a negative number)

Example[edit]

local base, posBuff, negBuff = UnitRangedAttackPower("player");
local effective = base + posBuff + negBuff;
message("Your current ranged attack power: " .. effective);

Result[edit]

A message with your current ranged attack power is displayed.