Module br.player.charges
These functions help in retrieving information about spell and item charges.
Charge functions are stored in br.player.charges and can be utilized by `local charges = br.player.charges` in your profile. For spell charges, `spell` in the function represent the name in the actions list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua For item charges, `item` in the function represent the name in the item list defined in System/List/Items.lua
Functions
| charges.spell.exists () | Checks if spell has charges or not. |
| charges.spell.count () | Gets the number of charges remaining on spell. |
| charges.spell.frac () | Gets the number of charges remaining on spell as a fraction. |
| charges.spell.max () | Gets the maximum number of charges the spell can have. |
| charges.spell.remain ([chargeMax]) | Gets the time remaining on until next charge is available. |
| charges.spell.timeTillFull () | Gets the total time remaining until all charges are available. |
| charges.item.exists () | Checks if item has charges or not. |
| charges.item.count () | Gets the number of charges remaining on item. |
Functions
- charges.spell.exists ()
-
Checks if spell has charges or not.
Returns:
-
boolean
- charges.spell.count ()
-
Gets the number of charges remaining on spell.
Returns:
-
number
- charges.spell.frac ()
-
Gets the number of charges remaining on spell as a fraction. (e.g. 1.5 charges remaining)
Returns:
-
number
- charges.spell.max ()
-
Gets the maximum number of charges the spell can have.
Returns:
-
number
- charges.spell.remain ([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.spell.timeTillFull ()
-
Gets the total time remaining until all charges are available.
Returns:
-
number
- charges.item.exists ()
-
Checks if item has charges or not.
Returns:
-
boolean
- charges.item.count ()
-
Gets the number of charges remaining on item.
Returns:
-
number