Added settings flag for always displaying unheld items when in strategic mode

Added support for flag to gameplay settings menu and held device

Author: garethyr

Entities/HeldDevice.cpp

@@ -578,7 +578,12 @@ void HeldDevice::DrawHUD(BITMAP *pTargetBitmap, const Vector &targetPos, int whi
 			if (pSymbolFont && pTextFont) {
 				const Activity *activity = g_ActivityMan.GetActivity();
 				float unheldItemDisplayRange = activity->GetActivityState() == Activity::ActivityState::Running ? g_SettingsMan.GetUnheldItemsHUDDisplayRange() : -1.0F;
+				if (g_SettingsMan.AlwaysDisplayUnheldItemsInStrategicMode()) {
+					const GameActivity *gameActivity = dynamic_cast<const GameActivity *>(activity);
+					if (gameActivity && gameActivity->GetViewState(viewingPlayer) == GameActivity::ViewState::ActorSelect) { unheldItemDisplayRange = -1.0F; }
 				}
+				// Note - to avoid item HUDs flickering in and out, we need to add a little leeway when hiding them if they're already displayed.
+				if (m_SeenByPlayer.at(viewingPlayer) && unheldItemDisplayRange > 0) { unheldItemDisplayRange += 3.0F; }
 				m_SeenByPlayer.at(viewingPlayer) = unheldItemDisplayRange < 0 || (unheldItemDisplayRange > 0 && g_SceneMan.ShortestDistance(m_Pos, g_SceneMan.GetScrollTarget(whichScreen), g_SceneMan.SceneWrapsX()).GetMagnitude() < unheldItemDisplayRange);
 
 				if (m_SeenByPlayer.at(viewingPlayer)) {

Managers/SettingsMan.cpp

@@ -22,6 +22,7 @@ namespace RTE {
 		m_FlashOnBrainDamage = true;
 		m_BlipOnRevealUnseen = true;
 		m_UnheldItemsHUDDisplayRange = 25;
+		m_AlwaysDisplayUnheldItemsInStrategicMode = true;
 		m_EndlessMetaGameMode = false;
 		m_EnableCrabBombs = false;
 		m_CrabBombThreshold = 42;
@@ -139,6 +140,8 @@ namespace RTE {
 			reader >> g_MovableMan.m_MaxDroppedItems;
 		} else if (propName == "UnheldItemsHUDDisplayRange") {
 			SetUnheldItemsHUDDisplayRange(std::stof(reader.ReadPropValue()));
+		} else if (propName == "AlwaysDisplayUnheldItemsInStrategicMode") {
+			reader >> m_AlwaysDisplayUnheldItemsInStrategicMode;
 		} else if (propName == "SloMoThreshold") {
 			reader >> g_MovableMan.m_SloMoThreshold;
 		} else if (propName == "SloMoDurationMS") {
@@ -314,6 +317,7 @@ namespace RTE {
 		writer.NewPropertyWithValue("BlipOnRevealUnseen", m_BlipOnRevealUnseen);
 		writer.NewPropertyWithValue("MaxUnheldItems", g_MovableMan.m_MaxDroppedItems);
 		writer.NewPropertyWithValue("UnheldItemsHUDDisplayRange", m_UnheldItemsHUDDisplayRange);
+		writer.NewPropertyWithValue("AlwaysDisplayUnheldItemsInStrategicMode", m_AlwaysDisplayUnheldItemsInStrategicMode);
 		writer.NewPropertyWithValue("SloMoThreshold", g_MovableMan.m_SloMoThreshold);
 		writer.NewPropertyWithValue("SloMoDurationMS", g_MovableMan.m_SloMoDuration);
 		writer.NewPropertyWithValue("EndlessMetaGameMode", m_EndlessMetaGameMode);

Managers/SettingsMan.h

@@ -107,6 +107,18 @@ namespace RTE {
 		/// <param name="newRadius">The new range in which devices on Scene will show the pick-up HUD, in pixels. 0 means HUDs are hidden, -1 means unlimited range.</param>
 		void SetUnheldItemsHUDDisplayRange(float newRadius) { m_UnheldItemsHUDDisplayRange = std::floor(newRadius); }
 
+		/// <summary>
+		/// Gets whether or not devices on Scene should always show their pick-up HUD when the player is in strategic mode.
+		/// </summary>
+		/// <returns>Whether or not devices on Scene should always show their pick-up HUD when the player is in strategic mode.</returns>
+		bool AlwaysDisplayUnheldItemsInStrategicMode() const { return m_AlwaysDisplayUnheldItemsInStrategicMode; }
+
+		/// <summary>
+		/// Sets whether or not devices on Scene should always show their pick-up HUD when the player is in strategic mode.
+		/// </summary>
+		/// <param name="shouldShowUnheldItemsInStrategicMode">Whether or not devices on Scene should always show their pick-up HUD when the player is in strategic mode.</param>
+		void SetAlwaysDisplayUnheldItemsInStrategicMode(bool shouldShowUnheldItemsInStrategicMode) { m_AlwaysDisplayUnheldItemsInStrategicMode = shouldShowUnheldItemsInStrategicMode; }
+
 		/// <summary>
 		/// Whether red and white flashes appear when brain is damaged.
 		/// </summary>
@@ -414,6 +426,7 @@ namespace RTE {
 		bool m_FlashOnBrainDamage; //!< Whether red flashes on brain damage are on or off.
 		bool m_BlipOnRevealUnseen; //!< Blip if unseen is revealed.
 		float m_UnheldItemsHUDDisplayRange; //!< Range in which devices on Scene will show the pick-up HUD, in pixels. 0 means HUDs are hidden, -1 means unlimited range.
+		bool m_AlwaysDisplayUnheldItemsInStrategicMode; //!< Whether or not devices on Scene should always show their pick-up HUD when when the player is in strategic mode.
 		bool m_EndlessMetaGameMode; //!< Endless MetaGame mode.
 		bool m_EnableCrabBombs; //!< Whether all actors (except Brains and Doors) should be annihilated if a number exceeding the crab bomb threshold is released at once.
 		int m_CrabBombThreshold; //!< The number of crabs needed to be released at once to trigger the crab bomb effect.

Menus/SettingsGameplayGUI.cpp

@@ -58,6 +58,9 @@ namespace RTE {
 		}
 		m_UnheldItemsHUDDisplayRangeLabel = dynamic_cast<GUILabel *>(m_GUIControlManager->GetControl("LabelUnheldItemsHUDRangeValue"));
 		UpdateUnheldItemsHUDDisplayRange();
+
+		m_AlwaysDisplayUnheldItemsInStrategicModeCheckbox = dynamic_cast<GUICheckbox *>(m_GUIControlManager->GetControl("CheckboxAlwaysShowUnheldItemsInStrategicMode"));
+		m_AlwaysDisplayUnheldItemsInStrategicModeCheckbox->SetCheck(g_SettingsMan.AlwaysDisplayUnheldItemsInStrategicMode());
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -129,6 +132,8 @@ namespace RTE {
 				UpdateCrabBombThresholdTextbox();
 			} else if (guiEvent.GetControl() == m_UnheldItemsHUDDisplayRangeSlider) {
 				UpdateUnheldItemsHUDDisplayRange();
+			} else if (guiEvent.GetControl() == m_AlwaysDisplayUnheldItemsInStrategicModeCheckbox) {
+				g_SettingsMan.SetAlwaysDisplayUnheldItemsInStrategicMode(m_AlwaysDisplayUnheldItemsInStrategicModeCheckbox->GetCheck());
 			// Update both textboxes when clicking the main CollectionBox, otherwise clicking off focused textboxes does not remove their focus or update the setting values and they will still capture keyboard input.
 			} else if (guiEvent.GetControl() == m_GameplaySettingsBox && guiEvent.GetMsg() == GUICollectionBox::Clicked && !m_GameplaySettingsBox->HasFocus()) {
 				UpdateMaxUnheldItemsTextbox();

Menus/SettingsGameplayGUI.h

@@ -59,6 +59,7 @@ namespace RTE {
 		GUITextBox *m_CrabBombThresholdTextbox;
 		GUISlider *m_UnheldItemsHUDDisplayRangeSlider;
 		GUILabel *m_UnheldItemsHUDDisplayRangeLabel;
+		GUICheckbox *m_AlwaysDisplayUnheldItemsInStrategicModeCheckbox;
 
 #pragma region Gameplay Settings Handling
 		/// <summary>