From 36ad9783e587c360db1e99405c399ecb46a7c7bf Mon Sep 17 00:00:00 2001 From: PhatPhuckDave Date: Sun, 18 May 2025 12:43:55 +0200 Subject: [PATCH] Move all config definitions to their respective modules --- .luacheckrc | 2 +- Heimdall.lua | 110 +-------------------------------- Modules/AchievementSniffer.lua | 10 +++ Modules/Dueler.lua | 5 ++ Modules/Echoer.lua | 6 ++ Modules/Emoter.lua | 6 ++ Modules/Messenger.lua | 5 ++ Modules/MinimapTagger.lua | 27 ++++++++ Modules/Network.lua | 6 ++ Modules/NetworkMessenger.lua | 5 ++ Modules/Noter.lua | 6 ++ Modules/Spotter.lua | 11 ++++ Modules/StinkyCache.lua | 6 ++ Modules/StinkyTracker.lua | 8 ++- Modules/Whoer.lua | 10 +++ 15 files changed, 112 insertions(+), 111 deletions(-) diff --git a/.luacheckrc b/.luacheckrc index ed1f3df..a869798 120000 --- a/.luacheckrc +++ b/.luacheckrc @@ -1,5 +1,5 @@ globals = { "CykaPersistentData", "CreateFrame", "GetItemInfo", "aura_env" } unused_args = false -max_line_length = 150 +max_line_length = 500 exclude_files = { "Meta/" } global = false \ No newline at end of file diff --git a/Heimdall.lua b/Heimdall.lua index 3e61a35..c8411d7 100644 --- a/Heimdall.lua +++ b/Heimdall.lua @@ -93,115 +93,6 @@ local function init() ---@field locale string ---@field debug boolean - ---@class HeimdallSpotterConfig - ---@field enabled boolean - ---@field debug boolean - ---@field everyone boolean - ---@field hostile boolean - ---@field alliance boolean - ---@field stinky boolean - ---@field channels string[] - ---@field zoneOverride string? - ---@field throttleTime number - - ---@class HeimdallWhoConfig - ---@field enabled boolean - ---@field debug boolean - ---@field ignored table - ---@field channels string[] - ---@field ttl number - ---@field doWhisper boolean - ---@field zoneNotifyFor table - ---@field queries string - - ---@class HeimdallMessengerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field interval number - - ---@class HeimdallDuelerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field declineOther boolean - - ---@class HeimdallEmoterConfig - ---@field enabled boolean - ---@field debug boolean - ---@field channels string[] - ---@field prefix string - - ---@class HeimdallEchoerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field channels string[] - ---@field prefix string - - ---@class HeimdallStinkyTrackerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field ignoredTimeout number - ---@field channels string[] - - ---@class HeimdallMinimapTaggerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field channels string[] - ---@field throttle number - ---@field scale number - ---@field tagTTL number - ---@field tagSound boolean - ---@field tagSoundFile string - ---@field tagSoundThrottle number - ---@field tagTextureFile string - ---@field alertTTL number - ---@field alertSound boolean - ---@field alertSoundFile string - ---@field alertSoundThrottle number - ---@field alertTextureFile string - ---@field combatTTL number - ---@field combatSound boolean - ---@field combatSoundFile string - ---@field combatSoundThrottle number - ---@field combatTextureFile string - ---@field helpTTL number - ---@field helpSound boolean - ---@field helpSoundFile string - ---@field helpSoundThrottle number - ---@field helpTextureFile string - - ---@class HeimdallNoterConfig - ---@field enabled boolean - ---@field debug boolean - ---@field channels string[] - ---@field lastNotes number - - ---@class HeimdallNetworkConfig - ---@field enabled boolean - ---@field debug boolean - ---@field members string[] - ---@field updateInterval number - - ---@class HeimdallNetworkMessengerConfig - ---@field enabled boolean - ---@field debug boolean - ---@field interval number - - ---@class HeimdallStinkyCacheConfig - ---@field enabled boolean - ---@field debug boolean - ---@field commander string - ---@field ttl number - - ---@class HeimdallAchievementSnifferConfig - ---@field enabled boolean - ---@field debug boolean - -----@field texture string - -----@field offsetX number - -----@field offsetY number - ---@field rescan boolean - ---@field scanInterval number - -----@field iconScale number - --- Data --- ---@class HeimdallMessengerData ---@field queue table @@ -346,6 +237,7 @@ local function init() enabled = shared.GetOrDefault(Heimdall_Data, { "config", "stinkyTracker", "enabled" }, false), debug = shared.GetOrDefault(Heimdall_Data, { "config", "stinkyTracker", "debug" }, false), channels = shared.GetOrDefault(Heimdall_Data, { "config", "stinkyTracker", "channels" }, { "Agent" }), + ignoredTimeout = shared.GetOrDefault(Heimdall_Data, { "config", "stinkyTracker", "ignoredTimeout" }, 600), }, combatAlerter = { enabled = shared.GetOrDefault(Heimdall_Data, { "config", "combatAlerter", "enabled" }, false), diff --git a/Modules/AchievementSniffer.lua b/Modules/AchievementSniffer.lua index de00060..2f8e6b2 100644 --- a/Modules/AchievementSniffer.lua +++ b/Modules/AchievementSniffer.lua @@ -2,6 +2,16 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "AchievementSniffer" +---@class HeimdallAchievementSnifferConfig +---@field enabled boolean +---@field debug boolean +-----@field texture string +-----@field offsetX number +-----@field offsetY number +---@field rescan boolean +---@field scanInterval number +-----@field iconScale number + -- local HeimdallRoot = "Interface\\AddOns\\Heimdall\\" -- local TextureRoot = HeimdallRoot .. "Texture\\" diff --git a/Modules/Dueler.lua b/Modules/Dueler.lua index f0071d8..1127b20 100644 --- a/Modules/Dueler.lua +++ b/Modules/Dueler.lua @@ -2,6 +2,11 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Dueler" +---@class HeimdallDuelerConfig +---@field enabled boolean +---@field debug boolean +---@field declineOther boolean + ---@class Dueler shared.Dueler = { Init = function() diff --git a/Modules/Echoer.lua b/Modules/Echoer.lua index 818e862..f50c7d9 100644 --- a/Modules/Echoer.lua +++ b/Modules/Echoer.lua @@ -2,6 +2,12 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Echoer" +---@class HeimdallEchoerConfig +---@field enabled boolean +---@field debug boolean +---@field channels string[] +---@field prefix string + ---@class Echoer shared.Echoer = { Init = function() diff --git a/Modules/Emoter.lua b/Modules/Emoter.lua index 5a81a74..aa07e5f 100644 --- a/Modules/Emoter.lua +++ b/Modules/Emoter.lua @@ -2,6 +2,12 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Emoter" +---@class HeimdallEmoterConfig +---@field enabled boolean +---@field debug boolean +---@field channels string[] +---@field prefix string + ---@class Emoter shared.Emoter = { Init = function() diff --git a/Modules/Messenger.lua b/Modules/Messenger.lua index cfe7824..3c6597d 100644 --- a/Modules/Messenger.lua +++ b/Modules/Messenger.lua @@ -2,6 +2,11 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Messenger" +---@class HeimdallMessengerConfig +---@field enabled boolean +---@field debug boolean +---@field interval number + ---@class Message ---@field message string ---@field channel string diff --git a/Modules/MinimapTagger.lua b/Modules/MinimapTagger.lua index 0c0ed90..f82ab3b 100644 --- a/Modules/MinimapTagger.lua +++ b/Modules/MinimapTagger.lua @@ -2,6 +2,33 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "MinimapTagger" +---@class HeimdallMinimapTaggerConfig +---@field enabled boolean +---@field debug boolean +---@field channels string[] +---@field throttle number +---@field scale number +---@field tagTTL number +---@field tagSound boolean +---@field tagSoundFile string +---@field tagSoundThrottle number +---@field tagTextureFile string +---@field alertTTL number +---@field alertSound boolean +---@field alertSoundFile string +---@field alertSoundThrottle number +---@field alertTextureFile string +---@field combatTTL number +---@field combatSound boolean +---@field combatSoundFile string +---@field combatSoundThrottle number +---@field combatTextureFile string +---@field helpTTL number +---@field helpSound boolean +---@field helpSoundFile string +---@field helpSoundThrottle number +---@field helpTextureFile string + local HeimdallRoot = "Interface\\AddOns\\Heimdall\\" local SoundRoot = HeimdallRoot .. "Sounds\\" local TextureRoot = HeimdallRoot .. "Texture\\" diff --git a/Modules/Network.lua b/Modules/Network.lua index 7d12967..a56c0b7 100644 --- a/Modules/Network.lua +++ b/Modules/Network.lua @@ -2,6 +2,12 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Network" +---@class HeimdallNetworkConfig +---@field enabled boolean +---@field debug boolean +---@field members string[] +---@field updateInterval number + ---@class HeimdallNetworkData ---@field ticker Timer? diff --git a/Modules/NetworkMessenger.lua b/Modules/NetworkMessenger.lua index b0f1748..7f07608 100644 --- a/Modules/NetworkMessenger.lua +++ b/Modules/NetworkMessenger.lua @@ -2,6 +2,11 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "NetworkMessenger" +---@class HeimdallNetworkMessengerConfig +---@field enabled boolean +---@field debug boolean +---@field interval number + ---@class NetworkMessenger shared.NetworkMessenger = { Init = function() diff --git a/Modules/Noter.lua b/Modules/Noter.lua index bbd5bf5..8ecdd60 100644 --- a/Modules/Noter.lua +++ b/Modules/Noter.lua @@ -2,6 +2,12 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Noter" +---@class HeimdallNoterConfig +---@field enabled boolean +---@field debug boolean +---@field channels string[] +---@field lastNotes number + ---@class Note ---@field source string ---@field for string diff --git a/Modules/Spotter.lua b/Modules/Spotter.lua index 6897152..5b8d3a6 100644 --- a/Modules/Spotter.lua +++ b/Modules/Spotter.lua @@ -2,6 +2,17 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Spotter" +---@class HeimdallSpotterConfig +---@field enabled boolean +---@field debug boolean +---@field everyone boolean +---@field hostile boolean +---@field alliance boolean +---@field stinky boolean +---@field channels string[] +---@field zoneOverride string? +---@field throttleTime number + ---@class Spotter shared.Spotter = { Init = function() diff --git a/Modules/StinkyCache.lua b/Modules/StinkyCache.lua index 24f0ae4..a8db8bd 100644 --- a/Modules/StinkyCache.lua +++ b/Modules/StinkyCache.lua @@ -2,6 +2,12 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "StinkyCache" +---@class HeimdallStinkyCacheConfig +---@field enabled boolean +---@field debug boolean +---@field commander string +---@field ttl number + ---@class StinkyCache shared.StinkyCache = { Init = function() diff --git a/Modules/StinkyTracker.lua b/Modules/StinkyTracker.lua index 7fb0441..e9a15df 100644 --- a/Modules/StinkyTracker.lua +++ b/Modules/StinkyTracker.lua @@ -8,11 +8,17 @@ local ModuleName = "StinkyTracker" ---@field seenAt number ---@field hostile boolean +---@class HeimdallStinkyTrackerConfig +---@field enabled boolean +---@field debug boolean +---@field ignoredTimeout number +---@field channels string[] + ---@class StinkyTrackerData ---@field stinkies ReactiveValue> ---@field ignored ReactiveValue> ----@class StinkyTracker +---@class StinkyTracker shared.StinkyTracker = { ---@param stinky Stinky ---@return boolean diff --git a/Modules/Whoer.lua b/Modules/Whoer.lua index 411ff55..9a9d321 100644 --- a/Modules/Whoer.lua +++ b/Modules/Whoer.lua @@ -2,6 +2,16 @@ local _, shared = ... ---@cast shared HeimdallShared local ModuleName = "Whoer" +---@class HeimdallWhoConfig +---@field enabled boolean +---@field debug boolean +---@field ignored table +---@field channels string[] +---@field ttl number +---@field doWhisper boolean +---@field zoneNotifyFor table +---@field queries string + ---@class Whoer shared.Whoer = { Init = function()