Added new game config for enabling MoveRoute debugging

Author: florianessl

src/game_config_game.cpp

@@ -177,6 +177,10 @@ void Game_ConfigGame::LoadFromArgs(CmdlineParser& cp) {
 
 			continue;
 		}
+		if (cp.ParseNext(arg, 0, { "--debug-routes", "--debug-move-routes" })) {
+			debug_moveroutes.Set(true);
+			continue;
+		}
 
 		cp.SkipNext();
 	}
@@ -229,6 +233,8 @@ void Game_ConfigGame::LoadFromStream(Filesystem_Stream::InputStream& is) {
 	if (patch_direct_menu.FromIni(ini)) {
 		patch_override = true;
 	}
+
+	debug_moveroutes.FromIni(ini);
 }
 
 void Game_ConfigGame::PrintActivePatches() {

src/game_config_game.h

@@ -48,6 +48,7 @@ struct Game_ConfigGame {
 	BoolConfigParam patch_rpg2k3_commands{ "RPG2k3 Event Commands", "Enable support for RPG2k3 event commands", "Patch", "RPG2k3Commands", false };
 	ConfigParam<int> patch_anti_lag_switch{ "Anti-Lag Switch", "Disable event page refreshes when switch is set", "Patch", "AntiLagSwitch", 0 };
 	ConfigParam<int> patch_direct_menu{ "Direct Menu", " Allows direct access to subscreens of the default menu", "Patch", "DirectMenu", 0 };
+	BoolConfigParam debug_moveroutes{ "Debug MoveRoutes", "Generate Interpreter warnings whenever \"MoveRoute\" commands are blocked", "Game", "DebugMoveRoutes", false };
 
 	// Command line only
 	BoolConfigParam patch_support{ "Support patches", "When OFF all patch support is disabled", "", "", true };

src/game_interpreter.cpp

@@ -456,7 +456,7 @@ void Game_Interpreter::Update(bool reset_loop_count) {
 		}
 
 		if (_state.wait_movement) {
-			if (ShouldAssertMoveRoutes()) {
+			if (Player::game_config.debug_moveroutes.Get()) {
 				Debug::AssertBlockedMoves(main_flag);
 			}
 			if (Game_Map::IsAnyMovePending()) {
@@ -5887,10 +5887,3 @@ bool Game_Interpreter_Inspector::IsInActiveExcecution(Game_CommonEvent const& ce
 	}
 	return ce.interpreter && ce.interpreter->IsRunning();
 }
-
-bool Game_Interpreter::ShouldAssertMoveRoutes() const {
-	//FIXME: Needs liblcf update
-	//return (main_flag && (_state.easyrpg_debug_flags & lcf::rpg::SaveEventExecState::DebugFlags_warn_on_blocked_movement_main) > 0)
-	//	|| (!main_flag && (_state.easyrpg_debug_flags & lcf::rpg::SaveEventExecState::DebugFlags_warn_on_blocked_movement_parallel) > 0);
-	return true;
-}

src/game_interpreter.h

@@ -130,7 +130,6 @@ class Game_Interpreter : public Game_BaseInterpreterContext
 	/** @return true if wait command (time or key) is active. Used by 2k3 battle system */
 	bool IsWaitingForWaitCommand() const;
 
-	bool ShouldAssertMoveRoutes() const;
 protected:
 	static constexpr int loop_limit = 10000;
 	static constexpr int call_stack_limit = 1000;

src/player.cpp

@@ -1549,6 +1549,11 @@ Debug options:
  --start-position X Y Overwrite the party start position and move the party to
                       position (X, Y).
                       Incompatible with --load-game-id.
+ --debug-routes       This option enables a range of asserts whenever a
+                      scripting stack is halted due to a WaitForAllMovement
+                      command. If the Interpreter is not able to resume operation,
+                      due to a blocked route, detailed warnings will be printed to
+                      the output.
  --test-play          Enable TestPlay (Debug) mode.
 
 Other options: