WoW:API UnitArmor: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API UnitArmor to API UnitArmor without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}} __NOTOC__
Returns the armor statistics relevant to the specified target.
Returns the armor statistics relevant to the specified target.


  base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit);
  base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit);


----
== Parameters ==
;''Arguments''
=== Arguments ===
:
:;unit : String - The [[API TYPE UnitId|UnitId]] to get information from. (Only seems to work for <tt>"player"</tt> and <tt>"pet"</tt>) (Also works for "target" if that is a beast on which the player has cast Beast Lore.)


----
:;unit : String - The [[unitId]] to get information from. Normally only works for <tt>"player"</tt> and <tt>"pet"</tt>, but also for "target" if the target is a beast upon which the hunter player has cast Beast Lore.
;''Returns''
 
=== Returns ===


:base, effectiveArmor, armor, posBuff, negBuff
:base, effectiveArmor, armor, posBuff, negBuff
Line 19: Line 18:
:;negBuff : Number - Amount of armor reduction due to negative buffs (a negative number)
:;negBuff : Number - Amount of armor reduction due to negative buffs (a negative number)


----
== Example ==
;''Example''
  local baseArmor , effectiveArmor, armor, posBuff, negBuff = UnitArmor("player");
  local base, effectiveArmor, armor, posBuff, negBuff = UnitArmor("player");
  message("Your current armor is " .. effectiveArmor .. " (base is " .. baseArmor .. ")");
  message("Your current armor is " .. effectiveArmor .. " (base is " .. baseArmor .. ")");
;''Result''
: Message box appears displaying the current and base armor values of your character.

Latest revision as of 04:47, 15 August 2023

← WoW API < UnitArmor

Returns the armor statistics relevant to the specified target. 

base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit);

Parameters

Arguments

unit
String - The unitId to get information from. Normally only works for "player" and "pet", but also for "target" if the target is a beast upon which the hunter player has cast Beast Lore.

Returns

base, effectiveArmor, armor, posBuff, negBuff
base
Number - The unit's base armor without buffs, armor kits or enchantments.
effectiveArmor
Number - The unit's effective armor after buffs (and ??)
armor
Number - The unit's armor after adding armor kits and enchantments but without buffs.
posBuff
Number - Amount of armor increase due to positive buffs
negBuff
Number - Amount of armor reduction due to negative buffs (a negative number)

Example

local baseArmor , effectiveArmor, armor, posBuff, negBuff = UnitArmor("player");
message("Your current armor is " .. effectiveArmor .. " (base is " .. baseArmor .. ")");
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_UnitArmor&oldid=9232"