WoW:API GetSpellCritChance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetSpellCritChance to API GetSpellCritChance without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}}
Returns a players critical hit chance with spells for a certain school.
Returns a players critical hit chance with spells for a certain school.


Line 4: Line 5:


=== Parameters ===
=== Parameters ===
 
''school'' - the spell school to retrieve the crit chance for
<i>school</i> - the spell school to retrieve the crit chance for
* 1 for Physical
* 2 for Holy
* 3 for Fire
* 4 for Nature
* 5 for Frost
* 6 for Shadow
* 7 for Arcane


=== Returns ===
=== Returns ===
 
An unformatted floating point figure representing the critical hit chance for the specified school.
An unformatted floating point figure representing the critical hit chance for the specified school
 
=== Notes ===
 
The spell schools are named using numbers 1 through 7.  As of this update I don't know which school is which, but I believe that school 2 is Holy based on information from the Paper Doll LUA file.


=== Example ===
=== Example ===
Line 42: Line 44:


The above function is essentially a straight copy of the function from the Paper Doll LUA file in the default UI.
The above function is essentially a straight copy of the function from the Paper Doll LUA file in the default UI.
----
{{WoW API}}

Latest revision as of 04:46, 15 August 2023

WoW API < GetSpellCritChance

Returns a players critical hit chance with spells for a certain school.

theCritChance = GetSpellCritChance(school)

Parameters[edit]

school - the spell school to retrieve the crit chance for

  • 1 for Physical
  • 2 for Holy
  • 3 for Fire
  • 4 for Nature
  • 5 for Frost
  • 6 for Shadow
  • 7 for Arcane

Returns[edit]

An unformatted floating point figure representing the critical hit chance for the specified school.

Example[edit]

The following function, called with no arguments, will return the same spell crit value as shown on the Character pane of the default UI. The figure returned is formatted as a floating-point figure out to two decimal places.

function GetRealSpellCrit()

    local holySchool = 2;
    local minCrit = GetSpellCritChance(holySchool);
    local spellCrit;

    this.spellCrit = {};
    this.spellCrit[holySchool] = minCrit;

    for i=(holySchool+1), 7 do

        spellCrit = GetSpellCritChance(i);
        minCrit = min(minCrit, spellCrit);
        this.spellCrit[i] = spellCrit;

    end

    minCrit = format("%.2f%%", minCrit);
    return minCrit;

end

The above function is essentially a straight copy of the function from the Paper Doll LUA file in the default UI.