Better save/load GUI:

* Show "..." when saving
* Keep the save box menu list highlighted
* Show "Game saved successfully!" briefly afer saving
* Ask the user for a savegame name if they're not entered one while an activity is running

Author: Causeless

Data/Base.rte/GUIs/SaveLoadMenuGUI.ini

@@ -171,7 +171,7 @@ Anchor = Left, Top
 ToolTip = None
 Text = Delete Save
 
-[ActivityCannotBeSavedWarning]
+[DescriptionLabel]
 ControlType = LABEL
 Parent = CollectionBoxSaveGameMenu
 X = 7
@@ -180,9 +180,8 @@ Width = 287
 Height = 20
 Visible = True
 Enabled = True
-Name = ActivityCannotBeSavedWarning
+Name = DescriptionLabel
 Anchor = Left, Top
-Text = The currently played activity does not allow saving.
 HAlignment = Centre
 VAlignment = Centre
 

Source/GUI/GUIListBox.cpp

@@ -61,6 +61,10 @@ void GUIListBox::Create(GUIProperties* Props) {
 	bool Multi = false;
 	Props->GetValue("MultiSelect", &Multi);
 	SetMultiSelect(Multi);
+
+	bool highlightAsIfAlwaysFocused = false;
+	Props->GetValue("HighlightAsIfAlwaysFocused", &highlightAsIfAlwaysFocused);
+	SetHighlightAsIfAlwaysFocused(highlightAsIfAlwaysFocused);
 }
 
 void GUIListBox::Destroy() {
@@ -128,6 +132,10 @@ void GUIListBox::ApplyProperties(GUIProperties* Props) {
 	m_Properties.GetValue("MultiSelect", &Multi);
 	SetMultiSelect(Multi);
 
+	bool highlightAsIfAlwaysFocused = false;
+	m_Properties.GetValue("HighlightAsIfAlwaysFocused", &highlightAsIfAlwaysFocused);
+	SetHighlightAsIfAlwaysFocused(highlightAsIfAlwaysFocused);
+
 	// Rebuild the bitmap
 	BuildBitmap(true, true);
 }

Source/GUI/GUIListPanel.cpp

@@ -26,6 +26,7 @@ GUIListPanel::GUIListPanel(GUIManager* Manager) :
 	m_CapturedHorz = false;
 	m_CapturedVert = false;
 	m_ExternalCapture = false;
+	m_HighlightAsIfAlwaysFocused = false;
 	m_HotTracking = false;
 	m_HorzScrollEnabled = true;
 	m_VertScrollEnabled = true;
@@ -55,6 +56,7 @@ GUIListPanel::GUIListPanel() :
 	m_CapturedHorz = false;
 	m_CapturedVert = false;
 	m_ExternalCapture = false;
+	m_HighlightAsIfAlwaysFocused = false;
 	m_HotTracking = false;
 	m_HorzScrollEnabled = true;
 	m_VertScrollEnabled = true;
@@ -340,7 +342,7 @@ void GUIListPanel::BuildDrawBitmap() {
 			}
 
 			// Selected item
-			if (I->m_Selected && m_GotFocus) {
+			if (I->m_Selected && (m_GotFocus || m_HighlightAsIfAlwaysFocused)) {
 				m_DrawBitmap->DrawLine(4, itemY + 1, m_Width - (m_VertScroll->_GetVisible() ? m_VertScroll->GetWidth() + 2 : 5), itemY + 1, m_SelectedColorIndex);
 				m_DrawBitmap->DrawLine(4, itemY + itemHeight, m_Width - (m_VertScroll->_GetVisible() ? m_VertScroll->GetWidth() + 2 : 5), itemY + itemHeight, m_SelectedColorIndex);
 				m_Font->SetColor(m_FontSelectColor);
@@ -369,10 +371,10 @@ void GUIListPanel::BuildDrawBitmap() {
 			// Selected item
 			if (I->m_Selected) {
 				m_Font->SetColor(m_SelectedColorIndex);
-				m_DrawBitmap->DrawRectangle(1, itemY, itemWidth - 2, m_Font->GetFontHeight(), m_SelectedColorIndex, m_GotFocus); // Filled if we have focus
+				m_DrawBitmap->DrawRectangle(1, itemY, itemWidth - 2, m_Font->GetFontHeight(), m_SelectedColorIndex, (m_GotFocus || m_HighlightAsIfAlwaysFocused)); // Filled if we have focus
 			}
 
-			if (I->m_Selected && m_GotFocus) {
+			if (I->m_Selected && (m_GotFocus || m_HighlightAsIfAlwaysFocused)) {
 				m_Font->SetColor(m_FontSelectColor);
 				m_Font->DrawAligned(m_DrawBitmap, itemX - 3 + itemWidth - (m_VertScroll->_GetVisible() ? m_VertScroll->GetWidth() : 0), itemY, I->m_RightText, GUIFont::Right);
 				m_Font->Draw(m_DrawBitmap, 4 - itemX, itemY, I->m_Name);

Source/GUI/GUIListPanel.h

@@ -155,6 +155,14 @@ namespace RTE {
 		/// Gets the multi-selection value.
 		bool GetMultiSelect() const;
 
+		/// Sets the highlight as if always focused value.
+		/// @param highlightAsIfAlwaysFocused Whether to highlight as if always focused.
+		void SetHighlightAsIfAlwaysFocused(bool value) { m_HighlightAsIfAlwaysFocused = value; }
+
+		/// Gets the multi-selection value.
+		/// @return Whether to highlight as if always selected.
+		bool GetHighlightAsIfAlwaysFocused() const { return m_HighlightAsIfAlwaysFocused; }
+
 		/// Sets the hot tracking value.
 		/// @param HotTrack HotTrack.
 		void SetHotTracking(bool HotTrack);
@@ -295,6 +303,7 @@ namespace RTE {
 		bool m_CapturedHorz;
 		bool m_CapturedVert;
 		bool m_ExternalCapture;
+		bool m_HighlightAsIfAlwaysFocused; //!< Whether the panel should be highlighted as if it was always focused, even if it doesn't have focus.
 
 		int m_LargestWidth;
 		bool m_MultiSelect;

Source/Menus/SaveLoadMenuGUI.cpp

@@ -59,13 +59,14 @@ SaveLoadMenuGUI::SaveLoadMenuGUI(AllegroScreen* guiScreen, GUIInputWrapper* guiI
 	m_SaveGamesListBox->SetMouseScrolling(true);
 	m_SaveGamesListBox->SetScrollBarThickness(15);
 	m_SaveGamesListBox->SetScrollBarPadding(2);
+	m_SaveGamesListBox->SetHighlightAsIfAlwaysFocused(true);
 
 	m_SaveGameName = dynamic_cast<GUITextBox*>(m_GUIControlManager->GetControl("SaveGameName"));
 	m_LoadButton = dynamic_cast<GUIButton*>(m_GUIControlManager->GetControl("ButtonLoad"));
 	m_CreateButton = dynamic_cast<GUIButton*>(m_GUIControlManager->GetControl("ButtonCreate"));
 	m_OverwriteButton = dynamic_cast<GUIButton*>(m_GUIControlManager->GetControl("ButtonOverwrite"));
 	m_DeleteButton = dynamic_cast<GUIButton*>(m_GUIControlManager->GetControl("ButtonDelete"));
-	m_ActivityCannotBeSavedLabel = dynamic_cast<GUILabel*>(m_GUIControlManager->GetControl("ActivityCannotBeSavedWarning"));
+	m_DescriptionLabel = dynamic_cast<GUILabel*>(m_GUIControlManager->GetControl("DescriptionLabel"));
 
 	m_ConfirmationBox = dynamic_cast<GUICollectionBox*>(m_GUIControlManager->GetControl("ConfirmDialog"));
 	m_ConfirmationBox->CenterInParent(true, true);
@@ -75,6 +76,8 @@ SaveLoadMenuGUI::SaveLoadMenuGUI(AllegroScreen* guiScreen, GUIInputWrapper* guiI
 	m_CancelButton = dynamic_cast<GUIButton*>(m_GUIControlManager->GetControl("CancelButton"));
 
 	m_SaveGamesFetched = false;
+	m_WasSaving = false;
+	m_SavingBlinkTimer.SetRealTimeLimitS(1.5f);
 
 	SwitchToConfirmDialogMode(ConfirmDialogMode::None);
 }
@@ -85,7 +88,6 @@ void SaveLoadMenuGUI::PopulateSaveGamesList() {
 	}
 
 	m_SaveGames.clear();
-	m_SaveGameName->SetText("");
 
 	m_GUIControlManager->GetManager()->SetFocus(nullptr);
 
@@ -253,8 +255,41 @@ void SaveLoadMenuGUI::UpdateButtonEnabledStates() {
 
 	m_LoadButton->SetEnabled(saveExists);
 	m_DeleteButton->SetEnabled(saveExists);
+	
+	m_DescriptionLabel->SetText("");
+
+	bool isSaving = g_ActivityMan.IsCurrentlySaving();
+	if (isSaving != m_WasSaving) {
+		m_SavingBlinkTimer.Reset();
+	}
+
+	if (g_ActivityMan.GetActivity()) {
+		if (isSaving) {
+			const char* saveText = "";
+			switch (m_SavingBlinkTimer.StepReal(500, 3)) {
+				case 0:
+					saveText = "Saving game, please wait.  ";
+					break;
+				case 1:
+					saveText = "Saving game, please wait.. ";
+					break;
+				case 2:
+					saveText = "Saving game, please wait...";
+					break;
+			}
+
+			m_DescriptionLabel->SetText(saveText);
+		} else if (!m_SavingBlinkTimer.IsPastRealTimeLimit()) {
+			// Show "Saved!" for a little while after saving
+			m_DescriptionLabel->SetText("Game saved successfully!");
+		} else if (!g_ActivityMan.GetActivity()->GetAllowsUserSaving()) {
+			m_DescriptionLabel->SetText("The currently played activity does not allow saving.");
+		} else if (m_SaveGameName->GetText().empty()) {
+			m_DescriptionLabel->SetText("Enter a name for your savegame.");
+		}
+	}
 
-	m_ActivityCannotBeSavedLabel->SetVisible(g_ActivityMan.GetActivity() && !g_ActivityMan.GetActivity()->GetAllowsUserSaving());
+	m_WasSaving = isSaving;
 }
 
 void SaveLoadMenuGUI::SwitchToConfirmDialogMode(ConfirmDialogMode mode) {

Source/Menus/SaveLoadMenuGUI.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include "Timer.h"
+
 #include <filesystem>
 #include <vector>
 #include <string>
@@ -63,8 +65,11 @@ namespace RTE {
 
 		std::vector<SaveRecord> m_SaveGames; //!< Contains all SaveGames.
 
+		bool m_WasSaving; //!< Whether we were just saving or not.
 		bool m_SaveGamesFetched; //!< Whether the savegames list has been fetched.
 
+		Timer m_SavingBlinkTimer; //!< Save text blink timer, to increment text (i.e "Saving...")
+
 		/// GUI elements that compose the Mod Manager menu screen.
 		GUICollectionBox* m_SaveGameMenuBox;
 		GUIButton* m_BackToMainButton;
@@ -74,7 +79,7 @@ namespace RTE {
 		GUIButton* m_OverwriteButton;
 		GUIButton* m_DeleteButton;
 		GUIListBox* m_SaveGamesListBox;
-		GUILabel* m_ActivityCannotBeSavedLabel;
+		GUILabel* m_DescriptionLabel;
 		GUIComboBox* m_OrderByComboBox;
 
 		// The confirmation box and its controls

Source/System/Timer.h

@@ -144,6 +144,16 @@ namespace RTE {
 		/// @param period An int with the alternating period in ms. The time specified here is how long it will take for the switch to alternate.
 		/// @return Whether the elapsed time is in the first state or not.
 		bool AlternateReal(int period) const { return (static_cast<int>(GetElapsedRealTimeMS()) % (period * 2)) > period; }
+
+		/// Returns an incrementing int, depending on whether the elapsed time falls in repeating intervals which divide it.
+		/// This is useful for blink animations etc, for example ".", "..", "...", etc.
+		/// @param period An int with the period in ms. The time specified here is how long it will take for the int to increment
+		/// @param steps The number of steps to increment the int by. For example, if period is 1000 and steps is 5, then the int will increment every 200 ms.
+		/// @return Whether the elapsed time is in the first state or not.
+		int StepReal(int period, int steps) const { 
+			int elapsed = static_cast<int>(GetElapsedRealTimeMS());
+			return (elapsed / period) % steps; 
+		}
 #pragma endregion
 
 #pragma region Simulation Time