Functional Tooltip support

class_configs/shd_class_config.lua

@@ -1203,7 +1203,8 @@ local _ClassConfig = {
     },
     ['DefaultConfig']   = {
         ['Mode']         = { DisplayName = "Mode", Category = "Combat", Tooltip = "Select the Combat Mode for this Toon", Type = "Custom", RequiresLoadoutChange = true, Default = 1, Min = 1, Max = 3, },
-        ['DoTorrent']    = { DisplayName = "Cast Torrents", Category = "Spells and Abilities", Tooltip = "Enable casting Torrent spells.", RequiresLoadoutChange = true, Default = true, },
+        ['DoTorrent']    = { DisplayName = "Cast Torrents", Category = "Spells and Abilities", Tooltip = function(self) return mq.TLO.Spell(self.ResolvedActionMap['Torrent'])
+            .Description() end, RequiresLoadoutChange = true, Default = true, },
         ['DoDireTap']    = { DisplayName = "Cast Dire Taps", Category = "Spells and Abilities", Tooltip = "Enable casting Dire Tap spells.", RequiresLoadoutChange = true, Default = true, },
         ['DoBandolier']  = { DisplayName = "Use Bandolier", Category = "Equipment", Tooltip = "Enable Swapping of items using the bandolier.", Default = false, },
         ['DoSnare']      = { DisplayName = "Cast Snares", Category = "Spells and Abilities", Tooltip = "Enable casting Snare spells.", Default = true, },

extras/version.lua

@@ -1 +1 @@
-return { commitId = 'eeffde6 2024-01-13' }
+return { commitId = 'f6d15a1 2024-01-13' }

init.lua

@@ -213,7 +213,7 @@ local function RGMercsGUI()
                     ImGui.Text("Stuck To: " .. (mq.TLO.Stick.Active() and (mq.TLO.Stick.StickTargetName() or "None") or "None"))
                     if ImGui.CollapsingHeader("Config Options") then
                         local settingsRef = RGMercConfig:GetSettings()
-                        settingsRef, pressed, _ = RGMercUtils.RenderSettings(settingsRef, RGMercConfig.DefaultConfig, RGMercConfig.DefaultCategories)
+                        settingsRef, pressed, _ = RGMercUtils.RenderSettings(nil, settingsRef, RGMercConfig.DefaultConfig, RGMercConfig.DefaultCategories)
                         if pressed then
                             RGMercConfig:SaveSettings(false)
                         end
@@ -223,7 +223,7 @@ local function RGMercsGUI()
                         ImGui.PushID(n .. "_config_hdr")
                         if s and s.settings and s.defaults and s.categories then
                             if ImGui.CollapsingHeader(string.format("%s: Config Options", n)) then
-                                s.settings, pressed, _ = RGMercUtils.RenderSettings(s.settings, s.defaults, s.categories)
+                                s.settings, pressed, _ = RGMercUtils.RenderSettings(s.self, s.settings, s.defaults, s.categories)
                                 if pressed then
                                     RGMercModules:ExecModule(n, "SaveSettings", true)
                                 end

modules/basic.lua

@@ -50,7 +50,7 @@ function Module:Init()
     RGMercsLogger.log_info("Basic Combat Module Loaded.")
     self:LoadSettings()
 
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:Render()

modules/class.lua

@@ -114,7 +114,7 @@ function Module:Init()
     -- set dynamic names.
     self:SetDynamicNames()
 
-    return { settings = self.settings, defaults = self.ClassConfig.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.ClassConfig.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:SetDynamicNames()
@@ -159,15 +159,15 @@ function Module:Render()
     if self.ClassConfig and self.ModuleLoaded then
         ImGui.Text("Mode: ")
         ImGui.SameLine()
-        RGMercUtils.Tooltip(self.ClassConfig.DefaultConfig.Mode.Tooltip)
+        RGMercUtils.Tooltip(self, self.ClassConfig.DefaultConfig.Mode.Tooltip)
         self.settings.Mode, pressed = ImGui.Combo("##_select_ai_mode", self.settings.Mode, self.ClassConfig.Modes, #self.ClassConfig.Modes)
         if pressed then
             self:SaveSettings(false)
             self.TempSettings.NewCombatMode = true
         end
 
         if ImGui.CollapsingHeader("Config Options") then
-            self.settings, pressed, loadoutChange = RGMercUtils.RenderSettings(self.settings, self.ClassConfig.DefaultConfig, self.DefaultCategories)
+            self.settings, pressed, loadoutChange = RGMercUtils.RenderSettings(self, self.settings, self.ClassConfig.DefaultConfig, self.DefaultCategories)
             if pressed then
                 self:SaveSettings(false)
                 self.TempSettings.NewCombatMode = self.TempSettings.NewCombatMode or loadoutChange

modules/mez.lua

@@ -86,7 +86,7 @@ function Module:Init()
 
     self.ModuleLoaded = true
 
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:Render()
@@ -97,7 +97,7 @@ function Module:Render()
 
     if self.ModuleLoaded then
         if ImGui.CollapsingHeader("Config Options") then
-            self.settings, pressed, _ = RGMercUtils.RenderSettings(self.settings, self.DefaultConfig, self.DefaultCategories)
+            self.settings, pressed, _ = RGMercUtils.RenderSettings(self, self.settings, self.DefaultConfig, self.DefaultCategories)
             if pressed then
                 self:SaveSettings(false)
             end

modules/movement.lua

@@ -73,7 +73,7 @@ function Module:Init()
     RGMercsLogger.log_info("Chase Module Loaded.")
     self:LoadSettings()
     self.ModuleLoaded = true
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:ChaseOn(target)
@@ -227,7 +227,7 @@ function Module:Render()
         local chaseSpawn = mq.TLO.Spawn("pc =" .. (self.settings.ChaseTarget or "NoOne"))
 
         if ImGui.CollapsingHeader("Config Options") then
-            self.settings, pressed, _ = RGMercUtils.RenderSettings(self.settings, self.DefaultConfig, self.DefaultCategories)
+            self.settings, pressed, _ = RGMercUtils.RenderSettings(self, self.settings, self.DefaultConfig, self.DefaultCategories)
             if pressed then
                 self:SaveSettings(false)
             end

modules/performance.lua

@@ -116,7 +116,7 @@ function Module:Init()
     RGMercsLogger.log_info("Performance Monitor Module Loaded.")
     self:LoadSettings()
 
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:Render()
@@ -171,7 +171,7 @@ function Module:Render()
             self:SaveSettings(false)
         end
 
-        self.settings, pressed, _ = RGMercUtils.RenderSettings(self.settings, self.DefaultConfig, self.DefaultCategories)
+        self.settings, pressed, _ = RGMercUtils.RenderSettings(self, self.settings, self.DefaultConfig, self.DefaultCategories)
         if pressed then
             self:SaveSettings(false)
         end

modules/pull.lua

@@ -157,7 +157,7 @@ function Module:Init()
     RGMercsLogger.log_info("Pull Module Loaded.")
     self:LoadSettings()
     self.ModuleLoaded = true
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:RenderMobList(displayName, settingName)
@@ -343,7 +343,7 @@ function Module:Render()
     end
 
     if ImGui.CollapsingHeader("Config Options") then
-        self.settings, pressed, _ = RGMercUtils.RenderSettings(self.settings, self.DefaultConfig, self.DefaultCategories)
+        self.settings, pressed, _ = RGMercUtils.RenderSettings(self, self.settings, self.DefaultConfig, self.DefaultCategories)
         if pressed then
             self:SaveSettings(false)
         end

modules/travel.lua

@@ -146,7 +146,7 @@ function Module:Init()
     self:CreatePorterList()
     self:GenerateFilteredPortsList()
 
-    return { settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
+    return { self = self, settings = self.settings, defaults = self.DefaultConfig, categories = self.DefaultCategories, }
 end
 
 function Module:GetColorForType(type)

utils/rgmercs_utils.lua

@@ -2271,17 +2271,21 @@ function Utils.NavEnabledLoc(loc)
             printf('\ayNavigating to \ag%s', loc)
         end
 
-        Utils.Tooltip("Double click to Nav")
+        Utils.Tooltip(nil, "Double click to Nav")
     end
 end
 
 ---@param desc string
-function Utils.Tooltip(desc)
+function Utils.Tooltip(caller, desc)
     ImGui.SameLine()
     if ImGui.IsItemHovered() then
         ImGui.BeginTooltip()
         ImGui.PushTextWrapPos(ImGui.GetFontSize() * 25.0)
-        ImGui.Text(desc)
+        if type(desc) == "function" then
+            ImGui.Text(desc(caller))
+        else
+            ImGui.Text(desc)
+        end
         ImGui.PopTextWrapPos()
         ImGui.EndTooltip()
     end
@@ -2601,7 +2605,7 @@ function Utils.RenderRotationTable(caller, name, rotationTable, resolvedActionMa
             end
             ImGui.PopStyleColor()
             if entry.tooltip then
-                Utils.Tooltip(entry.tooltip)
+                Utils.Tooltip(caller, entry.tooltip)
             end
             ImGui.TableNextColumn()
             local mappedAction = resolvedActionMap[entry.name]
@@ -2713,14 +2717,15 @@ function Utils.RenderOptionNumber(id, text, cur, min, max, step)
     return input, changed
 end
 
+---@param caller self
 ---@param settings table
 ---@param settingNames table
 ---@param defaults table
 ---@param category string
 ---@return table   # settings
 ---@return boolean # any_pressed
 ---@return boolean # requires_new_loadout
-function Utils.RenderSettingsTable(settings, settingNames, defaults, category)
+function Utils.RenderSettingsTable(caller, settings, settingNames, defaults, category)
     local any_pressed = false
     local new_loadout = false
     ---@type boolean|nil
@@ -2745,7 +2750,7 @@ function Utils.RenderSettingsTable(settings, settingNames, defaults, category)
                         -- build a combo box.
                         ImGui.TableNextColumn()
                         ImGui.Text((defaults[k].DisplayName or "None"))
-                        Utils.Tooltip(defaults[k].Tooltip)
+                        Utils.Tooltip(caller, defaults[k].Tooltip)
                         ImGui.TableNextColumn()
                         ImGui.PushID("##combo_setting_" .. k)
                         settings[k], pressed = ImGui.Combo("", settings[k], defaults[k].ComboOptions)
@@ -2771,14 +2776,14 @@ function Utils.RenderSettingsTable(settings, settingNames, defaults, category)
                                 pressed = true
                             end
                         end
-                        Utils.Tooltip(string.format("Drop a new item here to replace\n%s", settings[k]))
+                        Utils.Tooltip(caller, string.format("Drop a new item here to replace\n%s", settings[k]))
                         new_loadout = new_loadout or ((pressed or false) and (defaults[k].RequiresLoadoutChange or false))
                         any_pressed = any_pressed or (pressed or false)
                         ImGui.PopID()
                     elseif defaults[k].Type ~= "Custom" then
                         ImGui.TableNextColumn()
                         ImGui.Text((defaults[k].DisplayName or "None"))
-                        Utils.Tooltip(defaults[k].Tooltip)
+                        Utils.Tooltip(caller, defaults[k].Tooltip)
                         ImGui.TableNextColumn()
                         if type(settings[k]) == 'boolean' then
                             settings[k], pressed = Utils.RenderOptionToggle(k, "", settings[k])
@@ -2791,7 +2796,7 @@ function Utils.RenderSettingsTable(settings, settingNames, defaults, category)
                             any_pressed = any_pressed or pressed
                         elseif type(settings[k]) == 'string' then -- display only
                             ImGui.Text(settings[k])
-                            Utils.Tooltip(settings[k])
+                            Utils.Tooltip(caller, settings[k])
                         end
                     end
                 end
@@ -2809,7 +2814,7 @@ end
 ---@return table: settings
 ---@return boolean: any_pressed
 ---@return boolean: requires_new_loadout
-function Utils.RenderSettings(settings, defaults, categories)
+function Utils.RenderSettings(caller, settings, defaults, categories)
     local any_pressed = false
     local new_loadout = false
 
@@ -2849,7 +2854,7 @@ function Utils.RenderSettings(settings, defaults, categories)
                 if ImGui.BeginTabItem(c) then
                     local cat_pressed = false
 
-                    settings, cat_pressed, new_loadout = Utils.RenderSettingsTable(settings, settingNames, defaults, c)
+                    settings, cat_pressed, new_loadout = Utils.RenderSettingsTable(caller, settings, settingNames, defaults, c)
                     any_pressed = any_pressed or cat_pressed
                     ImGui.EndTabItem()
                 end