WoW:API GetCombatRating: Difference between revisions

m
Move page script moved page API GetCombatRating to WoW:API GetCombatRating without leaving a redirect
(-Category:Boilerplates)
m (Move page script moved page API GetCombatRating to WoW:API GetCombatRating without leaving a redirect)
 
(12 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}}
Returns the number of points of a specific combat rating the player has.
rating = GetCombatRating(combatRatingIdentifier)


== Arguments ==
;combatRatingIdentifier
: Number - A combat rating identifier, one of:
:* CR_WEAPON_SKILL = 1;
:* CR_DEFENSE_SKILL = 2;
:* CR_DODGE = 3;
:* CR_PARRY = 4;
:* CR_BLOCK = 5;
:* CR_HIT_MELEE = 6;
:* CR_HIT_RANGED = 7;
:* CR_HIT_SPELL = 8;
:* CR_CRIT_MELEE = 9;
:* CR_CRIT_RANGED = 10;
:* CR_CRIT_SPELL = 11;
:* CR_HIT_TAKEN_MELEE = 12;
:* CR_HIT_TAKEN_RANGED = 13;
:* CR_HIT_TAKEN_SPELL = 14;
:* COMBAT_RATING_RESILIENCE_CRIT_TAKEN = 15;
:* COMBAT_RATING_RESILIENCE_PLAYER_DAMAGE_TAKEN = 16;
:* CR_CRIT_TAKEN_SPELL = 17;
:* CR_HASTE_MELEE = 18;
:* CR_HASTE_RANGED = 19;
:* CR_HASTE_SPELL = 20;
:* CR_WEAPON_SKILL_MAINHAND = 21;
:* CR_WEAPON_SKILL_OFFHAND = 22;
:* CR_WEAPON_SKILL_RANGED = 23;
:* CR_EXPERTISE = 24;
:* CR_ARMOR_PENETRATION = 25;
:* CR_MASTERY = 26;
:* CR_VERSATILITY=29
:* Versatility=30 (bug?)
:* CR_MULTISTRIKE = GetCombatRating(CR_MULTISTRIKE)


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
== Returns ==
Returns a combat rating for a particular combat rating.
;rating
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
: Number - the actual rating for the combat rating; e.g. 63
{{Code/Begin}}
rating = GetCombatRating(combatRatingIdentifier)
{{Code/End}}
 
 
== Parameters ==
 
<big>'''Arguments'''</big>
<!-- List each argument, together with its type -->
:(combatRatingIdentifier)
 
:;combatRatingIdentifier : Integer - A combat rating identifier, one of:
 
* CR_WEAPON_SKILL = 1;
* CR_DEFENSE_SKILL = 2;
* CR_DODGE = 3;
* CR_PARRY = 4;
* CR_BLOCK = 5;
* CR_HIT_MELEE = 6;
* CR_HIT_RANGED = 7;
* CR_HIT_SPELL = 8;
* CR_CRIT_MELEE = 9;
* CR_CRIT_RANGED = 10;
* CR_CRIT_SPELL = 11;
* CR_HIT_TAKEN_MELEE = 12;
* CR_HIT_TAKEN_RANGED = 13;
* CR_HIT_TAKEN_SPELL = 14;
* CR_CRIT_TAKEN_MELEE = 15;
* CR_CRIT_TAKEN_RANGED = 16;
* CR_CRIT_TAKEN_SPELL = 17;
* CR_HASTE_MELEE = 18;
* CR_HASTE_RANGED = 19;
* CR_HASTE_SPELL = 20;
 
<big>'''Returns'''</big>
<!-- List each return value, together with its type -->
 
:;rating: Float - the actual rating for the combat rating; e.g. 63


== Example ==
== Example ==
Line 50: Line 46:
<big>'''Result'''</big>
<big>'''Result'''</big>
<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
  hitBonus = 63
  hitRating = 63
Anonymous user