Merge pull request 'EmmyLua Types' (#2) from sundance/bastion:emmy into main

Reviewed-on: 4n0n/bastion#2

src/APL/APL.lua

@@ -1,4 +1,5 @@
 -- Create an APL trait for the APL class
+---@class APLTrait
 local APLTrait = {}
 APLTrait.__index = APLTrait
 
@@ -29,6 +30,7 @@ function APLTrait:__tostring()
 end
 
 -- Create an APL actor for the APL class
+---@class APLActor
 local APLActor = {}
 APLActor.__index = APLActor
 
@@ -116,7 +118,7 @@ function APLActor:__tostring()
 end
 
 -- APL (Attack priority list) class
-
+---@class APL
 local APL = {}
 APL.__index = APL
 

src/Aura/Aura.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Aura class
+---@class Aura
 local Aura = {}
 
 function Aura:__index(k)

src/AuraTable/AuraTable.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new AuraTable class
+---@class AuraTable
 local AuraTable = {}
 AuraTable.__index = AuraTable
 
@@ -196,6 +197,7 @@ function AuraTable:Clear()
 end
 
 -- Check if the unit has a specific aura
+---@return Aura
 function AuraTable:Find(spell)
     local auras = self:GetUnitAuras()
     local aurasub = auras[spell:GetID()]
@@ -217,6 +219,7 @@ function AuraTable:Find(spell)
     return Bastion.Aura:New()
 end
 
+---@return Aura
 function AuraTable:FindMy(spell)
     local aurasub = self.playerAuras[spell:GetID()]
 
@@ -238,6 +241,7 @@ function AuraTable:FindMy(spell)
 end
 
 -- Find any
+---@return Aura
 function AuraTable:FindAny(spell)
     local a = self:Find(spell)
     if a:IsValid() then

src/Cache/Cache.lua

@@ -1,3 +1,4 @@
+---@class Cache
 local Cache = {}
 Cache.__index = Cache
 

src/Cacheable/Cacheable.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Define a Cacheable class
+---@class Cacheable
 local Cacheable = {
     cache = nil,
     callback = nil,

src/Class/Class.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Class class
+---@class Class
 local Class = {}
 
 function Class:__index(k)

src/ClassMagic/ClassMagic.lua

@@ -1,6 +1,8 @@
+---@class ClassMagic
 local ClassMagic = {}
 ClassMagic.__index = ClassMagic
 
+---@return any
 function ClassMagic:Resolve(Class, key)
     if Class[key] or Class[key] == false then
         return Class[key]

src/Command/Command.lua

@@ -1,5 +1,5 @@
 -- Create a wow command handler class
-
+---@class Command
 local Command = {}
 Command.__index = Command
 

src/EventManager/EventManager.lua

@@ -1,5 +1,5 @@
 -- Create an EventManager class
-
+---@class EventManager
 local EventManager = {
     events = {},
     eventHandlers = {},

src/Item/Item.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Item class
+---@class Item
 local Item = {
     UsableIfFunc = false,
     PreUseFunc = false,
@@ -170,18 +171,21 @@ function Item:Usable()
 end
 
 -- Set a script to check if the Item is Usable
+---@param func fun(self:Item):boolean
 function Item:UsableIf(func)
     self.UsableIfFunc = func
     return self
 end
 
 -- Set a script to run before the Item has been Use
+---@param func fun(self:Item)
 function Item:PreUse(func)
     self.PreUseFunc = func
     return self
 end
 
 -- Set a script to run after the Item has been Use
+---@param func fun(self:Item)
 function Item:OnUse(func)
     self.OnUseFunc = func
     return self
@@ -278,6 +282,8 @@ function Item:GetChargesRemaining()
 end
 
 -- Create a condition for the Item
+---@param name string
+---@param func fun(self:Item)
 function Item:Condition(name, func)
     self.conditions[name] = {
         func = func

src/ItemBook/ItemBook.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new ItemBook class
+---@class ItemBook
 local ItemBook = {}
 ItemBook.__index = ItemBook
 
@@ -12,6 +13,7 @@ function ItemBook:New()
 end
 
 -- Get a spell from the ItemBook
+---@return Item
 function ItemBook:GetItem(id)
     if self.items[id] == nil then
         self.items[id] = Bastion.Item:New(id)

src/List/List.lua

@@ -1,5 +1,6 @@
 local Tinkr, Bastion = ...
 
+---@class List
 local List = {}
 List.__index = List
 

src/Module/Module.lua

@@ -1,5 +1,6 @@
 -- Create a module class for a bastion module
 
+---@class Module
 local Module = {}
 Module.__index = Module
 

src/MythicPlusUtils/MythicPlusUtils.lua

@@ -1,5 +1,6 @@
 local Tinkr, Bastion = ...
 
+---@class MythicPlusUtils
 local MythicPlusUtils = {
     debuffLogging = false,
     random = ''

src/NotificationsList/NotificationsList.lua

@@ -1,5 +1,6 @@
 -- Create a NotificationsList class
 
+---@class NotificationsList
 local NotificationsList = {
     notifications = {}
 }
@@ -29,6 +30,7 @@ function NotificationsList:New()
 end
 
 -- Create a notification class for the notifications list (takes icon and text)
+---@class Notification
 local Notification = {
 }
 Notification.__index = Notification

src/ObjectManager/ObjectManager.lua

@@ -1,5 +1,6 @@
 local Tinkr, Bastion = ...
 
+---@class ObjectManager
 local ObjectManager = {}
 ObjectManager.__index = ObjectManager
 

src/Refreshable/Refreshable.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Define a Refreshable class
+---@class Refreshable
 local Refreshable = {
     cache = nil,
     callback = nil,

src/Spell/Spell.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Spell class
+---@class Spell
 local Spell = {
     CastableIfFunc = false,
     PreCastFunc = false,
@@ -50,6 +51,7 @@ function Spell:GetID()
 end
 
 -- Add post cast func
+---@param func fun(self:Spell)
 function Spell:PostCast(func)
     self.PostCastFunc = func
     return self
@@ -173,18 +175,21 @@ function Spell:Castable()
 end
 
 -- Set a script to check if the spell is castable
+---@param func fun(spell:Spell):boolean
 function Spell:CastableIf(func)
     self.CastableIfFunc = func
     return self
 end
 
 -- Set a script to run before the spell has been cast
+---@param func fun(spell:Spell)
 function Spell:PreCast(func)
     self.PreCastFunc = func
     return self
 end
 
 -- Set a script to run after the spell has been cast
+---@param func fun(spell:Spell)
 function Spell:OnCast(func)
     self.OnCastFunc = func
     return self

src/SpellBook/SpellBook.lua

@@ -1,10 +1,12 @@
 local Tinkr, Bastion = ...
 
 -- Create a new SpellBook class
+---@class SpellBook
 local SpellBook = {}
 SpellBook.__index = SpellBook
 
 -- Constructor
+---@return SpellBook
 function SpellBook:New()
     local self = setmetatable({}, SpellBook)
     self.spells = {}
@@ -12,6 +14,7 @@ function SpellBook:New()
 end
 
 -- Get a spell from the spellbook
+---@return Spell
 function SpellBook:GetSpell(id)
     if self.spells[id] == nil then
         self.spells[id] = Bastion.Spell:New(id)
@@ -20,6 +23,7 @@ function SpellBook:GetSpell(id)
     return self.spells[id]
 end
 
+---@return Spell
 function SpellBook:GetIfRegistered(id)
     return self.spells[id]
 end

src/Timer/Timer.lua

@@ -1,6 +1,7 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Timer class
+---@class Timer
 local Timer = {
     startTime = nil,
     resetAfterCombat = false,

src/Unit/Unit.lua

@@ -1,9 +1,12 @@
 local Tinkr, Bastion = ...
 
 -- Create a new Unit class
+---@class Unit
 local Unit = {
     cache = nil,
+    ---@type AuraTable
     aura_table = nil,
+    ---@type Unit
     unit = nil,
     last_shadow_techniques = 0,
     swings_since_sht = 0,
@@ -226,6 +229,7 @@ function Unit:GetClass()
 end
 
 -- Get the units auras
+---@return AuraTable
 function Unit:GetAuras()
     return self.aura_table
 end
@@ -669,7 +673,7 @@ function Unit:IsStealthed()
     local Sepsis = Bastion.SpellBook:GetSpell(328305)
 
 
-    return self:GetAuras():FindAny(Stealth)  or self:GetAuras():FindAny(ShadowDance)
+    return self:GetAuras():FindAny(Stealth) or self:GetAuras():FindAny(ShadowDance)
 end
 
 -- Get unit swing timers

src/UnitManager/UnitManager.lua

@@ -48,6 +48,7 @@ local function Validate(token)
 end
 
 -- Create a new UnitManager class
+---@class UnitManager
 local UnitManager = {
     units = {},
     customUnits = {},
@@ -108,6 +109,7 @@ function UnitManager:Validate(token)
 end
 
 -- Get or create a unit
+---@return Unit
 function UnitManager:Get(token)
     -- if not Validate(token) then
     --     error("UnitManager:Get - Invalid token: " .. token)
@@ -145,6 +147,9 @@ function UnitManager:SetObject(unit)
 end
 
 -- Create a custom unit and cache it for .5 seconds
+---@param token string
+---@param cb fun():Unit
+---@return Unit
 function UnitManager:CreateCustomUnit(token, cb)
     local unit = cb()
     local cachedUnit = Bastion.Cacheable:New(unit, cb)
@@ -175,6 +180,7 @@ function UnitManager:EnumFriends(cb)
 end
 
 -- Enum Enemies (object manager)
+---@param cb fun(unit: Unit):boolean
 function UnitManager:EnumEnemies(cb)
     Bastion.ObjectManager.activeEnemies:each(function(unit)
         if cb(unit) then

src/Vector3/Vector3.lua

@@ -1,5 +1,6 @@
 -- Create a Vector3 class
 
+---@class Vector3
 local Vector3 = {}
 Vector3.__index = Vector3
 

src/_bastion.lua

@@ -1,5 +1,6 @@
 local Tinkr = ...
 
+---@class Bastion
 local Bastion = {
     DebugMode = false
 }
@@ -9,30 +10,54 @@ function Bastion.require(class)
     return Tinkr:require("scripts/bastion/src/" .. class .. "/" .. class, Bastion)
 end
 
+---@type ClassMagic
 Bastion.ClassMagic = Bastion.require("ClassMagic")
+---@type List
 Bastion.List = Bastion.require("List")
+---@type NotificationsList, Notification
 Bastion.NotificationsList, Bastion.Notification = Bastion.require("NotificationsList")
+---@type Vector3
 Bastion.Vector3 = Bastion.require("Vector3")
+---@type Command
 Bastion.Command = Bastion.require("Command")
+---@type Cache
 Bastion.Cache = Bastion.require("Cache")
+---@type Cacheable
 Bastion.Cacheable = Bastion.require("Cacheable")
+---@type Refreshable
 Bastion.Refreshable = Bastion.require("Refreshable")
+---@type Unit
 Bastion.Unit = Bastion.require("Unit")
+---@type Aura
 Bastion.Aura = Bastion.require("Aura")
+---@type APL, APLActor, APLTrait
 Bastion.APL, Bastion.APLActor, Bastion.APLTrait = Bastion.require("APL")
 Bastion.Module = Bastion.require("Module")
+---@type UnitManager
 Bastion.UnitManager = Bastion.require("UnitManager"):New()
+---@type ObjectManager
 Bastion.ObjectManager = Bastion.require("ObjectManager"):New()
+---@type EventManager
 Bastion.EventManager = Bastion.require("EventManager"):New()
+---@type Spell
 Bastion.Spell = Bastion.require("Spell")
+---@type SpellBook
 Bastion.SpellBook = Bastion.require("SpellBook"):New()
+---@type Item
 Bastion.Item = Bastion.require("Item")
+---@type ItemBook
 Bastion.ItemBook = Bastion.require("ItemBook"):New()
+---@type AuraTable
 Bastion.AuraTable = Bastion.require("AuraTable")
+---@type Class
 Bastion.Class = Bastion.require("Class")
+---@type Timer
 Bastion.Timer = Bastion.require("Timer")
+---@type Timer
 Bastion.CombatTimer = Bastion.Timer:New('combat')
+---@type MythicPlusUtils
 Bastion.MythicPlusUtils = Bastion.require("MythicPlusUtils"):New()
+---@type NotificationsList
 Bastion.Notifications = Bastion.NotificationsList:New()
 
 Bastion.modules = {}