More types

Reviewed-on: Bastion/Bastion#9

.gitignore

@@ -7,7 +7,11 @@ DS_Store
 
 ## ignore all files in scripts
 scripts/*
+!scripts/Libraries
+scripts/Libraries/*
 !scripts/.gitkeep
+!scripts/ExampleModule.lua
+!scripts/Libraries/ExampleLibrary.lua
 
 ## ignore vscode settings
 .vscode/*

scripts/ExampleModule.lua

@@ -0,0 +1,17 @@
+local Tinkr, Bastion = ...
+local ExampleModule = Bastion.Module:New('ExampleModule')
+local Player = Bastion.UnitManager:Get('player')
+
+local FlashHeal = Bastion.SpellBook:GetSpell(2061)
+
+local AdvancedMath = Bastion:GetLibrary('AdvancedMath')
+
+print(AdvancedMath:Add(1, 2))
+
+ExampleModule:Sync(function()
+    if Player:GetHP() <= 50 then
+        FlashHeal:Cast(Player)
+    end
+end)
+
+Bastion:Register(ExampleModule)

scripts/Libraries/ExampleLibrary.lua

@@ -0,0 +1,14 @@
+local Tinkr, Bastion = ...
+
+local ExampleModule = Bastion.Module:New('ExampleModule')
+local Player = Bastion.UnitManager:Get('player')
+
+local AdvancedMath = {}
+
+AdvancedMath.__index = AdvancedMath
+
+function AdvancedMath:Add(a, b)
+    return a + b
+end
+
+Bastion:RegisterLibrary('AdvancedMath', AdvancedMath)

src/AuraTable/AuraTable.lua

@@ -275,7 +275,6 @@ function AuraTable:Find(spell)
     end
 
     for k, a in pairs(aurasub) do
-        print(a)
         if a ~= nil then
             if a:IsUp() then -- Handle expired and non refreshed dropoffs not coming in UNIT_AURA
                 return a

src/Class/Class.lua

@@ -18,12 +18,21 @@ function Class:__index(k)
     return response
 end
 
+---@class Class
+---@field class Class.class
+
+---@class Class.class
+---@field locale string
+---@field name string
+---@field id number
+
 -- Constructor
 ---@param locale string
 ---@param name string
 ---@param id number
 function Class:New(locale, name, id)
     local self = setmetatable({}, Class)
+
     self.class = {
         locale = locale,
         name = name,
@@ -50,10 +59,16 @@ function Class:GetID()
     return self.class.id
 end
 
+---@class ColorMixin
+---@field r number
+---@field g number
+---@field b number
+
 -- Return the classes color
 ---@return ColorMixin classColor
 function Class:GetColor()
     return C_ClassColor.GetClassColor(self.class.name)
 end
 
+
 return Class

src/Command/Command.lua

@@ -1,6 +1,13 @@
 -- Create a wow command handler class
 ---@class Command
+---@field command string
+---@field commands Command.commands[]
 local Command = {}
+
+---@class Command.commands
+---@field helpmsg string
+---@field cb fun(args: table)
+
 Command.__index = Command
 
 ---@return string

src/List/List.lua

@@ -1,5 +1,3 @@
-local Tinkr, Bastion = ...
-
 ---@class List
 local List = {
     -- Add overload
@@ -144,7 +142,7 @@ function List:findIndex(callback)
     return nil
 end
 
----@param callback fun(value: any): boolean
+---@param callback fun(...): boolean
 ---@return nil
 function List:sort(callback)
     table.sort(self._list, callback)

src/MythicPlusUtils/MythicPlusUtils.lua

@@ -17,6 +17,7 @@ MythicPlusUtils.__index = MythicPlusUtils
 function MythicPlusUtils:New()
     local self = setmetatable({}, MythicPlusUtils)
 
+    ---@diagnostic disable-next-line: assign-type-mismatch
     self.random = math.random(1000000, 9999999)
 
     self.aoeBosses = {
@@ -567,8 +568,4 @@ function MythicPlusUtils:IsAOEBoss(unit)
     return self.aoeBosses[unit:GetID()]
 end
 
-function MythicPlusUtils:IsTankBuster(spell)
-    return self.tankBusters[spell:GetID()]
-end
-
 return MythicPlusUtils

src/ObjectManager/ObjectManager.lua

@@ -1,6 +1,11 @@
 local Tinkr, Bastion = ...
 
 ---@class ObjectManager
+---@field _lists table
+---@field enemies List
+---@field friends List
+---@field activeEnemies List
+---@field explosives List
 local ObjectManager = {}
 ObjectManager.__index = ObjectManager
 
@@ -20,7 +25,7 @@ end
 -- Register a custom list with a callback
 ---@param name string
 ---@param cb function
----@return List
+---@return List | false
 function ObjectManager:RegisterList(name, cb)
     if self._lists[name] then
         return false

src/Unit/Unit.lua

@@ -505,7 +505,7 @@ end
 
 -- Check if unit is interruptible
 ---@param percent number
----@param ignoreInterruptible boolean
+---@param ignoreInterruptible? boolean
 ---@return boolean
 function Unit:IsInterruptibleAt(percent, ignoreInterruptible)
     if not ignoreInterruptible and not self:IsInterruptible() then
@@ -933,7 +933,6 @@ function Unit:IsStealthed()
     local Shadowmeld = Bastion.SpellBook:GetSpell(58984)
     local Sepsis = Bastion.SpellBook:GetSpell(328305)
 
-
     return self:GetAuras():FindAny(Stealth) or self:GetAuras():FindAny(ShadowDance)
 end
 
@@ -1107,6 +1106,7 @@ end
 ---@param Target Unit
 ---@param Angle number
 ---@param Distance number
+---@param rotation? number
 ---@return boolean
 function Unit:IsWithinCone(Target, Angle, Distance, rotation)
     if not Target:Exists() then
@@ -1114,7 +1114,7 @@ function Unit:IsWithinCone(Target, Angle, Distance, rotation)
     end
 
     local angle = self:GetAngle(Target)
-    local rotation = rotation or self:GetFacing()
+    rotation = rotation or self:GetFacing()
 
     local diff = math.abs(angle - rotation)
 

src/_bastion.lua

@@ -7,7 +7,7 @@ local Bastion = {
 Bastion.__index = Bastion
 
 function Bastion.require(class)
-    return Tinkr:require("scripts/bastion/src/" .. class .. "/" .. class, Bastion)
+    return require("scripts/bastion/src/" .. class .. "/" .. class, Bastion)
 end
 
 ---@type ClassMagic
@@ -62,7 +62,8 @@ Bastion.CombatTimer = Bastion.Timer:New('combat')
 Bastion.MythicPlusUtils = Bastion.require("MythicPlusUtils"):New()
 ---@type NotificationsList
 Bastion.Notifications = Bastion.NotificationsList:New()
-Bastion.modules = {}
+local LIBRARIES = {}
+local MODULES = {}
 Bastion.Enabled = false
 
 Bastion.EventManager:RegisterWoWEvent('UNIT_AURA', function(unit, auras)
@@ -132,6 +133,16 @@ Bastion.EventManager:RegisterWoWEvent("COMBAT_LOG_EVENT_UNFILTERED", function()
         end
     end
 end)
+
+function Bastion:RegisterLibrary(name, payload)
+    LIBRARIES[name] = payload
+    -- Bastion:Print("Registered Library", name)
+end
+
+function Bastion:GetLibrary(name)
+    return LIBRARIES[name]
+end
+
 Bastion.Ticker = C_Timer.NewTicker(0.1, function()
     if not Bastion.CombatTimer:IsRunning() and UnitAffectingCombat("player") then
         Bastion.CombatTimer:Start()
@@ -141,22 +152,22 @@ Bastion.Ticker = C_Timer.NewTicker(0.1, function()
 
     if Bastion.Enabled then
         Bastion.ObjectManager:Refresh()
-        for i = 1, #Bastion.modules do
-            Bastion.modules[i]:Tick()
+        for i = 1, #MODULES do
+            MODULES[i]:Tick()
         end
     end
 end)
 
 function Bastion:Register(module)
-    table.insert(Bastion.modules, module)
+    table.insert(MODULES, module)
     Bastion:Print("Registered", module)
 end
 
 -- Find a module by name
 function Bastion:FindModule(name)
-    for i = 1, #Bastion.modules do
-        if Bastion.modules[i].name == name then
-            return Bastion.modules[i]
+    for i = 1, #MODULES do
+        if MODULES[i].name == name then
+            return MODULES[i]
         end
     end
 
@@ -209,7 +220,9 @@ Command:Register('dumpspells', 'Dump spells to a file', function()
     while true do
         local spellName, spellSubName = GetSpellBookItemName(i, BOOKTYPE_SPELL)
         if not spellName then
-            do break end
+            do
+                break
+            end
         end
 
         -- use spellName and spellSubName here
@@ -264,11 +277,17 @@ Command:Register('missed', 'Dump the list of immune kidney shot spells', functio
     end
 end)
 
-local files = ListFiles("scripts/bastion/scripts")
+local function Load(dir)
+    local files = ListFiles(dir)
 
     for i = 1, #files do
         local file = files[i]
         if file:sub(-4) == ".lua" or file:sub(-5) == '.luac' then
-        Tinkr:require("scripts/bastion/scripts/" .. file:sub(1, -5), Bastion)
+            require(dir .. file:sub(1, -5), Bastion)
         end
     end
+end
+
+Load("scripts/bastion/scripts/Libraries/")
+Load("scripts/bastion/scripts/Modules/")
+Load("scripts/bastion/scripts/")