PowerMode2003: Some minor refactoring & added documentation

Author: florianessl

src/game_map.cpp

@@ -284,8 +284,6 @@ void Game_Map::SetupFromSave(
 	// FIXME: RPG_RT compatibility bug: On async platforms, panorama async loading can
 	// cause panorama chunks to be out of sync.
 	Game_Map::Parallax::ChangeBG(GetParallaxParams());
-
-	RuntimePatches::PowerMode2003::Init();
 }
 
 std::unique_ptr<lcf::rpg::Map> Game_Map::LoadMapFile(int map_id) {

src/game_runtime_patches.cpp

@@ -185,6 +185,27 @@ void RuntimePatches::DetermineActivePatches(std::vector<std::string>& patches) {
 #endif
 }
 
+void RuntimePatches::OnResetGameObjects() {
+#ifdef NO_RUNTIME_PATCHES
+	// no-op
+	return;
+#endif
+	if (Player::game_config.patch_powermode.Get()) {
+		Player::game_config.new_game.Set(true);
+		Main_Data::game_variables->Set(PowerMode2003::PM_VAR_CR0, FileFinder::HasSavegame() ? 1 : 0);
+	}
+}
+
+void RuntimePatches::OnLoadSavegame() {
+#ifdef NO_RUNTIME_PATCHES
+	// no-op
+	return;
+#endif
+	if (Player::game_config.patch_powermode.Get()) {
+		Main_Data::game_variables->Set(PowerMode2003::PM_VAR_CR0, FileFinder::HasSavegame() ? 1 : 0);
+	}
+}
+
 void RuntimePatches::OnVariableChanged(int variable_id) {
 #ifdef NO_RUNTIME_PATCHES
 	// no-op
@@ -195,6 +216,7 @@ void RuntimePatches::OnVariableChanged(int variable_id) {
 		PowerMode2003::HandleVariableHooks(variable_id);
 	}
 }
+
 void RuntimePatches::OnVariableChanged(std::initializer_list<int> variable_ids) {
 #ifdef NO_RUNTIME_PATCHES
 	// no-op
@@ -436,6 +458,27 @@ bool RuntimePatches::GuardRevamp::OverrideDamageAdjustment(int& dmg, const Game_
 }
 
 namespace RuntimePatches::PowerMode2003 {
+	void HandleCommands() {
+		int op = Main_Data::game_variables->Get(PM_VAR_CR0);
+		if (op == 255 && FileFinder::HasSavegame()) {
+			Scene::instance->SetRequestedScene(std::make_shared<Scene_Load>());
+		} else if (op == 254) {
+			Player::exit_flag = true;
+		}
+		Main_Data::game_variables->Set(PM_VAR_CR0, FileFinder::HasSavegame() ? 1 : 0);
+	}
+
+	void HandleMouse() {
+#if !defined(USE_MOUSE_OR_TOUCH) || !defined(SUPPORT_MOUSE_OR_TOUCH)
+		Output::Warning("PowerMode2003: Mouse input is not supported on this platform");
+		return;
+#endif
+		Point mouse_pos = Input::GetMousePosition();
+		Main_Data::game_variables->Set(PM_VAR_MCOORDX, mouse_pos.x);
+		Main_Data::game_variables->Set(PM_VAR_MCOORDY, mouse_pos.y);
+
+	}
+
 	void HandleKeyboard() {
 #if !defined(SUPPORT_KEYBOARD)
 		Output::Warning("PowerMode2003: Keyboard input is not supported on this platform");
@@ -511,17 +554,6 @@ namespace RuntimePatches::PowerMode2003 {
 	}
 }
 
-void RuntimePatches::PowerMode2003::Init() {
-#ifdef NO_RUNTIME_PATCHES
-	// no-op
-	return;
-#endif
-	if (Player::game_config.patch_powermode.Get()) {
-		Player::game_config.new_game.Set(true);
-		Main_Data::game_variables->Set(PM_VAR_CR0, FileFinder::HasSavegame() ? 1 : 0);
-	}
-}
-
 void RuntimePatches::PowerMode2003::HandleVariableHooks(int var_id) {
 #ifdef NO_RUNTIME_PATCHES
 	// no-op
@@ -530,24 +562,12 @@ void RuntimePatches::PowerMode2003::HandleVariableHooks(int var_id) {
 #endif
 	switch (var_id) {
 		case PM_VAR_CR0:
-		{
-			int op = Main_Data::game_variables->Get(PM_VAR_CR0);
-			if (op == 255 && FileFinder::HasSavegame()) {
-				Scene::instance->SetRequestedScene(std::make_shared<Scene_Load>());
-			} else if (op == 254) {
-				Player::exit_flag = true;
-			}
-			Main_Data::game_variables->Set(PM_VAR_CR0, FileFinder::HasSavegame() ? 1 : 0);
+			HandleCommands();
 			break;
-		}
 		case PM_VAR_MCOORDY:
-		{
-			Point mouse_pos = Input::GetMousePosition();
-			Main_Data::game_variables->Set(PM_VAR_MCOORDX, mouse_pos.x);
-			Main_Data::game_variables->Set(PM_VAR_MCOORDY, mouse_pos.y);
+			HandleMouse();
 			Game_Map::SetNeedRefreshForVarChange(PM_VAR_MCOORDX);
 			break;
-		}
 		case PM_VAR_KEY:
 			HandleKeyboard();
 			break;

src/game_runtime_patches.h

@@ -51,6 +51,10 @@ namespace RuntimePatches {
 
 	void DetermineActivePatches(std::vector<std::string>& patches);
 
+	void OnResetGameObjects();
+
+	void OnLoadSavegame();
+
 	// Handles patch side effects caused by Variable changes. This function is meant
 	// to be called only for operations that are possible in an unpatched RPG_RT!
 	void OnVariableChanged(int variable_id);
@@ -214,6 +218,23 @@ namespace RuntimePatches {
 
 	}
 
+
+	/**
+	 * Support for RPG_RT patch 'Power Mode 2003'.
+	 *  (aka. "Mega Patch 2003" in Italian scene)
+	 * 
+	 * This patch adds some specialiced commands by hooking into
+	 * the first 8 in-game variables, functionally using them
+	 * as 'Control Registers'.
+	 *
+	 * These new commands include:
+	 * - V[1]:   Calling up the Load menu, Exiting the game
+	 *             & Checking for the existence of Savefiles
+	 * - V[2-3]: Retrieving the current coordinates of the mouse cursor.
+	 * - V[4]:   Retrieving key inputs for entire keyboard.
+	 * - V[5-7]: Floating-point operations
+	 * - V[8]:   Specifying custom rotation for Picture IDs 1 - 50
+	 * */
 	namespace PowerMode2003 {
 		constexpr int PM_VAR_CR0 = 1;
 		constexpr int PM_VAR_MCOORDX = 2;
@@ -224,8 +245,8 @@ namespace RuntimePatches {
 		constexpr int PM_VAR_FCODE = 7;
 		constexpr int PM_VAR_SPECIAL = 8;
 
-		void Init();
 		void HandleVariableHooks(int var_id);
+
 		bool ApplyPictureRotation(lcf::rpg::SavePicture& pict);
 	}
 }

src/player.cpp

@@ -961,7 +961,7 @@ void Player::ResetGameObjects() {
 
 	Main_Data::game_system->ReloadSystemGraphic();
 
-	RuntimePatches::PowerMode2003::Init();
+	RuntimePatches::OnResetGameObjects();
 
 	Input::ResetMask();
 }
@@ -1220,6 +1220,7 @@ void Player::LoadSavegame(const std::string& save_name, int save_id) {
 			Game_Map::Dispose();
 
 			OnMapSaveFileReady(request, std::move(save));
+			RuntimePatches::OnLoadSavegame();
 
 			if (load_on_map) {
 				// Increment frame counter for consistency with a normal savegame load