WoW:API GetCombatRatingBonus: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetCombatRatingBonus to API GetCombatRatingBonus without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}}
Returns the bonus, in percent (or other converted units, such as skill points), of a specific combat rating for the player.
bonus = GetCombatRatingBonus(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;
:* 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;
:* CR_WEAPON_SKILL_MAINHAND = 21
:* CR_WEAPON_SKILL_OFFHAND = 22
:* CR_WEAPON_SKILL_RANGED = 23;


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
==Returns==
Returns a combat rating bonus for a particular combat rating.
;bonus : Number - the actual bonus in percent the combat rating confers; e.g. 5.13452
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
{{Code/Begin}}
bonus = GetCombatRatingBonus(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 -->
 
:;bonus : Float - the actual bonus the combat rating confers; e.g. 5.13452


== Example ==
== Example ==
Line 51: Line 39:
<!-- 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 = 5.13452
  hitBonus = 5.13452
[[Category:Boilerplates]]

Latest revision as of 04:45, 15 August 2023

← WoW API < GetCombatRatingBonus

Returns the bonus, in percent (or other converted units, such as skill points), of a specific combat rating for the player. 

bonus = GetCombatRatingBonus(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;
  • 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;
  • CR_WEAPON_SKILL_MAINHAND = 21
  • CR_WEAPON_SKILL_OFFHAND = 22
  • CR_WEAPON_SKILL_RANGED = 23;

Returns

bonus
Number - the actual bonus in percent the combat rating confers; e.g. 5.13452

Example

hitBonus = GetCombatRatingBonus(6)

Result 

hitBonus = 5.13452
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetCombatRatingBonus&oldid=16311"