Module unit.Player.Power

This is the Player Power module.

Functions

Player:ManaMax () Returns the maximum Mana of the player.
Player:Mana () Returns the current Mana of the player.
Player:ManaPercentage () Returns the current Mana as a percentage of maximum Mana.
Player:ManaDeficit () Returns the Mana deficit (maximum Mana minus current Mana).
Player:ManaDeficitPercentage () Returns the Mana deficit as a percentage of maximum Mana.
Player:ManaRegen () Returns the Mana regeneration rate of the player.
Player:ManaCastRegen (castTime) Calculates the Mana regenerated during a cast time.
Player:ManaRemainingCastRegen (offset) Calculates the Mana regenerated during the remaining cast time or GCD.
Player:ManaTimeToMax () Calculates the time until Mana reaches its maximum.
Player:ManaTimeToX (amount) Calculates the time until Mana reaches a specified amount.
Player:ManaP () Returns the player's Mana after a potential cast, including regeneration during that time.
Player:ManaPercentageP () Returns the player's predicted Mana as a percentage of maximum Mana.
Player:ManaDeficitP () Returns the predicted Mana deficit.
Player:ManaDeficitPercentageP () Returns the predicted Mana deficit as a percentage.
Player:RageMax () Returns the maximum Rage of the player.
Player:Rage () Returns the current Rage of the player.
Player:RagePercentage () Returns the current Rage as a percentage of maximum Rage.
Player:RageDeficit () Returns the Rage deficit (maximum Rage minus current Rage).
Player:RageDeficitPercentage () Returns the Rage deficit as a percentage of maximum Rage.
Player:FocusMax () Returns the maximum Focus of the player.
Player:Focus () Returns the current Focus of the player.
Player:FocusRegen () Returns the Focus regeneration rate of the player.
Player:FocusPercentage () Returns the current Focus as a percentage of maximum Focus.
Player:FocusDeficit () Returns the Focus deficit (maximum Focus minus current Focus).
Player:FocusDeficitPercentage () Returns the Focus deficit as a percentage of maximum Focus.
Player:FocusRegenPercentage () Returns the Focus regeneration rate as a percentage of maximum Focus.
Player:FocusTimeToMax () Calculates the time until Focus reaches its maximum.
Player:FocusTimeToX (amount) Calculates the time until Focus reaches a specified amount.
Player:FocusTimeToXPercentage (amount) Calculates the time until Focus percentage reaches a specified amount.
Player:FocusCastRegen (castTime) Calculates the Focus regenerated during a cast time.
Player:FocusRemainingCastRegen (offset) Calculates the Focus regenerated during the remaining cast time or GCD.
Player:FocusLossOnCastEnd () Returns the Focus cost of the current casting spell.
Player:FocusPredicted (offset) Returns the player's predicted Focus after current actions.
Player:FocusDeficitPredicted (offset) Returns the predicted Focus deficit after current actions.
Player:FocusTimeToMaxPredicted () Calculates the time until predicted Focus reaches its maximum.
Player:EnergyMax (maxOffset) Returns the maximum Energy of the player, with an optional offset.
Player:Energy () Returns the current Energy of the player.
Player:EnergyRegen () Returns the Energy regeneration rate of the player.
Player:EnergyPercentage (maxOffset) Returns the current Energy as a percentage of maximum Energy, with an optional offset.
Player:EnergyDeficit (maxOffset) Returns the Energy deficit (maximum Energy minus current Energy), with an optional offset.
Player:EnergyDeficitPercentage (maxOffset) Returns the Energy deficit as a percentage of maximum Energy, with an optional offset.
Player:EnergyRegenPercentage (maxOffset) Returns the Energy regeneration rate as a percentage of maximum Energy, with an optional offset.
Player:EnergyTimeToMax (maxOffset) Calculates the time until Energy reaches its maximum, with an optional offset.
Player:EnergyTimeToX (amount, offset) Calculates the time until Energy reaches a specified amount, with an optional regeneration offset.
Player:EnergyTimeToXPercentage (amount) Calculates the time until Energy percentage reaches a specified amount.
Player:EnergyRemainingCastRegen (offset) Calculates the Energy regenerated during the remaining cast/channel time or GCD.
Player:EnergyPredicted (offset, maxOffset) Returns the player's predicted Energy after current actions, with optional offsets.
Player:EnergyDeficitPredicted (offset, maxOffset) Returns the predicted Energy deficit after current actions, with optional offsets.
Player:EnergyTimeToMaxPredicted (offset, maxOffset) Calculates the time until predicted Energy reaches its maximum, with optional offsets.
Player:ComboPointsMax () Returns the maximum Combo Points of the player.
Player:ComboPoints () Returns the current Combo Points of the player.
Player:ChargedComboPoints () Returns the number of charged Combo Points (e.g., for Rogue's Subtlety).
Player:ComboPointsDeficit () Returns the Combo Points deficit (maximum Combo Points minus current Combo Points).
Player:RunicPowerMax () Returns the maximum Runic Power of the player.
Player:RunicPower () Returns the current Runic Power of the player.
Player:RunicPowerPercentage () Returns the current Runic Power as a percentage of maximum Runic Power.
Player:RunicPowerDeficit () Returns the Runic Power deficit (maximum Runic Power minus current Runic Power).
Player:RunicPowerDeficitPercentage () Returns the Runic Power deficit as a percentage of maximum Runic Power.
Player:Rune () Returns the number of ready runes the player has.
Player:RuneTimeToX (value) Returns the cooldown until the 'value'th rune becomes available.
Player:SoulShardsMax () Returns the maximum Soul Shards of the player.
Player:SoulShards () Returns the current Soul Shards of the player.
Player:SoulShardsP () Returns the current Soul Shards of the player (alias for SoulShards()).
Player:SoulShardsDeficit () Returns the Soul Shards deficit (maximum Soul Shards minus current Soul Shards).
Player:AstralPowerMax () Returns the maximum Astral Power of the player.
Player:AstralPower (overrideFutureAstralPower) Returns the current Astral Power of the player, with an optional override for future power.
Player:AstralPowerPercentage (overrideFutureAstralPower) Returns the current Astral Power as a percentage of maximum Astral Power, with an optional override.
Player:AstralPowerDeficit (overrideFutureAstralPower) Returns the Astral Power deficit (maximum Astral Power minus current Astral Power), with an optional override.
Player:AstralPowerDeficitPercentage (overrideFutureAstralPower) Returns the Astral Power deficit as a percentage of maximum Astral Power, with an optional override.
Player:HolyPowerMax () Returns the maximum Holy Power of the player.
Player:HolyPower () Returns the current Holy Power of the player.
Player:HolyPowerPercentage () Returns the current Holy Power as a percentage of maximum Holy Power.
Player:HolyPowerDeficit () Returns the Holy Power deficit (maximum Holy Power minus current Holy Power).
Player:HolyPowerDeficitPercentage () Returns the Holy Power deficit as a percentage of maximum Holy Power.
Player:MaelstromMax () 11 | Maelstrom Functions --
Player:Maelstrom () Returns the current Maelstrom of the player.
Player:MaelstromPercentage () Returns the current Maelstrom as a percentage of maximum Maelstrom.
Player:MaelstromDeficit () Returns the Maelstrom deficit (maximum Maelstrom minus current Maelstrom).
Player:MaelstromDeficitPercentage () Returns the Maelstrom deficit as a percentage of maximum Maelstrom.
Player:ChiMax () Returns the maximum Chi of the player.
Player:Chi () Returns the current Chi of the player.
Player:ChiPercentage () Returns the current Chi as a percentage of maximum Chi.
ChiDeficit () Returns the player's current Chi deficit (ChiMax - Chi).
ChiDeficitPercentage () Returns the player's current Chi deficit as a percentage of maximum Chi.
StaggerMax () Returns the player's maximum Stagger amount.
Stagger () Returns the player's current Stagger amount.
StaggerPercentage () Returns the player's current Stagger as a percentage of maximum Stagger.
InsanityMax () Returns the player's maximum Insanity.
Insanity () Returns the player's current Insanity.
InsanityPercentage () Returns the player's current Insanity as a percentage of maximum Insanity.
InsanityDeficit () Returns the player's current Insanity deficit (InsanityMax - Insanity).
InsanityDeficitPercentage () Returns the player's current Insanity deficit as a percentage of maximum Insanity.
InsanityDrain () Returns the player's Insanity drain per second.
ArcaneChargesMax () Returns the player's maximum Arcane Charges.
ArcaneCharges () Returns the player's current Arcane Charges.
ArcaneChargesPercentage () Returns the player's current Arcane Charges as a percentage of maximum Arcane Charges.
ArcaneChargesDeficit () Returns the player's current Arcane Charges deficit (ArcaneChargesMax - ArcaneCharges).
ArcaneChargesDeficitPercentage () Returns the player's current Arcane Charges deficit as a percentage of maximum Arcane Charges.
FuryMax () Returns the player's maximum Fury.
Fury () Returns the player's current Fury.
FuryPercentage () Returns the player's current Fury as a percentage of maximum Fury.
FuryDeficit () Returns the player's current Fury deficit (FuryMax - Fury).
FuryDeficitPercentage () Returns the player's current Fury deficit as a percentage of maximum Fury.
PainMax () Returns the player's maximum Pain.
Pain () Returns the player's current Pain.
PainPercentage () Returns the player's current Pain as a percentage of maximum Pain.
PainDeficit () Returns the player's current Pain deficit (PainMax - Pain).
PainDeficitPercentage () Returns the player's current Pain deficit as a percentage of maximum Pain.
EssenceMax () Returns the player's maximum Essence.
Essence () Returns the player's current Essence.
EssenceDeficit () Returns the player's current Essence deficit (EssenceMax - Essence).
EmpowerStageDuration (number) Returns the duration of a specific Empower stage for the player.
EmpowerStage (number) Checks if the player has reached a specific Empower stage.


Functions

Player:ManaMax ()
Returns the maximum Mana of the player.

Returns:

    number # The maximum Mana.
Player:Mana ()
Returns the current Mana of the player.

Returns:

    number # The current Mana.
Player:ManaPercentage ()
Returns the current Mana as a percentage of maximum Mana.

Returns:

    number # The current Mana percentage.
Player:ManaDeficit ()
Returns the Mana deficit (maximum Mana minus current Mana).

Returns:

    number # The Mana deficit.
Player:ManaDeficitPercentage ()
Returns the Mana deficit as a percentage of maximum Mana.

Returns:

    number # The Mana deficit percentage.
Player:ManaRegen ()
Returns the Mana regeneration rate of the player.

Returns:

    number # The Mana regeneration rate.
Player:ManaCastRegen (castTime)
Calculates the Mana regenerated during a cast time.

Parameters:

  • castTime number # The duration of the cast.

Returns:

    number # The Mana regenerated, or -1 if no Mana regeneration.
Player:ManaRemainingCastRegen (offset)
Calculates the Mana regenerated during the remaining cast time or GCD.

Parameters:

  • offset number|nil # An optional time offset to add to the remaining duration.

Returns:

    number # The Mana regenerated, or -1 if no Mana regeneration.
Player:ManaTimeToMax ()
Calculates the time until Mana reaches its maximum.

Returns:

    number # Time in seconds, or -1 if no Mana regeneration.
Player:ManaTimeToX (amount)
Calculates the time until Mana reaches a specified amount.

Parameters:

  • amount number # The target Mana amount.

Returns:

    number # Time in seconds, or -1 if no Mana regeneration, or 0 if already above target.
Player:ManaP ()
Returns the player's Mana after a potential cast, including regeneration during that time.

Returns:

    number # The predicted Mana.
Player:ManaPercentageP ()
Returns the player's predicted Mana as a percentage of maximum Mana.

Returns:

    number # The predicted Mana percentage.
Player:ManaDeficitP ()
Returns the predicted Mana deficit.

Returns:

    number # The predicted Mana deficit.
Player:ManaDeficitPercentageP ()
Returns the predicted Mana deficit as a percentage.

Returns:

    number # The predicted Mana deficit percentage.
Player:RageMax ()
Returns the maximum Rage of the player.

Returns:

    number # The maximum Rage.
Player:Rage ()
Returns the current Rage of the player.

Returns:

    number # The current Rage.
Player:RagePercentage ()
Returns the current Rage as a percentage of maximum Rage.

Returns:

    number # The current Rage percentage.
Player:RageDeficit ()
Returns the Rage deficit (maximum Rage minus current Rage).

Returns:

    number # The Rage deficit.
Player:RageDeficitPercentage ()
Returns the Rage deficit as a percentage of maximum Rage.

Returns:

    number # The Rage deficit percentage.
Player:FocusMax ()
Returns the maximum Focus of the player.

Returns:

    number # The maximum Focus.
Player:Focus ()
Returns the current Focus of the player.

Returns:

    number # The current Focus.
Player:FocusRegen ()
Returns the Focus regeneration rate of the player.

Returns:

    number # The Focus regeneration rate.
Player:FocusPercentage ()
Returns the current Focus as a percentage of maximum Focus.

Returns:

    number # The current Focus percentage.
Player:FocusDeficit ()
Returns the Focus deficit (maximum Focus minus current Focus).

Returns:

    number # The Focus deficit.
Player:FocusDeficitPercentage ()
Returns the Focus deficit as a percentage of maximum Focus.

Returns:

    number # The Focus deficit percentage.
Player:FocusRegenPercentage ()
Returns the Focus regeneration rate as a percentage of maximum Focus.

Returns:

    number # The Focus regeneration rate percentage.
Player:FocusTimeToMax ()
Calculates the time until Focus reaches its maximum.

Returns:

    number # Time in seconds, or -1 if no Focus regeneration.
Player:FocusTimeToX (amount)
Calculates the time until Focus reaches a specified amount.

Parameters:

  • amount number # The target Focus amount.

Returns:

    number # Time in seconds, or -1 if no Focus regeneration, or 0 if already above target.
Player:FocusTimeToXPercentage (amount)
Calculates the time until Focus percentage reaches a specified amount.

Parameters:

  • amount number # The target Focus percentage.

Returns:

    number # Time in seconds, or -1 if no Focus regeneration, or 0 if already above target.
Player:FocusCastRegen (castTime)
Calculates the Focus regenerated during a cast time.

Parameters:

  • castTime number # The duration of the cast.

Returns:

    number # The Focus regenerated, or -1 if no Focus regeneration.
Player:FocusRemainingCastRegen (offset)
Calculates the Focus regenerated during the remaining cast time or GCD.

Parameters:

  • offset number|nil # An optional time offset to add to the remaining duration.

Returns:

    number # The Focus regenerated, or -1 if no Focus regeneration.
Player:FocusLossOnCastEnd ()
Returns the Focus cost of the current casting spell.

Returns:

    number # The Focus cost, or 0 if not casting or no cost.
Player:FocusPredicted (offset)
Returns the player's predicted Focus after current actions.

Parameters:

  • offset number|nil # An optional time offset.

Returns:

    number # The predicted Focus, or -1 if no Focus regeneration.
Player:FocusDeficitPredicted (offset)
Returns the predicted Focus deficit after current actions.

Parameters:

  • offset number|nil # An optional time offset.

Returns:

    number # The predicted Focus deficit, or -1 if no Focus regeneration.
Player:FocusTimeToMaxPredicted ()
Calculates the time until predicted Focus reaches its maximum.

Returns:

    number # Time in seconds, or -1 if no Focus regeneration.
Player:EnergyMax (maxOffset)
Returns the maximum Energy of the player, with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to add to the maximum Energy.

Returns:

    number # The maximum Energy.
Player:Energy ()
Returns the current Energy of the player.

Returns:

    number # The current Energy.
Player:EnergyRegen ()
Returns the Energy regeneration rate of the player.

Returns:

    number # The Energy regeneration rate.
Player:EnergyPercentage (maxOffset)
Returns the current Energy as a percentage of maximum Energy, with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The current Energy percentage.
Player:EnergyDeficit (maxOffset)
Returns the Energy deficit (maximum Energy minus current Energy), with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The Energy deficit.
Player:EnergyDeficitPercentage (maxOffset)
Returns the Energy deficit as a percentage of maximum Energy, with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The Energy deficit percentage.
Player:EnergyRegenPercentage (maxOffset)
Returns the Energy regeneration rate as a percentage of maximum Energy, with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The Energy regeneration rate percentage.
Player:EnergyTimeToMax (maxOffset)
Calculates the time until Energy reaches its maximum, with an optional offset.

Parameters:

  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # Time in seconds, or -1 if no Energy regeneration.
Player:EnergyTimeToX (amount, offset)
Calculates the time until Energy reaches a specified amount, with an optional regeneration offset.

Parameters:

  • amount number # The target Energy amount.
  • offset number|nil # An optional offset to apply to the regeneration rate.

Returns:

    number # Time in seconds, or -1 if no Energy regeneration, or 0 if already above target.
Player:EnergyTimeToXPercentage (amount)
Calculates the time until Energy percentage reaches a specified amount.

Parameters:

  • amount number # The target Energy percentage.

Returns:

    number # Time in seconds, or -1 if no Energy regeneration, or 0 if already above target.
Player:EnergyRemainingCastRegen (offset)
Calculates the Energy regenerated during the remaining cast/channel time or GCD.

Parameters:

  • offset number|nil # An optional time offset to add to the remaining duration.

Returns:

    number # The Energy regenerated, or -1 if no Energy regeneration.
Player:EnergyPredicted (offset, maxOffset)
Returns the player's predicted Energy after current actions, with optional offsets.

Parameters:

  • offset number|nil # An optional time offset.
  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The predicted Energy, or -1 if no Energy regeneration.
Player:EnergyDeficitPredicted (offset, maxOffset)
Returns the predicted Energy deficit after current actions, with optional offsets.

Parameters:

  • offset number|nil # An optional time offset.
  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # The predicted Energy deficit, or -1 if no Energy regeneration.
Player:EnergyTimeToMaxPredicted (offset, maxOffset)
Calculates the time until predicted Energy reaches its maximum, with optional offsets.

Parameters:

  • offset number|nil # An optional time offset.
  • maxOffset number|nil # An optional offset to consider for maximum Energy.

Returns:

    number # Time in seconds, or -1 if no Energy regeneration.
Player:ComboPointsMax ()
Returns the maximum Combo Points of the player.

Returns:

    number # The maximum Combo Points.
Player:ComboPoints ()
Returns the current Combo Points of the player.

Returns:

    number # The current Combo Points.
Player:ChargedComboPoints ()
Returns the number of charged Combo Points (e.g., for Rogue's Subtlety).

Returns:

    number # The number of charged Combo Points.
Player:ComboPointsDeficit ()
Returns the Combo Points deficit (maximum Combo Points minus current Combo Points).

Returns:

    number # The Combo Points deficit.
Player:RunicPowerMax ()
Returns the maximum Runic Power of the player.

Returns:

    number # The maximum Runic Power.
Player:RunicPower ()
Returns the current Runic Power of the player.

Returns:

    number # The current Runic Power.
Player:RunicPowerPercentage ()
Returns the current Runic Power as a percentage of maximum Runic Power.

Returns:

    number # The current Runic Power percentage.
Player:RunicPowerDeficit ()
Returns the Runic Power deficit (maximum Runic Power minus current Runic Power).

Returns:

    number # The Runic Power deficit.
Player:RunicPowerDeficitPercentage ()
Returns the Runic Power deficit as a percentage of maximum Runic Power.

Returns:

    number # The Runic Power deficit percentage.
Player:Rune ()
Returns the number of ready runes the player has.

Returns:

    number # The count of ready runes.
Player:RuneTimeToX (value)
Returns the cooldown until the 'value'th rune becomes available.

Parameters:

  • value number # The Nth rune to check for (e.g., 1 for the first, 2 for the second).

Returns:

    number # The cooldown in seconds until the Nth rune is ready.
Player:SoulShardsMax ()
Returns the maximum Soul Shards of the player.

Returns:

    number # The maximum Soul Shards.
Player:SoulShards ()
Returns the current Soul Shards of the player.

Returns:

    number # The current Soul Shards.
Player:SoulShardsP ()
Returns the current Soul Shards of the player (alias for SoulShards()).

Returns:

    number # The current Soul Shards.
Player:SoulShardsDeficit ()
Returns the Soul Shards deficit (maximum Soul Shards minus current Soul Shards).

Returns:

    number # The Soul Shards deficit.
Player:AstralPowerMax ()
Returns the maximum Astral Power of the player.

Returns:

    number # The maximum Astral Power.
Player:AstralPower (overrideFutureAstralPower)
Returns the current Astral Power of the player, with an optional override for future power.

Parameters:

  • overrideFutureAstralPower number|nil # An optional value to override the current Astral Power.

Returns:

    number # The current Astral Power.
Player:AstralPowerPercentage (overrideFutureAstralPower)
Returns the current Astral Power as a percentage of maximum Astral Power, with an optional override.

Parameters:

  • overrideFutureAstralPower number|nil # An optional value to override the current Astral Power.

Returns:

    number # The current Astral Power percentage.
Player:AstralPowerDeficit (overrideFutureAstralPower)
Returns the Astral Power deficit (maximum Astral Power minus current Astral Power), with an optional override.

Parameters:

  • overrideFutureAstralPower number|nil # An optional value to override the current Astral Power.

Returns:

    number # The Astral Power deficit.
Player:AstralPowerDeficitPercentage (overrideFutureAstralPower)
Returns the Astral Power deficit as a percentage of maximum Astral Power, with an optional override.

Parameters:

  • overrideFutureAstralPower number|nil # An optional value to override the current Astral Power.

Returns:

    number # The Astral Power deficit percentage.
Player:HolyPowerMax ()
Returns the maximum Holy Power of the player.

Returns:

    number # The maximum Holy Power.
Player:HolyPower ()
Returns the current Holy Power of the player.

Returns:

    number # The current Holy Power.
Player:HolyPowerPercentage ()
Returns the current Holy Power as a percentage of maximum Holy Power.

Returns:

    number # The current Holy Power percentage.
Player:HolyPowerDeficit ()
Returns the Holy Power deficit (maximum Holy Power minus current Holy Power).

Returns:

    number # The Holy Power deficit.
Player:HolyPowerDeficitPercentage ()
Returns the Holy Power deficit as a percentage of maximum Holy Power.

Returns:

    number # The Holy Power deficit percentage.
Player:MaelstromMax ()
11 | Maelstrom Functions -- Returns the maximum Maelstrom of the player.

Returns:

    number # The maximum Maelstrom.
Player:Maelstrom ()
Returns the current Maelstrom of the player.

Returns:

    number # The current Maelstrom.
Player:MaelstromPercentage ()
Returns the current Maelstrom as a percentage of maximum Maelstrom.

Returns:

    number # The current Maelstrom percentage.
Player:MaelstromDeficit ()
Returns the Maelstrom deficit (maximum Maelstrom minus current Maelstrom).

Returns:

    number # The Maelstrom deficit.
Player:MaelstromDeficitPercentage ()
Returns the Maelstrom deficit as a percentage of maximum Maelstrom.

Returns:

    number # The Maelstrom deficit percentage.
Player:ChiMax ()
Returns the maximum Chi of the player.

Returns:

    number # The maximum Chi.
Player:Chi ()
Returns the current Chi of the player.

Returns:

    number # The current Chi.
Player:ChiPercentage ()
Returns the current Chi as a percentage of maximum Chi.

Returns:

    number # The current Chi percentage.
ChiDeficit ()
Returns the player's current Chi deficit (ChiMax - Chi).

Returns:

    number The current Chi deficit.
ChiDeficitPercentage ()
Returns the player's current Chi deficit as a percentage of maximum Chi.

Returns:

    number The Chi deficit percentage.
StaggerMax ()
Returns the player's maximum Stagger amount.

Returns:

    number The maximum Stagger amount.
Stagger ()
Returns the player's current Stagger amount.

Returns:

    number The current Stagger amount.
StaggerPercentage ()
Returns the player's current Stagger as a percentage of maximum Stagger.

Returns:

    number The Stagger percentage.
InsanityMax ()
Returns the player's maximum Insanity.

Returns:

    number The maximum Insanity.
Insanity ()
Returns the player's current Insanity.

Returns:

    number The current Insanity.
InsanityPercentage ()
Returns the player's current Insanity as a percentage of maximum Insanity.

Returns:

    number The Insanity percentage.
InsanityDeficit ()
Returns the player's current Insanity deficit (InsanityMax - Insanity).

Returns:

    number The current Insanity deficit.
InsanityDeficitPercentage ()
Returns the player's current Insanity deficit as a percentage of maximum Insanity.

Returns:

    number The Insanity deficit percentage.
InsanityDrain ()
Returns the player's Insanity drain per second.

Returns:

    number The Insanity drain.
ArcaneChargesMax ()
Returns the player's maximum Arcane Charges.

Returns:

    number The maximum Arcane Charges.
ArcaneCharges ()
Returns the player's current Arcane Charges.

Returns:

    number The current Arcane Charges.
ArcaneChargesPercentage ()
Returns the player's current Arcane Charges as a percentage of maximum Arcane Charges.

Returns:

    number The Arcane Charges percentage.
ArcaneChargesDeficit ()
Returns the player's current Arcane Charges deficit (ArcaneChargesMax - ArcaneCharges).

Returns:

    number The current Arcane Charges deficit.
ArcaneChargesDeficitPercentage ()
Returns the player's current Arcane Charges deficit as a percentage of maximum Arcane Charges.

Returns:

    number The Arcane Charges deficit percentage.
FuryMax ()
Returns the player's maximum Fury.

Returns:

    number The maximum Fury.
Fury ()
Returns the player's current Fury.

Returns:

    number The current Fury.
FuryPercentage ()
Returns the player's current Fury as a percentage of maximum Fury.

Returns:

    number The Fury percentage.
FuryDeficit ()
Returns the player's current Fury deficit (FuryMax - Fury).

Returns:

    number The current Fury deficit.
FuryDeficitPercentage ()
Returns the player's current Fury deficit as a percentage of maximum Fury.

Returns:

    number The Fury deficit percentage.
PainMax ()
Returns the player's maximum Pain.

Returns:

    number The maximum Pain.
Pain ()
Returns the player's current Pain.

Returns:

    number The current Pain.
PainPercentage ()
Returns the player's current Pain as a percentage of maximum Pain.

Returns:

    number The Pain percentage.
PainDeficit ()
Returns the player's current Pain deficit (PainMax - Pain).

Returns:

    number The current Pain deficit.
PainDeficitPercentage ()
Returns the player's current Pain deficit as a percentage of maximum Pain.

Returns:

    number The Pain deficit percentage.
EssenceMax ()
Returns the player's maximum Essence.

Returns:

    number The maximum Essence.
Essence ()
Returns the player's current Essence.

Returns:

    number The current Essence.
EssenceDeficit ()
Returns the player's current Essence deficit (EssenceMax - Essence).

Returns:

    number The current Essence deficit.
EmpowerStageDuration (number)
Returns the duration of a specific Empower stage for the player.

Parameters:

  • number stage The Empower stage to get the duration for.

Returns:

    number The duration of the Empower stage.
EmpowerStage (number)
Checks if the player has reached a specific Empower stage.

Parameters:

  • number stage The Empower stage to check.

Returns:

    boolean True if the stage is reached, false otherwise.
generated by LDoc 1.5.0 Last updated 2025-08-07 15:27:51