Module module

These functions helpful functions for commonly used features in all profiles.

Module functions are the profile API table `module` (br.api.profile.module); profiles use it by name. Additionally module functions also have custom options you can add to your Profile Options by calling the function in the Profile Options and passing the section param.

Functions

autoKeystone ([section]) Auto Put Keystone into Receptable during mythic+ dungeons.
BasicHealing ([section]) Basic Healing Module - Uses healthstones, potions, and racial healing abilities.
BasicTrinkets ([slotID[, section]]) Basic Trinkets - Uses trinkets based on options set in the Profile Options.
CombatPotionUp ([section]) CombatPotionUp Module - Attempts to use the combat potion specified in the Profile Options.
FlaskUp (buffType[, section]) FlaskUp Module - Attempts to use the flask specified in the Profile Options (Mists of Pandaria).
RacialStun () War Stomp just before a cast-time heal on yourself, so the heal lands while what's hitting you is stunned (no pushback).
Racial ([section[, thisUnit]]) Racial Module - Uses the player's racial abilities based on the options set in the Profile Options.
TwoForms ([section]) Two Forms Module - Return Worgen to Human Form out of combat


Functions

autoKeystone ([section])
Auto Put Keystone into Receptable during mythic+ dungeons. | Kinky BR Module Code example

Parameters:

  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
BasicHealing ([section])
Basic Healing Module - Uses healthstones, potions, and racial healing abilities.

Parameters:

  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
BasicTrinkets ([slotID[, section]])
Basic Trinkets - Uses trinkets based on options set in the Profile Options.

Parameters:

  • slotID number If set will use the trinket in the specified slot. Otherwise, will loop through all trinkets. (optional)
  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
CombatPotionUp ([section])
CombatPotionUp Module - Attempts to use the combat potion specified in the Profile Options.

Parameters:

  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
FlaskUp (buffType[, section])
FlaskUp Module - Attempts to use the flask specified in the Profile Options (Mists of Pandaria).

Parameters:

  • buffType string The type of flask to use. (e.g. "Agility", "Intellect", "Stamina", "Strength")
  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
RacialStun ()
War Stomp just before a cast-time heal on yourself, so the heal lands while what's hitting you is stunned (no pushback). Tauren only; needs the Racial module's "Use Racial" ticked and an enemy within 8 yd attacking you. A profile calls it right before casting the heal; it doesn't count as the profile handling racials.

Returns:

    boolean True when War Stomp was cast

Usage:

    if hpLow and module.RacialStun() then return true end -- then the heal, next tick
Racial ([section[, thisUnit]])
Racial Module - Uses the player's racial abilities based on the options set in the Profile Options. Uses the race's named racial (e.g. cast.stoneform) when the expansion defines one, otherwise cast.racial. On Classic-era expansions cast.racial only maps damage racials, so the named key matters there. Damage racials (Orc, Troll, and Forever's Night Elf / Gnome) use the "Damage Racial" dropdown.

Parameters:

  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
  • thisUnit string Unit to use the racial on (Quaking Palm requires it). (optional)
TwoForms ([section])
Two Forms Module - Return Worgen to Human Form out of combat

Parameters:

  • section boolean If set will generate the options for this module in the Profile Options. Otherwise, will run the module. (optional)
generated by LDoc 1.5.0 Last updated 2026-11-16 01:18:17