Module br.player.ui
These functions help in retrieving information about or manipulating UI elements.
UI functions are stored in br.player.ui and can be utilized by `local ui = br.player.ui` in your profile.
Functions
| ui.alwaysCdNever (thisOption) | Checks if the passed option is set to "Always, CD, or Never" |
| ui.alwaysCdAoENever (thisOption[, minUnits=3[, enemyCount]]) | Checks if the passed option is set to "Always, AOE/CD, CD, or Never" |
| ui.chatOverlay (text) | Displays the passed text as an overlay on the chat windows |
| ui.checked (thisOption[, optionPage]) | Checks if the passed option is enabled |
| ui.debug (text) | Displays the text as a debug message in chat (if Addon Debug Messages option is enabled) |
| ui.delay (delayName, delayTime) | Returns false unless the specified delay time has passed since it was last true |
| ui.fullBags () | Checks if your bags are full |
| ui.isMouseDown ([mouseButton]) | Checks if the mouse button specified is down, or any if none are specified |
| ui.pause () | Returns true if special conditions are met to pause |
| ui.print (msg) | Shows the specified message in chat. |
| ui.pullTimer () | Returns the time remaining on the pull timer (DBM/BigWigs) |
| ui.time () | Returns the time, value of GetTime |
| ui.timer (timerName, interval) | Returns false unless the specified interval has passed since it was last true |
| ui.toggle (thisToggle) | Checks if the specified toggle from the toggle options is pressed |
| ui.useAOE ([range=8[, minCount=3[, useTarget="player"]]]) | Checks if the specified parameters are valid for AOE, based on Rotation toggle setting. |
| ui.useCDs () | Check if Cooldowns should be used or not based on CD toggle setting. |
| ui.useDefensive () | Check if Defensives should be used or not based on Defensive toggle setting. |
| ui.useInterrupt () | Check if Interrupts should be used or not based on Interrupt toggle setting. |
| ui.useST ([range=8[, minCount=3[, useTarget="player"]]]) | Checks if the specified parameters are valid for Single Target, based on Rotation toggle setting. |
| ui.useTrinkets (trinket) | Checks if the option to use trinkets are valid per each Trinket slot. |
| ui.value (thisOption[, optionPage]) | Returns the value of the specified option. |
Functions
- ui.alwaysCdNever (thisOption)
-
Checks if the passed option is set to "Always, CD, or Never"
Parameters:
- thisOption string - Name of the option from the defined profile options.
Returns:
-
boolean - Returns true if the option is set to Always or if CD is selected and CDs are enabled
- ui.alwaysCdAoENever (thisOption[, minUnits=3[, enemyCount]])
-
Checks if the passed option is set to "Always, AOE/CD, CD, or Never"
Parameters:
- thisOption string - Name of the option from the defined profile options.
- minUnits number - Minimum Number of units to count for AOE checks. (default 3)
- enemyCount number - Number of enemies for a given range, default is the number of enemies in 40yrds. (optional)
Returns:
-
boolean - Returns true based on selected option and current combat conditions
- ui.chatOverlay (text)
-
Displays the passed text as an overlay on the chat windows
Parameters:
- text string - The text to display.
Returns:
-
nil
- ui.checked (thisOption[, optionPage])
-
Checks if the passed option is enabled
Parameters:
- thisOption string - Name of the option from the defined profile options.
- optionPage string - The page where the option is located. (optional)
Returns:
-
boolean - Returns true if the option is checked
- ui.debug (text)
-
Displays the text as a debug message in chat (if Addon Debug Messages option is enabled)
Parameters:
- text string - The message to show in chat.
Returns:
-
nil
- ui.delay (delayName, delayTime)
-
Returns false unless the specified delay time has passed since it was last true
Parameters:
- delayName string - The name of the delay check, should be unique.
- delayTime number - The length of time to wait until true, in seconds.
Returns:
-
boolean - Returns true if the delay time has passed
- ui.fullBags ()
-
Checks if your bags are full
Returns:
-
boolean - Returns true if bags are full
- ui.isMouseDown ([mouseButton])
-
Checks if the mouse button specified is down, or any if none are specified
Parameters:
- mouseButton string - Name of the mouse button. (optional)
Returns:
-
boolean - Returns true if the specified mouse button is down
- ui.pause ()
-
Returns true if special conditions are met to pause
Returns:
-
boolean - Returns true if rotation should be paused
See also:
- ui.print (msg)
-
Shows the specified message in chat.
Parameters:
- msg string - The message to show in chat.
Returns:
-
nil
- ui.pullTimer ()
-
Returns the time remaining on the pull timer (DBM/BigWigs)
Returns:
-
number - Returns seconds remaining on pull timer
- ui.time ()
-
Returns the time, value of GetTime
Returns:
-
number - Returns the current game time
- ui.timer (timerName, interval)
-
Returns false unless the specified interval has passed since it was last true
Parameters:
- timerName string - The name of the timer check, should be unique.
- interval number - The length of time to wait until true, in seconds.
Returns:
-
boolean - Returns true if the interval has passed
- ui.toggle (thisToggle)
-
Checks if the specified toggle from the toggle options is pressed
Parameters:
- thisToggle string - Name of the toggle to check.
Returns:
-
boolean - Returns true if the toggle is active
- ui.useAOE ([range=8[, minCount=3[, useTarget="player"]]])
-
Checks if the specified parameters are valid for AOE, based on Rotation toggle setting.
Parameters:
- range number - The range of the AOE damage in yards. (default 8)
- minCount number - The minimum number of units to be in range before true (default 3)
- useTarget string - the reference unit to check range and units against. (default "player")
Returns:
-
boolean - Returns true if AOE should be used
- ui.useCDs ()
-
Check if Cooldowns should be used or not based on CD toggle setting.
Returns:
-
boolean - Returns true if cooldowns should be used
- ui.useDefensive ()
-
Check if Defensives should be used or not based on Defensive toggle setting.
Returns:
-
boolean - Returns true if defensive abilities should be used
- ui.useInterrupt ()
-
Check if Interrupts should be used or not based on Interrupt toggle setting.
Returns:
-
boolean - Returns true if interrupts should be used
- ui.useST ([range=8[, minCount=3[, useTarget="player"]]])
-
Checks if the specified parameters are valid for Single Target, based on Rotation toggle setting.
Parameters:
- range number - The range of the AOE damage in yards. (default 8)
- minCount number - The minimum number of units to be in range before true (default 3)
- useTarget string - the reference unit to check range and units against. (default "player")
Returns:
-
boolean - Returns true if single target abilities should be used
- ui.useTrinkets (trinket)
-
Checks if the option to use trinkets are valid per each Trinket slot.
Parameters:
- trinket number - The item id of the trinket to check for.
Returns:
-
boolean - Returns true if the trinket should be used
- ui.value (thisOption[, optionPage])
-
Returns the value of the specified option.
Parameters:
- thisOption string - The name of the option specified in the options section
- optionPage string - The page where the option is located. (optional)
Returns:
-
number - Returns the value of the specified option