Merge branch 'master' of https://github.com/CuteOne/BadRotations

Author: BrewingCoder

Diff for: .github/workflows/lintPR.yaml

@@ -82,7 +82,6 @@ jobs:
         check_name: Luacheck Report
         comment_mode: always
         action_fail: true
-        fail_on: 'errors'
 
 # name: Luacheck
 # on: [push, pull_request]

Diff for: .luacheckrc

@@ -5,17 +5,17 @@ exclude_files = {
 	"**/Libs",
 	"**/Unlockers",
 }
--- only = {
--- 	"011", -- syntax
--- 	"1", -- globals
--- }
+only = {
+	"011", -- syntax
+	"1", -- globals
+}
 ignore = {
 	"11/SLASH_.*", -- slash handlers
 	"1/[A-Z][A-Z][A-Z0-9_]+", -- three letter+ constants
-	"211", -- unused local variables
-	"212", -- unused arguments
-	"213", -- unused loop variable
-	"542", -- empty if branches
+	-- "211", -- unused local variables
+	-- "212", -- unused arguments
+	-- "213", -- unused loop variable
+	-- "542", -- empty if branches
 }
 globals = {
 	"br",

Diff for: System/API/CD.lua

@@ -3,19 +3,24 @@
 -- CD functions are stored in br.player.cd and can be utilized by `local cd = br.player.cd` in your profile.
 -- For spell CDs, `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 CDs, `item` in the function represent the name in the item list defined in System/List/Items.lua
+-- For slot CDs, `slot` in the function represents equipement slots, pass the ID matching the equipement slot id you wish to check.
 -- @module br.player.cd
 local _, br = ...
 
 if br.api == nil then br.api = {} end
 
 br.api.cd = function(self,spell,id)
-    if self.cd == nil then self.cd = {} end
-    if self.cd[spell] == nil then self.cd[spell] = {} end
+    self.cd = self.cd or {}
     local cd = self.cd
 
+    --- Spell Cooldown Functions - [spell] denotes placeholder for name of spell listed in System/Lists/Spells.lua
+    -- @section cd[spell]
+    cd[spell] = cd[spell] or {}
+
     --- Checks if spell is on cooldown or not.
     -- @function cd.spell.exists
-    -- @treturn boolean
+    -- @return boolean
+    -- @within cd.spell
     cd[spell].exists = function()
         local level = br._G.UnitLevel("player")
         local spellLevel = br._G.GetSpellLevelLearned(id)
@@ -25,7 +30,8 @@ br.api.cd = function(self,spell,id)
 
     --- Gets the time remaining on spell cooldown or 0 if not.
     -- @function cd.spell.remain
-    -- @treturn number
+    -- @return number
+    -- @within cd.spell
     cd[spell].remain = function()
         local level = br._G.UnitLevel("player")
         local spellLevel = br._G.GetSpellLevelLearned(id)
@@ -35,7 +41,8 @@ br.api.cd = function(self,spell,id)
 
     --- Gets the time remaining on spell cooldown or 0 if not (alternate to cd.spell.remain() incase of typo).
     -- @function cd.spell.remains
-    -- @treturn number
+    -- @return number
+    -- @within cd.spell
     cd[spell].remains = function()
         local level = br._G.UnitLevel("player")
         local spellLevel = br._G.GetSpellLevelLearned(id)
@@ -45,15 +52,17 @@ br.api.cd = function(self,spell,id)
 
     --- Gets the total time of the spell cooldown
     -- @function cd.spell.duration
-    -- @treturn number
+    -- @return number
+    -- @within cd.spell
     cd[spell].duration = function()
         local _, CD = br._G.GetSpellCooldown(id)
         return CD
     end
 
     --- Checks if the spell is not on cooldown or is (opposite of cd.spell.exists()).
     -- @function cd.spell.ready
-    -- @treturn boolean
+    -- @return boolean
+    -- @within cd.spell
     cd[spell].ready = function()
         local level = br._G.UnitLevel("player")
         local spellLevel = br._G.GetSpellLevelLearned(id)
@@ -63,67 +72,70 @@ br.api.cd = function(self,spell,id)
 
     --- Gets the duration of the spells Global Cooldown.
     -- @function cd.spell.prevgcd
-    -- @treturn number
+    -- @return number
+    -- @within cd.spell
     cd[spell].prevgcd = function()
         return select(2, br._G.GetSpellBaseCooldown(id))
     end
 end
 
 br.api.itemCD = function(self,item,id)
-    if self[item] == nil then self[item] = {} end
+    --if self[item] == nil then self[item] = {} end
     local cd = self
 
+    --- Item Cooldown Functions - [item] denotes placeholder for name of item listed in System/Lists/Items.lua
+    -- @section cd[item]
+    cd[item] = cd[item] or {}
+
     --- Checks if item is on cooldown or not.
     -- @function cd.item.exists
-    -- @number[opt] itemID The ID of the item to check.
-    -- @treturn boolean
-    cd[item].exists = function(itemID)
-        if itemID == nil then itemID = id end
-        return br._G.GetItemCooldown(itemID) > 0
+    -- @return boolean
+    -- @within cd.item
+    cd[item].exists = function()
+        return br._G.GetItemCooldown(id) > 0
     end
 
     --- Gets the time remaining on item cooldown or 0 if not.
     -- @function cd.item.remain
-    -- @number[opt] itemID The ID of the item to check.
-    -- @treturn number
-    cd[item].remain = function(itemID)
-        if itemID == nil then itemID = id end
-        if br._G.GetItemCooldown(itemID) ~= 0 then
-            return (br._G.GetItemCooldown(itemID) + select(2,br._G.GetItemCooldown(itemID)) - br._G.GetTime())
+    -- @return number
+    -- @within cd.item
+    cd[item].remain = function()
+        if br._G.GetItemCooldown(id) ~= 0 then
+            return (br._G.GetItemCooldown(id) + select(2,br._G.GetItemCooldown(id)) - br._G.GetTime())
         end
         return 0
     end
 
     --- Gets the total cooldown time of the item in seconds.
     -- @function cd.item.duration
-    -- @number[opt] itemID The ID of the item to check.
-    -- @treturn number
-    cd[item].duration = function(itemID)
-        if itemID == nil then itemID = id end
-        return br._G.GetSpellBaseCooldown(select(2,br._G.GetItemSpell(itemID))) / 1000
+    -- @return number
+    -- @within cd.item
+    cd[item].duration = function()
+        return br._G.GetSpellBaseCooldown(select(2,br._G.GetItemSpell(id))) / 1000
     end
 
+    --- Equipment Slot Cooldown Functions
+    -- @section cd.slot
     cd.slot = cd.slot or {}
 
-    --- This function gets the base cooldown of a given item spell
-    -- from an inventory slot, specific to the player character in game.
-    -- @usage cd.slot.duration() or cd.slot.duration(slotID)
-    -- @tparam[opt=id] number slotID The ID of the inventory slot. If not provided, the default is 'id'.
-    -- @treturn number The base cooldown of the item spell divided by 1000.
+    --- This function gets the base cooldown of a given item spell from an inventory slot, specific to the player character in game.
+    -- @param slotID - The ID of the inventory slot.
+    -- @return number - The base cooldown of the item spell divided by 1000.
     -- This division is done to convert the time from milliseconds to seconds.
     -- @within cd.slot
     cd.slot.duration = function(slotID)
-        if slotID == nil then slotID = id end
+        if slotID == nil then return nil end
         local _, duration = br._G.GetInventoryItemCooldown("player", slotID)
         return duration
     end
 
     --- Gets the time remaining on the equipment slot item cooldown or 0 if not.
     -- @function cd.slot.remain
-    -- @number[opt] slotID The ID of the equipment slot to check.
-    -- @treturn number
+    -- @param slotID - The ID of the equipment slot to check.
+    -- @return number
+    -- @within cd.slot
     cd.slot.remain = function(slotID)
-        if slotID == nil then slotID = id end
+        if slotID == nil then return nil end
         local start, duration, enable = br._G.GetInventoryItemCooldown("player", slotID)
         if enable == 0 or duration == 0 then
             return 0 -- No cooldown is active, or the item has no cooldown

Diff for: System/API/Charges.lua

@@ -13,14 +13,14 @@ br.api.charges = function(self,spell,id)
 
     --- Checks if spell has charges or not.
     -- @function charges.spell.exists
-    -- @treturn boolean
+    -- @return boolean
     charges.exists = function()
         return br.getCharges(id) >= 1
     end
 
     --- Gets the number of charges remaining on spell.
     -- @function charges.spell.count
-    -- @treturn number
+    -- @return number
     charges.count = function()
         return br.getCharges(id)
     end
@@ -31,22 +31,22 @@ br.api.charges = function(self,spell,id)
 
     --- Gets the number of charges remaining on spell as a fraction. (e.g. 1.5 charges remaining)
     -- @function charges.spell.frac
-    -- @treturn number
+    -- @return number
     charges.frac = function()
         return br.getChargesFrac(id)
     end
 
     --- Gets the maximum number of charges the spell can have.
     -- @function charges.spell.max
-    -- @treturn number
+    -- @return number
     charges.max = function()
         return br.getChargesFrac(id,true)
     end
 
     --- Gets the time remaining on until next charge is available.
     -- @function charges.spell.remain
     -- @bool[opt] chargeMax If true, returns the time remaining until all charges are available.
-    -- @treturn number
+    -- @return number
     charges.recharge = function(chargeMax)
         if chargeMax then
             return br.getRecharge(id,true)
@@ -57,7 +57,7 @@ br.api.charges = function(self,spell,id)
 
     --- Gets the total time remaining until all charges are available.
     -- @function charges.spell.timeTillFull
-    -- @treturn number
+    -- @return number
     charges.timeTillFull = function()
         return br.getFullRechargeTime(id)
     end
@@ -69,14 +69,14 @@ br.api.itemCharges = function(self,item,id)
 
     --- Checks if item has charges or not.
     -- @function charges.item.exists
-    -- @treturn boolean
+    -- @return boolean
     charges.exists = function()
         return br.itemCharges(id) > 0
     end
 
     --- Gets the number of charges remaining on item.
     -- @function charges.item.count
-    -- @treturn number
+    -- @return number
     charges.count = function()
         return br.itemCharges(id)
     end

Diff for: System/API/Conduit.lua

@@ -35,6 +35,7 @@ br.api.conduit = function(conduit,spell,id)
         local spellName, _, spellIcon, _, _, _, spellID = br._G.GetSpellInfo(id)
 
         --- Gets information about a specific conduit.
+        -- @table conduit.spell
         -- @field state The current state of the conduit. Default is `0`.
         -- @field icon The icon associated with the conduit, represented by the spell icon.
         -- @field row The row in which the conduit is located. Default is `0`.
@@ -43,7 +44,6 @@ br.api.conduit = function(conduit,spell,id)
         -- @field rank The rank of the conduit. Currently set to default `0`.
         -- @field id The unique identifier for the spell associated with the conduit.
         -- @field enabled A boolean indicating whether the conduit is enabled. Default is `false`.
-        -- @table conduit.spell
         conduit[spell] = {
             state = 0,
             icon = spellIcon,

Diff for: System/API/Debuff.lua

@@ -274,6 +274,10 @@ br.api.debuffs = function(debuff,k,v)
         return (spec == 103 or spec == 259) and debuff.bleed[thisUnit] or 0
     end
 
+    --- Gets the number of debuff ticks that will be gained by reapplying the debuff to the specified unit.
+    -- @function debuff.spell.ticksGainedOnRefresh
+    -- string[opt="target"] thisUnit The unit to check the ticks gained by reapplying the debuff on.
+    -- @treturn number
     debuff.ticksGainedOnRefresh = function(thisUnit)
         local name, _, _, _, duration, expirationTime = br.UnitDebuffID(thisUnit, v, nil, "PLAYER")
         local haste = br._G.UnitSpellHaste("player")

Diff for: System/API/Enemies.lua

@@ -34,7 +34,7 @@ local function setVariable(self,unit,range,checkNoCombat,facing,type,table,count
     -- Build enemies.yards variable
     local insertTable = "yards"..range..type -- Ex: enemies.yards8 (returns all enemies around player in 8yrds), Adds Table Type (r for Rect, c for Cone, blank for Normal)
     if unit ~= "player" then
-        -- letter tag on end based on type of unit passed, if target or enemy unit then "t" otherwise first letter of what is passed in: f - "focus", p - "pet", m - "mouseover", etc 
+        -- letter tag on end based on type of unit passed, if target or enemy unit then "t" otherwise first letter of what is passed in: f - "focus", p - "pet", m - "mouseover", etc
         if br.units[unit] ~= nil then
             insertTable = insertTable.."t" -- Ex: enemies.yards8t (returns all enemies around target in 8yrds)
         else
@@ -47,7 +47,8 @@ local function setVariable(self,unit,range,checkNoCombat,facing,type,table,count
     if count > 0 then br.insertTableIntoTable(self.enemies[insertTable],table) end
 end
 br.api.enemies = function(self)
-    local enemies = self.enemies
+    ---@class self.enemies
+    local enemies --= self.enemies
     if enemies.cone == nil then enemies.cone = {} end
     if enemies.rect == nil then enemies.rect = {} end
 

Diff for: System/API/Equiped.lua

@@ -12,7 +12,7 @@ br.api.equiped = function(self,item,id)
     local equiped = self
 
     --- Checks if item is equiped or not.
-    -- @function equiped.item.exists
+    -- @function equiped.item
     -- @number[opt] slotID The equipment slot number to check.
     -- @treturn boolean
     equiped[item] = function(slotID)
@@ -27,8 +27,7 @@ br.api.equiped = function(self,item,id)
     -- It can also check a specific slotID.
     -- If no slotID is provided, it checks all slots for that item.
     -- @param itemID the ID of the item you want to check if it's equipped
-    -- @param slotID optional parameter. If specified, it represents the ID
-    -- of the slot you want to check for the existence of the given item.
+    -- @param slotID optional parameter. If specified, it represents the ID of the slot you want to check for the existence of the given item.
     -- @return boolean value indicating whether the item with specific ID is equipped in the specified slot (if provided)
     -- @usage equipes.item(12345) -- will return true if item with ID 12345 is equipped anywhere
     -- @usage equipes.item(12345, 1) -- will return true if item with ID 12345 is equipped in slot 1

Diff for: System/API/Essence.lua

@@ -18,7 +18,7 @@
 --
 -- * `br.player.essence.spellID` - Indicates the spellID of the essence.
 --
--- @module br.player.covenant
+-- @module br.player.essence
 local _, br = ...
 if br.api == nil then br.api = {} end
 br.api.essences = function(essence,k,v)

Diff for: System/API/Item.lua

@@ -1,8 +1,8 @@
----
--- These functions help in retrieving information about items.
--- Item functions are stored in br.player.item and can be utilized by `local item = br.player.item` in your profile.
--- `item` in the function represent the name in the item list defined in System/List/Items.lua
--- @module br.player.item
+-- ---
+-- -- These functions help in retrieving information about items.
+-- -- Item functions are stored in br.player.item and can be utilized by `local item = br.player.item` in your profile.
+-- -- `item` in the function represent the name in the item list defined in System/List/Items.lua
+-- -- @module br.player.item
 
 local _, br = ...
 if br.api == nil then br.api = {} end