Module charges

These functions help in retrieving information about spell and item charges.

Charge functions are the profile API table `charges` (br.api.profile.charges); profiles use it by name. For spell charges, `spell` in the function represent the name in the actions list (Spec, Shared Class, Shared Global Lists) defined in Expansions// (Global.lua, /Class.lua, /.lua) For item charges, `item` in the function represent the name in the item list defined in System/List/Items.lua

Functions

charges. () Gets the number of charges remaining on spell.
charges. () Checks if spell has charges or not.
charges. () Gets the number of charges remaining on spell as a fraction.
charges. () Gets the maximum number of charges the spell can have.
charges. ([chargeMax]) Gets the time remaining on until next charge is available.
charges. () The spell's cast count as the game keeps it (uses stored on spells that count them).
charges. () Gets the total time remaining until all charges are available.
charges. () Gets the number of charges remaining on item.
charges. () Checks if item has charges or not.


Functions

charges. ()
Gets the number of charges remaining on spell.

Returns:

    number
charges. ()
Checks if spell has charges or not.

Returns:

    boolean
charges. ()
Gets the number of charges remaining on spell as a fraction. (e.g. 1.5 charges remaining)

Returns:

    number
charges. ()
Gets the maximum number of charges the spell can have.

Returns:

    number
charges. ([chargeMax])
Gets the time remaining on until next charge is available.

Parameters:

  • chargeMax boolean If true, returns the time remaining until all charges are available. (optional)

Returns:

    number
charges. ()
The spell's cast count as the game keeps it (uses stored on spells that count them).

Returns:

    number
charges. ()
Gets the total time remaining until all charges are available.

Returns:

    number
charges. ()
Gets the number of charges remaining on item.

Returns:

    number
charges. ()
Checks if item has charges or not.

Returns:

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