Module br.player.module

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

Module functions are stored in br.player.module and can be utilized by `local module = br.player.module` in your profile. 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

module.getOption (option, optionType) Get perform the correct check for the provided option and option type checking for "Rotation Option" option before defaulting to "Base Options"
module.autoKeystone ([section]) Auto Put Keystone into Receptable during mythic+ dungeons.
module.BasicHealing ([section]) Basic Healing Module - Uses healthstones, potions, and racial healing abilities.
module.BasicTrinkets ([slotID[, section]]) Basic Trinkets - Uses trinkets based on options set in the Profile Options.
module.CombatPotionUp ([section]) CombatPotionUp Module - Attempts to use the combat potion specified in the Profile Options.
module.PhailUp ([section]) PhialUp Module - Attmpts to use the phial specified in the Profile Options
module.ImbueUp ([section]) ImbueUp Module - Attmpts to use the weapon imbuement specified in the Profile Options
module.FlaskUp (buffType[, section]) FlaskUp Module - Attempts to use the flask specified in the Profile Options.


Functions

module.getOption (option, optionType)
Get perform the correct check for the provided option and option type checking for "Rotation Option" option before defaulting to "Base Options"

Parameters:

  • option string Name of the option to check.
  • optionType string Type of option check to perform
module.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)
module.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)
module.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)
module.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)
module.PhailUp ([section])
PhialUp Module - Attmpts to use the phial 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)
module.ImbueUp ([section])
ImbueUp Module - Attmpts to use the weapon imbuement 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)
module.FlaskUp (buffType[, section])
FlaskUp Module - Attempts to use the flask specified in the Profile Options.

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)
generated by LDoc 1.5.0 Last updated 2024-11-26 17:42:33