Fixed TopMenubar/VehicleAi glitches with AI presets.

ohlidalp · ohlidalp · commit 2508c4f792b9 · 2024-08-18T00:20:12.000+02:00
*Problem:*
After returning to menu and loading another map, the presets would never display (the spinner would spin indefinitely).

*Cause:*
broken by adding the [AI Presets] section to terrn2 format - these required the list of presets to be refreshed on each new terrain, but it only happened once.

*Updates:*
* I changed it so that the local waypoints file also loads on background with spinner, so it doesn't lag the game
* I also made the budndled presets display immediately with spinner below it, instead of displaying everything only after download finished
* `MSG_NET_REFRESH_AI_PRESETS` is dead, long live `MSG_NET_FETCH_AI_PRESETS_{SUCCESS/FAILURE}`
diff --git a/doc/angelscript/Script2Game/globals.h b/doc/angelscript/Script2Game/globals.h
@@ -629,7 +629,8 @@ enum MsgType
     MSG_NET_REFRESH_REPOLIST_SUCCESS,          //!< Background task notification, DO NOT PUSH MANUALLY.
     MSG_NET_OPEN_RESOURCE_SUCCESS,             //!< Background task notification, DO NOT PUSH MANUALLY.
     MSG_NET_REFRESH_REPOLIST_FAILURE,          //!< Background task notification, DO NOT PUSH MANUALLY.
-    MSG_NET_REFRESH_AI_PRESETS,                //!< Request refresh of AI presets menu in top menubar. No params.
+    MSG_NET_FETCH_AI_PRESETS_SUCCESS,          //!< Background task notification, DO NOT PUSH MANUALLY.
+    MSG_NET_FETCH_AI_PRESETS_FAILURE,          //!< Background task notification, DO NOT PUSH MANUALLY.
     // Simulation
     MSG_SIM_PAUSE_REQUESTED,                   //!< Pause game. No params.
     MSG_SIM_UNPAUSE_REQUESTED,                 //!< Unpause game. No params.
diff --git a/source/main/Application.cpp b/source/main/Application.cpp
@@ -577,7 +577,8 @@ const char* MsgTypeToString(MsgType type)
     case MSG_NET_REFRESH_REPOLIST_SUCCESS     : return "MSG_NET_REFRESH_REPOLIST_SUCCESS";
     case MSG_NET_OPEN_RESOURCE_SUCCESS        : return "MSG_NET_OPEN_RESOURCE_SUCCESS";
     case MSG_NET_REFRESH_REPOLIST_FAILURE     : return "MSG_NET_REFRESH_REPOLIST_FAILURE";
-    case MSG_NET_REFRESH_AI_PRESETS           : return "MSG_NET_REFRESH_AI_PRESETS";
+    case MSG_NET_FETCH_AI_PRESETS_SUCCESS     : return "MSG_NET_FETCH_AI_PRESETS_SUCCESS";
+    case MSG_NET_FETCH_AI_PRESETS_FAILURE     : return "MSG_NET_FETCH_AI_PRESETS_FAILURE";
 
     case MSG_SIM_PAUSE_REQUESTED              : return "MSG_SIM_PAUSE_REQUESTED";
     case MSG_SIM_UNPAUSE_REQUESTED            : return "MSG_SIM_UNPAUSE_REQUESTED";
diff --git a/source/main/Application.h b/source/main/Application.h
@@ -73,6 +73,13 @@ namespace RoR {
 /// Global gameplay message loop, see `struct Message` in GameContext.h
 enum MsgType
 {
+    // CHECKLIST for adding new message types:
+    // * Provide name as string constant - see `MsgTypeToString()` in Application.cpp
+    // * Register it with AngelScript - see `RegisterMessageQueue()` in 'scripting/bindings/MsgQueueAngelscript.cpp'
+    // * Allow/Deny pushing from AngelScript - see `pushMessage()` in 'scripting/GameScript.cpp'
+    // * Document the AngelScript usage - see 'doc/angelscript/Script2Game/globals.h'.
+    // * Make it do something useful in 'main.cpp' ;)
+
     MSG_INVALID,
     // Application
     MSG_APP_SHUTDOWN_REQUESTED,
@@ -100,7 +107,8 @@ enum MsgType
     MSG_NET_REFRESH_REPOLIST_SUCCESS,      //!< Payload = GUI::ResourcesCollection* (owner)
     MSG_NET_OPEN_RESOURCE_SUCCESS,         //!< Payload = GUI::ResourcesCollection* (owner)
     MSG_NET_REFRESH_REPOLIST_FAILURE,      //!< Payload = RoR::CurlFailInfo* (owner)
-    MSG_NET_REFRESH_AI_PRESETS,
+    MSG_NET_FETCH_AI_PRESETS_SUCCESS,      //!< Description = JSON string
+    MSG_NET_FETCH_AI_PRESETS_FAILURE,      //!< Description = message
     // Simulation
     MSG_SIM_PAUSE_REQUESTED,
     MSG_SIM_UNPAUSE_REQUESTED,
diff --git a/source/main/gui/panels/GUI_TopMenubar.cpp b/source/main/gui/panels/GUI_TopMenubar.cpp
@@ -73,8 +73,31 @@ static size_t CurlWriteFunc(void *ptr, size_t size, size_t nmemb, std::string* d
     return size * nmemb;
 }
 
-void GetJson()
+void FetchAiPresetsThreadFunc()
 {
+    // If local file 'savegames/waypoints.json' exists, load it; otherwise download from GitHub.
+    // -----------------------------------------------------------------------------------------
+
+    if (FileExists(PathCombine(App::sys_savegames_dir->getStr(), "waypoints.json")))
+    {
+        try
+        {
+            Ogre::DataStreamPtr stream = Ogre::ResourceGroupManager::getSingleton().openResource("waypoints.json", RGN_SAVEGAMES);
+            Message m(MSG_NET_FETCH_AI_PRESETS_SUCCESS);
+            m.description = stream->getAsString();
+            App::GetGameContext()->PushMessage(m);
+        }
+        catch (...)
+        {
+            RoR::HandleGenericException("Top menubar / AI presets");
+            Message m(MSG_NET_FETCH_AI_PRESETS_FAILURE);
+            m.description = "Failed to load local AI presets.";
+            App::GetGameContext()->PushMessage(m);
+        }
+
+        return; // DONE
+    }
+
     std::string url = "https://raw.githubusercontent.com/RigsOfRods-Community/ai-waypoints/main/waypoints.json";
     std::string response_payload;
     long response_code = 0;
@@ -99,10 +122,13 @@ void GetJson()
         Ogre::LogManager::getSingleton().stream()
             << "[RoR|Repository] Failed to download AI presets;"
             << " Error: '" << curl_easy_strerror(curl_result) << "'; HTTP status code: " << response_code;
+        Message m(MSG_NET_FETCH_AI_PRESETS_FAILURE);
+        m.description = "Failed to download AI presets.";
+        App::GetGameContext()->PushMessage(m);
     }
     else
     {
-        Message m(MSG_NET_REFRESH_AI_PRESETS);
+        Message m(MSG_NET_FETCH_AI_PRESETS_SUCCESS);
         m.description = response_payload;
         App::GetGameContext()->PushMessage(m);
     }
@@ -1266,41 +1292,18 @@ void TopMenubar::Draw(float dt)
             ImGui::PopStyleColor();
             ImGui::Separator();
 
-            bool is_open = ImGui::CollapsingHeader(_LC("TopMenubar", "Presets"));
-            if (ImGui::IsItemActivated() && !is_open && ai_presets_all.Empty()) // Rebuild the preset list if blank
-            {
-                if (ai_presets_extern.Empty()) // Fetch once
-                {
-                    if (FileExists(PathCombine(App::sys_savegames_dir->getStr(), "waypoints.json")))
-                    {
-                        App::GetContentManager()->LoadAndParseJson("waypoints.json", RGN_SAVEGAMES, ai_presets_extern);
-                        this->RefreshAiPresets();
-                    }
-                    else
-                    {
-                        this->DownloadAiPresets();
-                    }
-                }
-            }
-
-            if (is_open && ai_presets_all.Empty())
-            {
-                float spinner_size = 8.f;
-                ImGui::SetCursorPosX((ImGui::GetWindowSize().x / 2.f) - spinner_size);
-                LoadingIndicatorCircle("spinner", spinner_size, theme.value_blue_text_color, theme.value_blue_text_color, 10, 10);
-            }
-
-            if (is_open && !ai_presets_all.Empty())
+            if (ImGui::CollapsingHeader(_LC("TopMenubar", "Presets")))
             {
+                // Draw whatever we already have (i.e. presets bundled with terrain, see '[AI Presets]' in terrn2 format).
                 size_t num_rows = ai_presets_all.GetArray().Size();
-                int count = 0;
+                int display_count = 0;
                 for (size_t i = 0; i < num_rows; i++)
                 {
                     rapidjson::Value& j_row = ai_presets_all[static_cast<rapidjson::SizeType>(i)];
 
                     if (j_row.HasMember("terrain") && App::sim_terrain_name->getStr() == j_row["terrain"].GetString())
                     {
-                        count++;
+                        display_count++;
                         if (ImGui::Button(j_row["preset"].GetString(), ImVec2(250, 0)))
                         {
                             ai_waypoints.clear();
@@ -1329,7 +1332,32 @@ void TopMenubar::Draw(float dt)
                         }
                     }
                 }
-                if (count == 0)
+
+                // Fetch additional presets, or display error if failed
+                if (ai_presets_extern.Empty())
+                {
+                    if (ai_presets_extern_fetching)
+                    {
+                        float spinner_size = 8.f;
+                        ImGui::SetCursorPosX((ImGui::GetWindowSize().x / 2.f) - spinner_size);
+                        LoadingIndicatorCircle("spinner", spinner_size, theme.value_blue_text_color, theme.value_blue_text_color, 10, 10);
+                    }
+                    else if (ai_presets_extern_error != "")
+                    {
+                        ImGui::TextColored(RED_TEXT, "%s", _LC("TopMenubar", "Failed to fetch external presets."));
+                        if (ImGui::Button(_LC("TopMenubar", "Retry")))
+                        {
+                            this->FetchExternAiPresetsOnBackground(); // Will post `MSG_NET_REFRESH_AI_PRESETS` when done.
+                        }
+                    }
+                    else
+                    {
+                        this->FetchExternAiPresetsOnBackground(); // Will post `MSG_NET_REFRESH_AI_PRESETS` when done.
+                    }
+                }
+
+                // If no presets found, display message
+                if (display_count == 0 && !ai_presets_extern_fetching && ai_presets_extern_error == "")
                 {
                     ImGui::Text("%s", _LC("TopMenubar", "No presets found for this terrain :("));
                     ImGui::Text("%s", _LC("TopMenubar", "Supported terrains:"));
@@ -2391,11 +2419,51 @@ void TopMenubar::DrawSpecialStateBox(float top_offset)
     }
 }
 
-void TopMenubar::DownloadAiPresets()
+void TopMenubar::LoadBundledAiPresets(TerrainPtr terrain)
+{
+    // Load 'bundled' AI presets - see section `[AI Presets]` in terrn2 file format
+    // ----------------------------------------------------------------------------
+
+    App::GetGuiManager()->TopMenubar.ai_presets_bundled.SetArray();
+
+    for (const std::string& filename: terrain->GetDef().ai_presets_files)
+    {
+        rapidjson::Document j_doc;
+        if (Ogre::ResourceGroupManager::getSingleton().resourceExists(terrain->getTerrainFileResourceGroup(), filename))
+        {
+            App::GetContentManager()->LoadAndParseJson(filename, terrain->getTerrainFileResourceGroup(), j_doc);
+        }
+        else
+        {
+            LOG(fmt::format("[RoR|Terrain] AI presets file '{}' declared in '{}' not found!", filename, terrain->getTerrainFileName()));
+        }
+
+        // Ensure the format is about right
+        if (!j_doc.IsArray())
+        {
+            LOG(fmt::format("[RoR|Terrain] AI presets file '{}' declared in '{}' has wrong format - the root element is not an array!",
+                    filename, terrain->getTerrainFileName()));
+        }
+        else
+        {
+            // Finally add the presets to the list
+            for (const rapidjson::Value& j_bundled_preset: j_doc.GetArray())
+            {
+                rapidjson::Value preset_copy(j_bundled_preset, App::GetGuiManager()->TopMenubar.ai_presets_bundled.GetAllocator());
+                App::GetGuiManager()->TopMenubar.ai_presets_bundled.PushBack(preset_copy, App::GetGuiManager()->TopMenubar.ai_presets_bundled.GetAllocator());
+            }
+        }
+    }
+
+    App::GetGuiManager()->TopMenubar.RefreshAiPresets();
+}
+
+void TopMenubar::FetchExternAiPresetsOnBackground()
 {
 #if defined(USE_CURL)
-    std::packaged_task<void()> task(GetJson);
+    std::packaged_task<void()> task(FetchAiPresetsThreadFunc);
     std::thread(std::move(task)).detach();
+    ai_presets_extern_fetching = true;
 #endif // defined(USE_CURL)
 }
 
diff --git a/source/main/gui/panels/GUI_TopMenubar.h b/source/main/gui/panels/GUI_TopMenubar.h
@@ -98,10 +98,13 @@ class TopMenubar
     int ai_mode_prev = 0;
 
     // AI waypoint presets
-    void DownloadAiPresets(); //!< Initiate threaded download of 'extern' waypoints from GitHub repo.
+    void FetchExternAiPresetsOnBackground(); //!< Initiate threaded (down)load of 'extern' waypoints from GitHub repo.
+    void LoadBundledAiPresets(TerrainPtr terrain); //!< Loads JSON files from `[AI Presets]` section in .terrn2 file format.
     void RefreshAiPresets();  //!< Refresh the list of presets, used for display. Needs to be called when terrain is loaded.
     rapidjson::Document ai_presets_all; //!< The full list of presets, used for display. Needs to be refreshed when terrain is loaded.
     rapidjson::Document ai_presets_extern; //!< Externally provided presets (GitHub repo or local 'savegames/waypoints.json' file).
+    bool                ai_presets_extern_fetching = false; //!< True if the (down)load of 'extern' waypoints is in progress.
+    std::string         ai_presets_extern_error; //!< Error message from the (down)load of 'extern' waypoints.
     rapidjson::Document ai_presets_bundled; //!< Presets bundled with the terrain, see `[AI Presets]` section in .terrn2 file format.
 
     // Tuning menu
diff --git a/source/main/main.cpp b/source/main/main.cpp
@@ -749,10 +749,11 @@ int main(int argc, char *argv[])
                     break;
                 }
 
-                case MSG_NET_REFRESH_AI_PRESETS:
+                case MSG_NET_FETCH_AI_PRESETS_SUCCESS:
                 {
                     try
                     {
+                        App::GetGuiManager()->TopMenubar.ai_presets_extern_fetching = false;
                         App::GetGuiManager()->TopMenubar.ai_presets_extern.Parse(m.description.c_str());
                         App::GetGuiManager()->TopMenubar.RefreshAiPresets();
                     }
@@ -763,6 +764,21 @@ int main(int argc, char *argv[])
                     break;
                 }
 
+                case MSG_NET_FETCH_AI_PRESETS_FAILURE:
+                {
+                    try
+                    {
+                        App::GetGuiManager()->TopMenubar.ai_presets_extern_fetching = false;
+                        App::GetGuiManager()->TopMenubar.ai_presets_extern_error = m.description;
+                        App::GetGuiManager()->TopMenubar.RefreshAiPresets();
+                    }
+                    catch (...) 
+                    {
+                        HandleMsgQueueException(m.type);
+                    }
+                    break;
+                }
+
                 // -- Gameplay events --
 
                 case MSG_SIM_PAUSE_REQUESTED:
diff --git a/source/main/scripting/GameScript.cpp b/source/main/scripting/GameScript.cpp
@@ -1394,6 +1394,8 @@ bool GameScript::pushMessage(MsgType type, AngelScript::CScriptDictionary* dict)
     case MSG_NET_REFRESH_REPOLIST_SUCCESS:
     case MSG_NET_OPEN_RESOURCE_SUCCESS:
     case MSG_NET_REFRESH_REPOLIST_FAILURE:
+    case MSG_NET_FETCH_AI_PRESETS_SUCCESS:
+    case MSG_NET_FETCH_AI_PRESETS_FAILURE:
         // GUI
     case MSG_GUI_SHOW_MESSAGE_BOX_REQUESTED:
     case MSG_GUI_DOWNLOAD_PROGRESS:
diff --git a/source/main/scripting/bindings/MsgQueueAngelscript.cpp b/source/main/scripting/bindings/MsgQueueAngelscript.cpp
@@ -62,7 +62,8 @@ void RoR::RegisterMessageQueue(asIScriptEngine* engine)
     result = engine->RegisterEnumValue("MsgType", "MSG_NET_REFRESH_REPOLIST_SUCCESS", MSG_NET_REFRESH_REPOLIST_SUCCESS); ROR_ASSERT(result >= 0);
     result = engine->RegisterEnumValue("MsgType", "MSG_NET_OPEN_RESOURCE_SUCCESS", MSG_NET_OPEN_RESOURCE_SUCCESS); ROR_ASSERT(result >= 0);
     result = engine->RegisterEnumValue("MsgType", "MSG_NET_REFRESH_REPOLIST_FAILURE", MSG_NET_REFRESH_REPOLIST_FAILURE); ROR_ASSERT(result >= 0);
-    result = engine->RegisterEnumValue("MsgType", "MSG_NET_REFRESH_AI_PRESETS", MSG_NET_REFRESH_AI_PRESETS); ROR_ASSERT(result >= 0);
+    result = engine->RegisterEnumValue("MsgType", "MSG_NET_FETCH_AI_PRESETS_SUCCESS", MSG_NET_FETCH_AI_PRESETS_SUCCESS); ROR_ASSERT(result >= 0);
+    result = engine->RegisterEnumValue("MsgType", "MSG_NET_FETCH_AI_PRESETS_FAILURE", MSG_NET_FETCH_AI_PRESETS_FAILURE); ROR_ASSERT(result >= 0);
     // Simulation
     result = engine->RegisterEnumValue("MsgType", "MSG_SIM_PAUSE_REQUESTED", MSG_SIM_PAUSE_REQUESTED); ROR_ASSERT(result >= 0);
     result = engine->RegisterEnumValue("MsgType", "MSG_SIM_UNPAUSE_REQUESTED", MSG_SIM_UNPAUSE_REQUESTED); ROR_ASSERT(result >= 0);
diff --git a/source/main/terrain/Terrain.cpp b/source/main/terrain/Terrain.cpp
@@ -475,29 +475,7 @@ void RoR::Terrain::initAiPresets()
     // Load 'bundled' AI presets - see section `[AI Presets]` in terrn2 file format
     // ----------------------------------------------------------------------------
 
-    for (const std::string& filename: m_def.ai_presets_files)
-    {
-        // assume there's just one file - load directly into the `ai_presets_bundled` variable
-        if (Ogre::ResourceGroupManager::getSingleton().resourceExists(this->getTerrainFileResourceGroup(), filename))
-        {
-            App::GetContentManager()->LoadAndParseJson(filename, this->getTerrainFileResourceGroup(), App::GetGuiManager()->TopMenubar.ai_presets_bundled);
-        }
-        else
-        {
-            LOG(fmt::format("[RoR|Terrain] AI presets file '{}' declared in '{}' not found!", filename, this->getTerrainFileName()));
-        }
-
-        // Ensure the format is about right
-        if (!App::GetGuiManager()->TopMenubar.ai_presets_bundled.IsArray())
-        {
-            LOG(fmt::format("[RoR|Terrain] AI presets file '{}' declared in '{}' has wrong format - the root element is not an array!",
-                    filename, this->getTerrainFileName()));
-            App::GetGuiManager()->TopMenubar.ai_presets_bundled.Clear();
-        }
-    }
-
-    // Force refresh - this is needed because the 'extern' AI presets are loaded later.
-    App::GetGuiManager()->TopMenubar.ai_presets_all.Clear();
+    App::GetGuiManager()->TopMenubar.LoadBundledAiPresets(this);
 }
 
 void RoR::Terrain::setGravity(float value)
