WoW:API UnitResistance: Difference between revisions

WoW:API UnitResistance (source)

Revision as of 20:05, 27 June 2007

45 bytes removed , 27 June 2007

Updated to match the current API boilerplate.

Anonymous user

WoWWiki>Ravas

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-With no parameters it appears to return a value describing the '''base''' resistance to physical or magical damage.
---------------------------------------------------------------------------------
-Returns: base, total, bonus, malus
+Gets information about a unit's resistance.
+ base, total, bonus, minus = UnitResistance([[UnitId|unitId]] [, resistanceIndex])
-Base - base value without any gear worn
+== Arguments ==
+:(unitId, resistanceIndex)
+:; unitId : [[UnitId]] - The unit to check
+:; resistanceIndex : Number - The index of the resistance type to check
+:;:* 0 - (Physical) - Armor rating
+:;:* 1 - (Holy)
+:;:* 2 - (Fire)
+:;:* 3 - (Nature)
+:;:* 4 - (Frost)
+:;:* 5 - (Shadow)
+:;:* 6 - (Arcane)
-total - current total value
-bonus - benefit gained from gear and benefitial spells (added to base this equals total)
+== Returns ==
+:base, total, bonus, minus
+:; base : Number - The base resistance
+:; total : Number - The current total value after all modifiers
+:; bonus : Number - The bonus resistance modifier total from gear and buffs
+:; minus : Number - The negative resistance modifier total from gear and buffs
-malus - what you loose from various debuffs, or negative-resistance items
+== Example ==
+ /script SendChatMessage("My base armor is ".. UnitResistance("player", 0));
+  /script _, total, _, _ = UnitResistance("player",0)); SendChatMessage("My total armor is "..total);
-Arguments
-"Unit"
-The unit to be evaluated (appears to only work on "player")
-"resistanceIndex"
-Number defining resistance type.
-- (Physical) - Armor rating
-- (Holy)
-- (Fire)
-- (Nature)
-- (Frost)
-- (Shadow)
-- (Arcane)
---------------------------------------------------------------------------------
-Example
-/script SendChatMessage("My base armor is ".. UnitResistance("player", 0));
-/script A,B,C,D = UnitResistance("player",0)); SendChatMessage("My total armor is "..B);