Module spell

These functions help in retrieving information about spells.

Spell functions are the profile API table `spell` (br.api.profile.spell); profiles use it by name. `k` in the function represent the name in the actions list (Spec, Shared Class, Shared Global Lists) defined in Expansions// (Global.lua, /Class.lua, /.lua)

Functions

spell. () What the spell's current rank heals or hits for: the average BR saw it do (direct, not critical, from 2 casts), else the middle of its tooltip's " to ", else nil.
spell. () Returns the spell's cast time.
spell. () Returns the spell's ID.
spell. ([thisUnit="target"]) For a combo point finisher (Ferocious Bite, Eviscerate, ...): true when it's sure to kill the unit at your current combo points and Energy, from the damage the tooltip lists.
spell. () Checks if the spell is known.
spell. () Returns the spell's max range.
spell. () Returns the spell's min range.
spell. () Returns the spell's name (localized).
spell. () Returns the highest rank of the spell the player knows (0 when it isn't known; 1 on clients without ranks).
spell. () Returns the spell's icon texture.


Functions

spell. ()
What the spell's current rank heals or hits for: the average BR saw it do (direct, not critical, from 2 casts), else the middle of its tooltip's " to ", else nil.

Returns:

    number|nil

Usage:

    if (spell.lightningBolt.amount() or 0) > unit.weaponDamage() then
spell. ()
Returns the spell's cast time.

Returns:

    number
spell. ()
Returns the spell's ID.

Returns:

    number
spell. ([thisUnit="target"])
For a combo point finisher (Ferocious Bite, Eviscerate, ...): true when it's sure to kill the unit at your current combo points and Energy, from the damage the tooltip lists. Never true on dummies.

Parameters:

  • thisUnit The unit to finish (default "target")

Returns:

    boolean

Usage:

    if spell.ferociousBite.kills(units.dyn5) and cast.able.ferociousBite(units.dyn5) then
spell. ()
Checks if the spell is known.

Returns:

    boolean
spell. ()
Returns the spell's max range.

Returns:

    number
spell. ()
Returns the spell's min range.

Returns:

    number
spell. ()
Returns the spell's name (localized).

Returns:

    string
spell. ()
Returns the highest rank of the spell the player knows (0 when it isn't known; 1 on clients without ranks).

Returns:

    number
spell. ()
Returns the spell's icon texture.

Returns:

    number
generated by LDoc 1.5.0 Last updated 2026-11-16 01:18:17