Lua Hooks extension and D2-Style Tooltip mod.

CMake/Assets.cmake

@@ -162,6 +162,7 @@ set(devilutionx_assets
   lua/mods/clock/init.lua
   "lua/mods/Floating Numbers - Damage/init.lua"
   "lua/mods/Floating Numbers - XP/init.lua"
+  lua/mods/Tooltips/init.lua
   lua/repl_prelude.lua
   plrgfx/warrior/whu/whufm.trn
   plrgfx/warrior/whu/whulm.trn

Source/CMakeLists.txt

@@ -118,13 +118,15 @@ set(libdevilutionx_SRCS
   lua/modules/dev/search.cpp
   lua/modules/dev/towners.cpp
   lua/modules/floatingnumbers.cpp
+  lua/modules/gamepad.cpp
   lua/modules/i18n.cpp
   lua/modules/items.cpp
   lua/modules/log.cpp
   lua/modules/monsters.cpp
   lua/modules/player.cpp
   lua/modules/render.cpp
   lua/modules/system.cpp
+  lua/modules/infobox.cpp
   lua/modules/towners.cpp
   lua/repl.cpp
 

Source/control/control_infobox.cpp

@@ -4,20 +4,22 @@
 #include "engine/render/primitive_render.hpp"
 #include "inv.h"
 #include "levels/trigs.h"
+#include "lua/lua_global.hpp"
+#include "lua/modules/infobox.hpp"
 #include "panels/partypanel.hpp"
 #include "qol/stash.h"
 #include "qol/xpbar.h"
 #include "towners.h"
 #include "utils/algorithm/container.hpp"
 #include "utils/format_int.hpp"
 #include "utils/log.hpp"
 #include "utils/screen_reader.hpp"
 #include "utils/str_cat.hpp"
 #include "utils/str_split.hpp"
 
 namespace devilution {
 
 StringOrView InfoString;
 StringOrView FloatingInfoString;
 
 namespace {
@@ -28,12 +30,12 @@
 		return;
 
 	const int space[] = { 18, 12, 6, 3, 0 };
 	Rectangle infoBox = InfoBoxRect;
 
 	SetPanelObjectPosition(UiPanels::Main, infoBox);
 
 	const auto newLineCount = static_cast<int>(c_count(InfoString.str(), '\n'));
 	const int spaceIndex = std::min(4, newLineCount);
 	const int spacing = space[spaceIndex];
 	const int lineHeight = 12 + spacing;
 
@@ -44,21 +46,23 @@
 
 	SpeakText(InfoString);
 
-	DrawString(out, InfoString, infoBox,
-	    {
-	        .flags = InfoColor | UiFlags::AlignCenter | UiFlags::VerticalCenter | UiFlags::KerningFitSpacing,
-	        .spacing = 2,
-	        .lineHeight = lineHeight,
-	    });
+	if (!DrawInfoBoxTextWithColors(out, InfoString, infoBox, UiFlags::AlignCenter | UiFlags::VerticalCenter | UiFlags::KerningFitSpacing, 2, lineHeight)) {
+		DrawString(out, InfoString, infoBox,
+		    {
+		        .flags = InfoColor | UiFlags::AlignCenter | UiFlags::VerticalCenter | UiFlags::KerningFitSpacing,
+		        .spacing = 2,
+		        .lineHeight = lineHeight,
+		    });
+	}
 }
 
 Rectangle GetFloatingInfoRect(const int lineHeight, const int textSpacing)
 {
 	// Calculate the width and height of the floating info box
 	const std::string txt = std::string(FloatingInfoString);
 
 	auto lines = SplitByChar(txt, '\n');
 	const GameFontTables font = GameFont12;
 	int maxW = 0;
 
 	for (const auto &line : lines) {
@@ -211,6 +215,26 @@
 	return (yAbove >= 0) ? yAbove : yBelow;
 }
 
+const Item *GetHoveredInventoryOrStashItem()
+{
+	if (pcursinvitem >= INVITEM_HEAD && pcursinvitem < INVITEM_INV_FIRST) {
+		const int slot = pcursinvitem - INVITEM_HEAD;
+		return &InspectPlayer->InvBody[slot];
+	}
+	if (pcursinvitem >= INVITEM_INV_FIRST && pcursinvitem < INVITEM_INV_FIRST + InventoryGridCells) {
+		const int itemIdx = pcursinvitem - INVITEM_INV_FIRST;
+		return &InspectPlayer->InvList[itemIdx];
+	}
+	if (pcursinvitem >= INVITEM_BELT_FIRST && pcursinvitem < INVITEM_BELT_FIRST + MaxBeltItems) {
+		const int itemIdx = pcursinvitem - INVITEM_BELT_FIRST;
+		return &InspectPlayer->SpdList[itemIdx];
+	}
+	if (pcursstashitem != StashStruct::EmptyCell) {
+		return &Stash.stashList[pcursstashitem];
+	}
+	return nullptr;
+}
+
 void PrintFloatingInfo(const Surface &out)
 {
 	if (ChatFlag)
@@ -234,6 +258,7 @@
 
 	// Prevent the floating info box from going off-screen vertically
 	floatingInfoBox.position.y = ClampAboveOrBelow(anchorY, spriteH, floatingInfoBox.size.height, vPadding, verticalSpacing);
+	SetLastFloatingInfoBoxRect(floatingInfoBox);
 
 	SpeakText(FloatingInfoString);
 
@@ -244,12 +269,16 @@
 	DrawHalfTransparentHorizontalLine(out, { floatingInfoBox.position.x - hPadding, floatingInfoBox.position.y - vPadding - 1 }, floatingInfoBox.size.width + (hPadding * 2), PAL16_GRAY + 10);
 	DrawHalfTransparentHorizontalLine(out, { floatingInfoBox.position.x - hPadding, floatingInfoBox.position.y + vPadding + floatingInfoBox.size.height }, floatingInfoBox.size.width + (hPadding * 2), PAL16_GRAY + 10);
 
-	DrawString(out, FloatingInfoString, floatingInfoBox,
-	    {
-	        .flags = InfoColor | UiFlags::AlignCenter | UiFlags::VerticalCenter,
-	        .spacing = textSpacing,
-	        .lineHeight = lineHeight,
-	    });
+	if (!DrawInfoBoxTextWithColors(out, FloatingInfoString, floatingInfoBox, UiFlags::AlignCenter | UiFlags::VerticalCenter, textSpacing, lineHeight)) {
+		DrawString(out, FloatingInfoString, floatingInfoBox,
+		    {
+		        .flags = InfoColor | UiFlags::AlignCenter | UiFlags::VerticalCenter,
+		        .spacing = textSpacing,
+		        .lineHeight = lineHeight,
+		    });
+	}
+
+	LuaEvent("AfterFloatingInfoBoxDraw");
 }
 
 } // namespace
@@ -355,6 +384,8 @@
 
 void DrawInfoBox(const Surface &out)
 {
+	const Item *infoBoxItem = nullptr;
+
 	DrawPanelBox(out, MakeSdlRect(InfoBoxRect.position.x, InfoBoxRect.position.y + PanelPaddingHeight, InfoBoxRect.size.width, InfoBoxRect.size.height), GetMainPanel().position + Displacement { InfoBoxRect.position.x, InfoBoxRect.position.y });
 	if (!MainPanelFlag && !trigflag && pcursinvitem == -1 && pcursstashitem == StashStruct::EmptyCell && !SpellSelectFlag && pcurs != CURSOR_HOURGLASS) {
 		InfoString = StringOrView {};
@@ -364,6 +395,7 @@
 	if (SpellSelectFlag || trigflag || pcurs == CURSOR_HOURGLASS) {
 		InfoColor = UiFlags::ColorWhite;
 	} else if (!myPlayer.HoldItem.isEmpty()) {
+		infoBoxItem = &myPlayer.HoldItem;
 		if (myPlayer.HoldItem._itype == ItemType::Gold) {
 			const int nGold = myPlayer.HoldItem._ivalue;
 			InfoString = fmt::format(fmt::runtime(ngettext("{:s} gold piece", "{:s} gold pieces", nGold)), FormatInteger(nGold));
@@ -374,8 +406,10 @@
 			InfoColor = myPlayer.HoldItem.getTextColor();
 		}
 	} else {
-		if (pcursitem != -1)
+		if (pcursitem != -1) {
 			GetItemStr(Items[pcursitem]);
+			infoBoxItem = &Items[pcursitem];
+		}
 		else if (ObjectUnderCursor != nullptr)
 			GetObjectStr(*ObjectUnderCursor);
 		if (pcursmonst != -1) {
@@ -407,6 +441,17 @@
 			AddInfoBoxString(_("Right click to inspect"));
 		}
 	}
+	if (infoBoxItem == nullptr)
+		infoBoxItem = GetHoveredInventoryOrStashItem();
+
+	if (infoBoxItem != nullptr) {
+		PrepareInfoBoxColors(infoBoxItem, false);
+		if (FloatingInfoBoxColors.hasCustomColors())
+			InfoColor = FloatingInfoBoxColors.getLineColor(0);
+	} else {
+		FloatingInfoBoxColors.clear();
+	}
+
 	if (!InfoString.empty())
 		PrintInfo(out);
 }
@@ -416,10 +461,18 @@
 	if (pcursinvitem == -1 && pcursstashitem == StashStruct::EmptyCell) {
 		FloatingInfoString = StringOrView {};
 		InfoColor = UiFlags::ColorWhite;
+		ClearLastFloatingInfoBoxRect();
 	}
 
-	if (!FloatingInfoString.empty())
+	if (!FloatingInfoString.empty()) {
+		const Item *hoveredItem = GetHoveredInventoryOrStashItem();
+		PrepareInfoBoxColors(hoveredItem, true);
+		if (FloatingInfoBoxColors.hasCustomColors())
+			InfoColor = FloatingInfoBoxColors.getLineColor(0);
 		PrintFloatingInfo(out);
+	} else {
+		ClearLastFloatingInfoBoxRect();
+	}
 }
 
 } // namespace devilution

Source/engine/render/scrollrt.cpp

@@ -1409,7 +1409,9 @@ void DrawView(const Surface &out, Point startPosition)
 	}
 	DrawLevelButton(out);
 	if (ShowUniqueItemInfoBox) {
-		DrawUniqueInfo(out);
+		LuaEvent("BeforeUniqueInfoBoxDraw");
+		if (ShowUniqueItemInfoBox)
+			DrawUniqueInfo(out);
 	}
 	if (qtextflag) {
 		DrawQText(out);

Source/lua/lua_global.cpp

@@ -14,6 +14,7 @@
 #include "engine/assets.hpp"
 #include "lua/modules/audio.hpp"
 #include "lua/modules/floatingnumbers.hpp"
+#include "lua/modules/gamepad.hpp"
 #include "lua/modules/hellfire.hpp"
 #include "lua/modules/i18n.hpp"
 #include "lua/modules/items.hpp"
@@ -22,6 +23,7 @@
 #include "lua/modules/player.hpp"
 #include "lua/modules/render.hpp"
 #include "lua/modules/system.hpp"
+#include "lua/modules/infobox.hpp"
 #include "lua/modules/towners.hpp"
 #include "monster.h"
 #include "options.h"
@@ -291,6 +293,8 @@ void LuaInitialize()
 	    "devilutionx.towners", LuaTownersModule(lua),
 	    "devilutionx.hellfire", LuaHellfireModule(lua),
 	    "devilutionx.system", LuaSystemModule(lua),
+	    "devilutionx.gamepad", LuaGamepadModule(lua),
+	    "devilutionx.infobox", LuaInfoBoxModule(lua),
 	    "devilutionx.floatingnumbers", LuaFloatingNumbersModule(lua),
 	    "devilutionx.message", [](std::string_view text) { EventPlrMsg(text, UiFlags::ColorRed); },
 	    // This package is loaded without a sandbox:
@@ -355,6 +359,36 @@ void LuaEvent(std::string_view name, const Player *player, uint32_t arg1)
 	CallLuaEvent(name, player, arg1);
 }
 
+void LuaEvent(std::string_view name, const Item *item)
+{
+	CallLuaEvent(name, item);
+}
+
+void LuaEvent(std::string_view name, const Item *item, bool arg1)
+{
+	CallLuaEvent(name, item, arg1);
+}
+
+bool LuaEventHasHandlers(std::string_view name)
+{
+	if (!CurrentLuaState.has_value()) {
+		return false;
+	}
+
+	const auto hasHandlers = CurrentLuaState->events.traverse_get<std::optional<sol::object>>(name, "hasHandlers");
+	if (!hasHandlers.has_value() || !hasHandlers->is<sol::protected_function>()) {
+		return false;
+	}
+
+	const sol::protected_function fn = hasHandlers->as<sol::protected_function>();
+	sol::object result = SafeCallResult(fn(), /*optional=*/true);
+	if (!result.valid() || result.get_type() != sol::type::boolean) {
+		return false;
+	}
+
+	return result.as<bool>();
+}
+
 sol::state &GetLuaState()
 {
 	return CurrentLuaState->sol;

Source/lua/lua_global.hpp

@@ -10,6 +10,7 @@ namespace devilution {
 
 struct Player;
 struct Monster;
+struct Item;
 
 void LuaInitialize();
 void LuaReloadActiveMods();
@@ -19,6 +20,9 @@ void LuaEvent(std::string_view name, std::string_view arg);
 void LuaEvent(std::string_view name, const Player *player, int arg1, int arg2);
 void LuaEvent(std::string_view name, const Monster *monster, int arg1, int arg2);
 void LuaEvent(std::string_view name, const Player *player, uint32_t arg1);
+void LuaEvent(std::string_view name, const Item *item);
+void LuaEvent(std::string_view name, const Item *item, bool arg1);
+bool LuaEventHasHandlers(std::string_view name);
 sol::state &GetLuaState();
 sol::environment CreateLuaSandbox();
 sol::object SafeCallResult(sol::protected_function_result result, bool optional);