WoW:API UnitArmor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Move page script moved page API UnitArmor to API UnitArmor without leaving a redirect) |
||
| (6 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | |||
Returns the armor statistics relevant to the specified target. | Returns the armor statistics relevant to the specified target. | ||
UnitArmor(unit); | base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit); | ||
== Parameters == | |||
=== Arguments === | |||
: | :;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 === | |||
:base, effectiveArmor, armor, posBuff, negBuff | :base, effectiveArmor, armor, posBuff, negBuff | ||
:;base : | :;base : Number - The unit's base armor without buffs, armor kits or enchantments. | ||
:;effectiveArmor : ? | :;effectiveArmor : Number - The unit's effective armor after buffs (and ??) | ||
:;armor : | :;armor : Number - The unit's armor after adding armor kits and enchantments but without buffs. | ||
:;posBuff : | :;posBuff : Number - Amount of armor increase due to positive buffs | ||
:;negBuff : | :;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 .. ")"); | |||
Latest revision as of 04:47, 15 August 2023
Returns the armor statistics relevant to the specified target.
base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit);
Parameters[edit]
Arguments[edit]
- 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[edit]
- 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[edit]
local baseArmor , effectiveArmor, armor, posBuff, negBuff = UnitArmor("player");
message("Your current armor is " .. effectiveArmor .. " (base is " .. baseArmor .. ")");