Simplify Gameplay Type identification using an enum

dont use a bunch of bools haha

Author: poco0317

Themes/_fallback/Scripts/02 Branches.lua

@@ -33,9 +33,10 @@ function GameOverOrContinue()
 end
 
 function ToGameplay()
-	if GAMESTATE:IsPracticeMode() then
+	local mode = GAMESTATE:GetGameplayMode()
+	if mode == "GameplayMode_Practice" then
 		return "ScreenGameplayPractice"
-	elseif GAMESTATE:IsReplayMode() then
+	elseif mode == "GameplayMode_Replay" then
 		return "ScreenGameplayReplay"
 	else
 		return "ScreenGameplay"

src/Etterna/Models/Misc/GameConstantsAndTypes.cpp

@@ -95,6 +95,14 @@ static const char* HealthStateNames[] = {
 XToString(HealthState);
 LuaXType(HealthState);
 
+static const char* GameplayModeNames[] = {
+	"Normal",
+	"Practice",
+	"Replay",
+};
+XToString(GameplayMode);
+LuaXType(GameplayMode);
+
 static const char* SortOrderNames[] = {
 	"Preferred", "Group",	 "Title",	 "BPM",		 "Popularity",
 	"TopGrades", "Artist",	"Genre",	 "ModeMenu",   "Recent",

src/Etterna/Models/Misc/GameConstantsAndTypes.h

@@ -18,6 +18,15 @@ const int MIN_METER = 1;
  */
 const int MAX_METER = 35;
 
+enum GameplayMode
+{
+	GameplayMode_Normal,
+	GameplayMode_Practice,
+	GameplayMode_Replay,
+	NUM_GameplayMode,
+	GameplayMode_Invalid
+};
+
 enum Skillset
 {
 	Skill_Overall,

src/Etterna/Singletons/GameState.cpp

@@ -92,6 +92,7 @@ GameState::GameState()
   , m_pCurSteps(Message_CurrentStepsP1Changed)
   , m_bGameplayLeadIn(Message_GameplayLeadInChanged)
   , m_sEditLocalProfileID(Message_EditLocalProfileIDChanged)
+  , m_gameplayMode(Message_GameplayModeChanged)
 {
 	g_pImpl = new GameStateImpl;
 
@@ -103,6 +104,8 @@ GameState::GameState()
 
 	m_iStageSeed = m_iGameSeed = 0;
 
+	m_gameplayMode.Set(GameplayMode_Normal);
+
 	m_PlayMode.Set(
 	  PlayMode_Invalid); // used by IsPlayerEnabled before the first screen
 	m_bSideIsJoined =
@@ -1862,8 +1865,12 @@ class LunaGameState : public Luna<GameState>
 		GamePreferences::m_AutoPlay.Set(p->m_pPlayerState->m_PlayerController);
 		return 0;
 	}
-	DEFINE_METHOD(IsPracticeMode, IsPracticeMode())
-	DEFINE_METHOD(IsReplayMode, IsReplayMode())
+	static int GetGameplayMode(T* p, lua_State* L)
+	{
+		GameplayMode mode = p->GetGameplayMode();
+		LuaHelpers::Push(L, mode);
+		return 1;
+	}
 
 	DEFINE_METHOD(GetEtternaVersion, GetEtternaVersion())
 	LunaGameState()
@@ -1956,8 +1963,7 @@ class LunaGameState : public Luna<GameState>
 		ADD_METHOD(UpdateDiscordMenu);
 		ADD_METHOD(UpdateDiscordPresence);
 		ADD_METHOD(IsPaused);
-		ADD_METHOD(IsPracticeMode);
-		ADD_METHOD(IsReplayMode);
+		ADD_METHOD(GetGameplayMode);
 	}
 };
 

src/Etterna/Singletons/GameState.h

@@ -314,12 +314,9 @@ class GameState
 	Profile* GetEditLocalProfile();
 	bool m_bIsChartPreviewActive;
 
-	// is the game in a practice state
-	bool m_practice = false;
-	// is the game in a replay state
-	bool m_replay = false;
-	bool IsPracticeMode() { return m_practice; }
-	bool IsReplayMode() { return m_replay; }
+	// Current mode of Gameplay
+	BroadcastOnChange<GameplayMode> m_gameplayMode;
+	GameplayMode GetGameplayMode() { return m_gameplayMode; }
 
 	// Discord Rich Presence
 	void discordInit();

src/Etterna/Singletons/MessageManager.cpp

@@ -1,4 +1,4 @@
-#include "Etterna/Globals/global.h"
+#include "Etterna/Globals/global.h"
 #include "Etterna/Models/Misc/EnumHelper.h"
 #include "Etterna/Models/Misc/Foreach.h"
 #include "LuaManager.h"
@@ -25,6 +25,7 @@ static const char* MessageIDNames[] = {
 	"CurrentTrailP1Changed",
 	"CurrentTrailP2Changed",
 	"GameplayLeadInChanged",
+	"GameplayModeChanged",
 	"EditStepsTypeChanged",
 	"EditCourseDifficultyChanged",
 	"EditSourceStepsChanged",

src/Etterna/Singletons/MessageManager.h

@@ -1,4 +1,4 @@
-#ifndef MessageManager_H
+#ifndef MessageManager_H
 #define MessageManager_H
 
 #include "LuaManager.h"
@@ -20,6 +20,7 @@ enum MessageID
 	Message_CurrentTrailP1Changed,
 	Message_CurrentTrailP2Changed,
 	Message_GameplayLeadInChanged,
+	Message_GameplayModeChanged,
 	Message_EditStepsTypeChanged,
 	Message_EditCourseDifficultyChanged,
 	Message_EditSourceStepsChanged,