QoL: Add Gameplay Option to Disable the Search Spell

Source/DiabloUI/multi/selgame.cpp

@@ -48,20 +48,20 @@
 uint32_t firstPublicGameInfoRequestSend = 0;
 size_t HighlightedItem;
 
 void selgame_FreeVectors()
 {
 	vecSelGameDlgItems.clear();
 
 	vecSelGameDialog.clear();
 }
 
 void selgame_Init()
 {
 	LoadBackgroundArt("ui_art\\selgame");
 	LoadScrollBar();
 }
 
 void selgame_Free()
 {
 	ArtBackground = std::nullopt;
 	UnloadScrollBar();
@@ -77,7 +77,7 @@
 	return false;
 }
 
 static std::string GetErrorMessageIncompatibility(const GameData &data)
 {
 	if (data.programid != GAME_ID) {
 		std::string_view gameMode;
@@ -98,12 +98,12 @@
 			return std::string(_("The host is running a different game than you."));
 		}
 		return fmt::format(fmt::runtime(_("The host is running a different game mode ({:s}) than you.")), gameMode);
 	} else {
 		return fmt::format(fmt::runtime(_(/* TRANSLATORS: Error message when somebody tries to join a game running another version. */ "Your version {:s} does not match the host {:d}.{:d}.{:d}.")), PROJECT_VERSION, data.versionMajor, data.versionMinor, data.versionPatch);
 	}
 }
 
 void UiInitGameSelectionList(std::string_view search)
 {
 	selgame_enteringGame = false;
 	selgame_selectedGame = 0;
@@ -263,7 +263,7 @@
 			}
 			infoString += '\n';
 			infoString.append(_("Players: "));
 			for (auto &playerName : gameInfo.players) {
 				infoString.append(playerName);
 				infoString += ' ';
 			}
@@ -289,7 +289,7 @@
 	return true;
 }
 
 void selgame_GameSelection_Select(size_t value)
 {
 	selgame_enteringGame = true;
 	selgame_selectedGame = value;
@@ -601,7 +601,7 @@
 	return false;
 }
 
 void selgame_Password_Select(size_t /*value*/)
 {
 	char *gamePassword = nullptr;
 	if (selgame_selectedGame == 0)
@@ -660,6 +660,7 @@
 	m_game_data->bRunInTown = *GetOptions().Gameplay.runInTown ? 1 : 0;
 	m_game_data->bTheoQuest = *GetOptions().Gameplay.theoQuest ? 1 : 0;
 	m_game_data->bCowQuest = *GetOptions().Gameplay.cowQuest ? 1 : 0;
+	m_game_data->bDisableSearch = *GetOptions().Gameplay.disableSearch ? 1 : 0;
 
 	GameData gameInitInfo = *m_game_data;
 	gameInitInfo.swapLE();

Source/automap.cpp

@@ -17,6 +17,7 @@
 #include "engine/render/primitive_render.hpp"
 #include "levels/gendung.h"
 #include "levels/setmaps.h"
+#include "options.h"
 #include "player.h"
 #include "utils/attributes.h"
 #include "utils/enum_traits.h"
@@ -1842,7 +1843,7 @@ void DrawAutomap(const Surface &out)
 		}
 	}
 
-	if (AutoMapShowItems)
+	if (AutoMapShowItems || *GetOptions().Gameplay.disableSearch)
 		SearchAutomapItem(out, myPlayerOffset, 8, [](Point position) { return dItem[position.x][position.y] != 0; });
 #ifdef _DEBUG
 	if (IsDebugAutomapHighlightNeeded())

Source/items.cpp

@@ -1403,6 +1403,8 @@ _item_indexes RndUItem(Monster *monster)
 			return false;
 		if (IsAnyOf(item.itype, ItemType::Gold, ItemType::Misc))
 			return false;
+		if (sgGameInitInfo.bDisableSearch == 1 && item.iSpell == SpellID::Search)
+			return false;
 		return true;
 	});
 }
@@ -1414,6 +1416,8 @@ _item_indexes RndAllItems()
 
 	int itemMaxLevel = ItemsGetCurrlevel() * 2;
 	return GetItemIndexForDroppableItem(false, [&itemMaxLevel](const ItemData &item) {
+		if (sgGameInitInfo.bDisableSearch == 1 && item.iSpell == SpellID::Search)
+			return false;
 		if (itemMaxLevel < item.iMinMLvl)
 			return false;
 		return true;
@@ -1430,6 +1434,8 @@ _item_indexes RndTypeItems(ItemType itemType, int imid, int lvl)
 			return false;
 		if (imid != -1 && item.iMiscId != imid)
 			return false;
+		if (sgGameInitInfo.bDisableSearch == 1 && item.iSpell == SpellID::Search)
+			return false;
 		return true;
 	});
 }
@@ -1522,7 +1528,12 @@ void SetupBaseItem(Point position, _item_indexes idx, bool onlygood, bool sendms
 	GetSuperItemSpace(position, ii);
 	int curlv = ItemsGetCurrlevel();
 
-	SetupAllItems(*MyPlayer, item, idx, AdvanceRndSeed(), 2 * curlv, 1, onlygood, delta);
+	do {
+		auto originalPos = item.position;
+		item = {};
+		item.position = originalPos;
+		SetupAllItems(*MyPlayer, item, idx, AdvanceRndSeed(), 2 * curlv, 1, onlygood, delta, false);
+	} while (item._iSpell == SpellID::Search && sgGameInitInfo.bDisableSearch == 1);
 	TryRandomUniqueItem(item, idx, 2 * curlv, 1, onlygood, delta);
 	SetupItem(item);
 
@@ -2005,7 +2016,8 @@ void SpawnOnePremium(Item &premiumItem, int plvl, const Player &player)
 			    && premiumItem._iMinStr <= strength
 			    && premiumItem._iMinMag <= magic
 			    && premiumItem._iMinDex <= dexterity
-			    && premiumItem._iIvalue >= itemValue) {
+			    && premiumItem._iIvalue >= itemValue
+			    && (sgGameInitInfo.bDisableSearch != 1 || premiumItem._iSpell != SpellID::Search)) {
 				break;
 			}
 		}
@@ -2187,7 +2199,7 @@ void CreateMagicItem(Point position, int lvl, ItemType itemType, int imid, int i
 		SetupAllItems(*MyPlayer, item, idx, AdvanceRndSeed(), 2 * lvl, 1, true, delta);
 		TryRandomUniqueItem(item, idx, 2 * lvl, 1, true, delta);
 		SetupItem(item);
-		if (item._iCurs == icurs)
+		if (item._iCurs == icurs && (sgGameInitInfo.bDisableSearch != 1 || item._iSpell != SpellID::Search))
 			break;
 
 		idx = RndTypeItems(itemType, imid, lvl);
@@ -3250,6 +3262,8 @@ _item_indexes RndItemForMonsterLevel(int8_t monsterLevel)
 		return IDI_GOLD;
 
 	return GetItemIndexForDroppableItem(true, [&monsterLevel](const ItemData &item) {
+		if (sgGameInitInfo.bDisableSearch == 1 && item.iSpell == SpellID::Search)
+			return false;
 		return item.iMinMLvl <= monsterLevel;
 	});
 }
@@ -3460,7 +3474,12 @@ void SpawnItem(Monster &monster, Point position, bool sendmsg, bool spawn /*= fa
 	if (!gbIsHellfire && monster.type().type == MT_DIABLO)
 		mLevel -= 15;
 
-	SetupAllItems(*MyPlayer, item, idx, AdvanceRndSeed(), mLevel, uper, onlygood, false, false);
+	do {
+		auto originalPos = item.position;
+		item = {};
+		item.position = originalPos;
+		SetupAllItems(*MyPlayer, item, idx, AdvanceRndSeed(), mLevel, uper, onlygood, false, false);
+	} while (sgGameInitInfo.bDisableSearch == 1 && item._iSpell == SpellID::Search);
 	TryRandomUniqueItem(item, idx, mLevel, uper, onlygood, false);
 	SetupItem(item);
 
@@ -4476,10 +4495,12 @@ void SpawnWitch(int lvl)
 			if (i < PinnedItemCount + MaxPinnedBookCount && bookCount < pinnedBookCount) {
 				_item_indexes bookType = PinnedBookTypes[i - PinnedItemCount];
 				if (lvl >= AllItemsList[bookType].iMinMLvl) {
-					item._iSeed = AdvanceRndSeed();
-					SetRndSeed(item._iSeed);
-					DiscardRandomValues(1);
-					GetItemAttrs(item, bookType, lvl);
+					do {
+						item._iSeed = AdvanceRndSeed();
+						SetRndSeed(item._iSeed);
+						DiscardRandomValues(1);
+						GetItemAttrs(item, bookType, lvl);
+					} while (sgGameInitInfo.bDisableSearch == 1 && item._iSpell == SpellID::Search);
 					item._iCreateInfo = lvl | CF_WITCH;
 					item._iIdentified = true;
 					bookCount++;
@@ -4506,7 +4527,7 @@ void SpawnWitch(int lvl)
 				maxlvl = 2 * lvl;
 			if (maxlvl != -1)
 				GetItemBonus(*MyPlayer, item, maxlvl / 2, maxlvl, true, true);
-		} while (item._iIvalue > maxValue);
+		} while (item._iIvalue > maxValue || item._iSpell == SpellID::Search && sgGameInitInfo.bDisableSearch == 1);
 
 		item._iCreateInfo = lvl | CF_WITCH;
 		item._iIdentified = true;
@@ -4622,7 +4643,8 @@ void SpawnBoy(int lvl)
 	            || BoyItem._iMinStr > strength
 	            || BoyItem._iMinMag > magic
 	            || BoyItem._iMinDex > dexterity
-	            || BoyItem._iIvalue < ivalue)
+	            || BoyItem._iIvalue < ivalue
+	            || (BoyItem._iSpell == SpellID::Search && sgGameInitInfo.bDisableSearch == 1))
 	        && count < 250));
 	BoyItem._iCreateInfo = lvl | CF_BOY;
 	BoyItem._iIdentified = true;

Source/multi.cpp

@@ -523,6 +523,7 @@ void InitGameInfo()
 	sgGameInitInfo.bCowQuest = *options.Gameplay.cowQuest ? 1 : 0;
 	sgGameInitInfo.bFriendlyFire = *options.Gameplay.friendlyFire ? 1 : 0;
 	sgGameInitInfo.fullQuests = (!gbIsMultiplayer || *options.Gameplay.multiplayerFullQuests) ? 1 : 0;
+	sgGameInitInfo.bDisableSearch = *options.Gameplay.disableSearch ? 1 : 0;
 }
 
 void NetSendLoPri(uint8_t playerId, const std::byte *data, size_t size)

Source/multi.h

@@ -34,6 +34,7 @@ struct GameData {
 	uint8_t bCowQuest;
 	uint8_t bFriendlyFire;
 	uint8_t fullQuests;
+	uint8_t bDisableSearch;
 	/** Used to initialise the seed table for dungeon levels so players in multiplayer games generate the same layout */
 	uint32_t gameSeed[4];
 

Source/options.cpp

@@ -796,6 +796,7 @@ GameplayOptions::GameplayOptions()
     , randomizeQuests("Randomize Quests", OptionEntryFlags::CantChangeInGame, N_("Randomize Quests"), N_("Randomly selecting available quests for new games."), true)
     , showMonsterType("Show Monster Type", OptionEntryFlags::None, N_("Show Monster Type"), N_("Hovering over a monster will display the type of monster in the description box in the UI."), false)
     , showItemLabels("Show Item Labels", OptionEntryFlags::None, N_("Show Item Labels"), N_("Show labels for items on the ground when enabled."), false)
+    , disableSearch("Disable Search Spell", OptionEntryFlags::CantChangeInMultiPlayer, N_("Disable Search Spell"), N_("Search spell will not appear on Scrolls, Books, or Staves generated by monsters you kill or objects and vendors you interact with.  Set Monk class skill to Infravision.  Search effect always enabled when using the map."), false)
     , autoRefillBelt("Auto Refill Belt", OptionEntryFlags::None, N_("Auto Refill Belt"), N_("Refill belt from inventory when belt item is consumed."), false)
     , disableCripplingShrines("Disable Crippling Shrines", OptionEntryFlags::None, N_("Disable Crippling Shrines"), N_("When enabled Cauldrons, Fascinating Shrines, Goat Shrines, Ornate Shrines, Sacred Shrines and Murphy's Shrines are not able to be clicked on and labeled as disabled."), false)
     , quickCast("Quick Cast", OptionEntryFlags::None, N_("Quick Cast"), N_("Spell hotkeys instantly cast the spell, rather than switching the readied spell."), false)
@@ -835,6 +836,7 @@ std::vector<OptionEntryBase *> GameplayOptions::GetEntries()
 		&enemyHealthBar,
 		&showMonsterType,
 		&showItemLabels,
+		&disableSearch,
 		&enableFloatingNumbers,
 		&autoRefillBelt,
 		&autoEquipWeapons,

Source/options.h

@@ -608,6 +608,8 @@ struct GameplayOptions : OptionCategoryBase {
 	OptionEntryBoolean showMonsterType;
 	/** @brief Displays item labels for items on the ground.  */
 	OptionEntryBoolean showItemLabels;
+	/** @brief Search spell will not appear on Scrolls, Books, or Staves generated by monsters you kill or objects and vendors you interact with.  Set Monk class skill to Infravision.  */
+	OptionEntryBoolean disableSearch;
 	/** @brief Refill belt from inventory, or rather, use potions/scrolls from inventory first when belt item is consumed.  */
 	OptionEntryBoolean autoRefillBelt;
 	/** @brief Locally disable clicking on shrines which permanently cripple character. */

Source/panels/spell_book.cpp

@@ -17,6 +17,7 @@
 #include "engine/render/text_render.hpp"
 #include "game_mode.hpp"
 #include "missiles.h"
+#include "options.h"
 #include "panels/spell_icons.hpp"
 #include "panels/ui_panels.hpp"
 #include "player.h"
@@ -64,7 +65,7 @@ SpellID GetSpellFromSpellPage(size_t page, size_t entry)
 		case HeroClass::Sorcerer:
 			return SpellID::StaffRecharge;
 		case HeroClass::Monk:
-			return SpellID::Search;
+			return *GetOptions().Gameplay.disableSearch ? SpellID::Infravision : SpellID::Search;
 		case HeroClass::Bard:
 			return SpellID::Identify;
 		case HeroClass::Barbarian:
@@ -89,8 +90,11 @@ void PrintSBookStr(const Surface &out, Point position, std::string_view text, Ui
 SpellType GetSBookTrans(SpellID ii, bool townok)
 {
 	Player &player = *InspectPlayer;
-	if ((player._pClass == HeroClass::Monk) && (ii == SpellID::Search))
+
+	if (player._pClass == HeroClass::Monk && ((ii == SpellID::Infravision && *GetOptions().Gameplay.disableSearch) || (ii == SpellID::Search && !*GetOptions().Gameplay.disableSearch))) {
 		return SpellType::Skill;
+	}
+
 	SpellType st = SpellType::Spell;
 	if ((player._pISpells & GetSpellBitmask(ii)) != 0) {
 		st = SpellType::Charges;

Source/panels/spell_list.cpp

@@ -57,8 +57,11 @@ bool GetSpellListSelection(SpellID &pSpell, SpellType &pSplType)
 		if (spellListItem.isSelected) {
 			pSpell = spellListItem.id;
 			pSplType = spellListItem.type;
-			if (myPlayer._pClass == HeroClass::Monk && spellListItem.id == SpellID::Search)
-				pSplType = SpellType::Skill;
+			if (myPlayer._pClass == HeroClass::Monk) {
+				if ((spellListItem.id == SpellID::Search && !*GetOptions().Gameplay.disableSearch) || (spellListItem.id == SpellID::Infravision && *GetOptions().Gameplay.disableSearch)) {
+					pSplType = SpellType::Skill;
+				}
+			}
 			return true;
 		}
 	}

Source/player.cpp

@@ -2463,6 +2463,12 @@ void InitPlayer(Player &player, bool firstTime)
 
 	player._pAblSpells = GetSpellBitmask(GetPlayerStartingLoadoutForClass(player._pClass).skill);
 
+	// Override for Monk: if disableSearch is enabled, use Infravision instead of Search.
+	player._pAblSpells = GetSpellBitmask(
+	    player._pClass == HeroClass::Monk && *GetOptions().Gameplay.disableSearch
+	        ? SpellID::Infravision
+	        : GetPlayerStartingLoadoutForClass(player._pClass).skill);
+
 	player._pInvincible = false;
 
 	if (&player == MyPlayer) {