Display tooltips on highlighted mods in Manage Installed Mods

Author: maddie480

changelog.txt

@@ -3,4 +3,4 @@ and only contains the latest changes.
 Its purpose is to be shown in Olympus when updating.
 
 #changelog#
-∙ Touch-ups to French translation
+∙ Display tooltips on highlighted mods in Manage Installed Mods

src/lang.lua

@@ -285,6 +285,9 @@ Press the manage button below.]],
 Do you want to enable %s as well?]],
     mod1 = [[mod]],
     mods1 = [[mods]],
+    tooltip_favorite = [[Favorite]],
+    tooltip_dependency_of_favorite = [[Dependency of one of your favorites]],
+    tooltip_dependency = [[Dependency of one of your enabled mods]],
     it = [[it]],
     them = [[them]],
     s_other_s_no_longer_required_for_any_ena = [[%s other %s no longer required for any enabled mod.
@@ -670,6 +673,9 @@ Appuie sur le bouton "Gérer" ci-dessous.]],
 Veux-tu aussi activer %s ?]],
     mod1 = [[mod non activé]],
     mods1 = [[mods non activés]],
+    tooltip_favorite = [[Favori]],
+    tooltip_dependency_of_favorite = [[Requis par l'un de tes mods favoris]],
+    tooltip_dependency = [[Requis par l'un des mods que tu as activés]],
     it = [[celui-ci]],
     them = [[ceux-ci]],
     s_other_s_no_longer_required_for_any_ena = [[%s %s pour aucun mod activé.

src/main.lua

@@ -438,8 +438,9 @@ function love.load(args)
                 interactive = -1
             }):with(function(el)
                 table.remove(el.children, 1).parent = el
-            end):as("logWindow")
+            end):as("logWindow"),
 
+            require("tooltip").getTooltipWindow()
         }):with({
             style = {
                 spacing = 0
@@ -903,6 +904,10 @@ function love.keypressed(key, scancode, isrepeat)
             error("SHIFT + F9")
         elseif love.keyboard.isDown("lctrl") or love.keyboard.isDown("rctrl") then
             sharp.crash()
+        elseif love.keyboard.isDown("lalt") or love.keyboard.isDown("ralt") then
+            threader.routine(function()
+                error("You successfully killed the threader, good job!")
+            end)
         else
             collectgarbage("collect")
             collectgarbage("collect")

src/scenes/modlist.lua

@@ -184,8 +184,10 @@ local function getLabelTextFor(info)
     local themeColors = uie.modNameLabelColors().style
     local color = themeColors.normalColor
 
+    local tooltip = nil
     if info.IsFavorite then
         color = themeColors.favoriteColor
+        tooltip = lang.get("tooltip_favorite")
     else
         local isDependencyOfFavorite = false
         local isDependency = false
@@ -202,12 +204,15 @@ local function getLabelTextFor(info)
 
         if isDependencyOfFavorite then
             color = themeColors.dependencyOfFavoriteColor
+            tooltip = lang.get("tooltip_dependency_of_favorite")
         elseif isDependency then
             color = themeColors.dependencyColor
+            tooltip = lang.get("tooltip_dependency")
         end
     end
 
     color = {color[1], color[2], color[3], info.IsBlacklisted and 0.5 or 1}
+    tooltip = tooltip and { color, tooltip } or nil
 
     if info.Name then
         if info.GameBananaTitle then
@@ -218,7 +223,7 @@ local function getLabelTextFor(info)
                 info.GameBananaTitle .. "\n",
                 themeColors.disabledColor,
                 info.Name .. " " .. (info.Version or "?.?.?.?") .. " ∙ " .. fs.filename(info.Path)
-            }
+            }, tooltip
         else
             -- MaxHelpingHand
             -- 1.4.5 ∙ Filename.zip
@@ -227,7 +232,7 @@ local function getLabelTextFor(info)
                 info.Name .. "\n",
                 themeColors.disabledColor,
                 (info.Version or "?.?.?.?") .. " ∙ " .. fs.filename(info.Path)
-            }
+            }, tooltip
         end
     else
         -- Filename.zip
@@ -236,7 +241,7 @@ local function getLabelTextFor(info)
             fs.filename(info.Path) .. "\n",
             themeColors.disabledColor,
             lang.get("no_mod_info_available")
-        }
+        }, tooltip
     end
 end
 
@@ -282,7 +287,11 @@ local function findDependenciesToEnable(mod)
 end
 
 local function updateLabelTextForMod(mod)
-    mod.row:findChild("title"):setText(getLabelTextFor(mod.info))
+    local label, tooltip = getLabelTextFor(mod.info)
+    mod.row:findChild("title"):with({
+        tooltipText = tooltip,
+        interactive = tooltip and 1 or 0
+    }):setText(label)
 end
 
 local function updateLabelTextForDependencies(mod)
@@ -906,8 +915,12 @@ function scene.item(info)
         return nil
     end
 
+    local label, tooltip = getLabelTextFor(info)
     local item = uie.paneled.row({
-        uie.label(getLabelTextFor(info)):as("title"),
+        uie.label(label):with({
+            tooltipText = tooltip,
+            interactive = tooltip and 1 or 0
+        }):as("title"),
 
         uie.row({
             uie.warning(false, function(warning, newState)

src/threader.lua

@@ -490,7 +490,7 @@ function threader.routine(fun, ...)
                 return {fun(unpack(args))}
             end,
             function(err)
-                logger.error(id, err)
+                log.error(id, err)
                 if type(err) == "userdata" or type(err) == "table" then
                     return err
                 end
@@ -533,9 +533,9 @@ function threader.update()
     if running then
         local status = coroutine.status(running.routine)
         if status ~= "running" then
-            logger.warning("threader.update called from within a " .. (running.waiting and "waiting " or "") .. " ZOMBIE threader coroutine (" .. running.id .. ", " .. status .. "), possibly via a native callback during coroutine.yield")
+            log.warning("threader.update called from within a " .. (running.waiting and "waiting " or "") .. " ZOMBIE threader coroutine (" .. running.id .. ", " .. status .. "), possibly via a native callback during coroutine.yield")
         else
-            logger.warning("threader.update called from within a " .. (running.waiting and "waiting " or "") .. "threader coroutine (" .. running.id .. "), possibly via a native callback during coroutine.yield")
+            log.warning("threader.update called from within a " .. (running.waiting and "waiting " or "") .. "threader coroutine (" .. running.id .. "), possibly via a native callback during coroutine.yield")
         end
     end
 

src/tooltip.lua

@@ -0,0 +1,107 @@
+-- adapted from the Lönn map editor, also based on OlympUI: https://github.com/CelestialCartographers/Loenn/blob/ui-olympUI/src/ui/tooltip.lua
+
+local ui = require("ui")
+local uie = require("ui.elements")
+local uiu = require("ui.utils")
+
+local log = require("logger")("tooltip")
+
+local tooltipWaitDuration = 0.5
+local lastX, lastY = 0, 0
+local waitedDuration = 0
+
+local targetElement
+local tooltipExists = false
+local tooltipWindow
+
+local tooltipHandler = {}
+
+local function getUsableSize()
+    local root = ui.root
+    return root.width - 32, root.height - 32
+end
+
+local function moveWindow(window, newX, newY, clamp)
+    local usableWidth, usableHeight = getUsableSize()
+    local currentX, currentY = window.x, window.y
+
+    if clamp ~= false then
+        newX = math.max(math.min(usableWidth - window.width + 16, newX), 16)
+        newY = math.max(math.min(usableHeight - window.height + 16, newY), 16)
+    end
+
+    if math.abs(currentX - newX) > 4 or math.abs(currentY - newY) > 4 then
+        window.x = newX
+        window.realX = newX
+        window.y = newY
+        window.realY = newY
+
+        if window.parent then
+            window.parent:reflow()
+        end
+
+        ui.root:recollect(false, true)
+    end
+end
+
+function tooltipHandler.tooltipWindowUpdate(orig, self, dt)
+    orig(self, dt)
+
+    local cursorX, cursorY = love.mouse.getPosition()
+    local hovered = ui.hovering
+    local waitedEnough = waitedDuration >= tooltipWaitDuration
+
+    if not waitedEnough then
+        if cursorX == lastX and cursorY == lastY then
+            waitedDuration = waitedDuration + dt
+
+        else
+            lastX, lastY = cursorX, cursorY
+            waitedDuration = 0
+        end
+    end
+
+    if hovered ~= targetElement then
+        waitedDuration = 0
+
+        if hovered then
+            local tooltipText = rawget(hovered, "tooltipText")
+
+            if tooltipText then
+                tooltipWindow.children[1]:setText(tooltipText)
+                log.debug("Hovering over element with tooltip", tooltipText)
+            end
+
+            targetElement = hovered
+            tooltipExists = not not tooltipText
+
+        else
+            targetElement = false
+            tooltipExists = false
+        end
+    end
+
+    if tooltipExists and waitedEnough then
+        moveWindow(tooltipWindow, cursorX, cursorY - tooltipWindow.height)
+
+    elseif tooltipWindow.x ~= -1024 or tooltipWindow.y ~= -1024 then
+        moveWindow(tooltipWindow, -1024, -1024, false)
+    end
+end
+
+function tooltipHandler.getTooltipWindow()
+    if not tooltipWindow then
+        tooltipWindow = uie.panel({
+            uie.label("Test")
+        }):with({
+            interactive = -2,
+            updateHidden = true
+        }):hook({
+            update = tooltipHandler.tooltipWindowUpdate
+        })
+    end
+
+    return tooltipWindow
+end
+
+return tooltipHandler