From 910c88325a69f4166a468ae30b643641f9410ed0 Mon Sep 17 00:00:00 2001
From: elsid <elsid.mail@gmail.com>
Date: Sun, 7 Apr 2024 15:22:02 +0200
Subject: [PATCH] Add a setting to wait for all navmesh jobs on exit

---
 apps/openmw/mwworld/worldimp.cpp                     |  6 ++++++
 components/settings/categories/navigator.hpp         |  1 +
 docs/source/reference/modding/settings/navigator.rst | 10 ++++++++++
 files/settings-default.cfg                           |  3 +++
 4 files changed, 20 insertions(+)

diff --git a/apps/openmw/mwworld/worldimp.cpp b/apps/openmw/mwworld/worldimp.cpp
index ec58f779d0..74335a1534 100644
--- a/apps/openmw/mwworld/worldimp.cpp
+++ b/apps/openmw/mwworld/worldimp.cpp
@@ -591,6 +591,12 @@ namespace MWWorld
         // Must be cleared before mRendering is destroyed
         if (mProjectileManager)
             mProjectileManager->clear();
+
+        if (Settings::navigator().mWaitForAllJobsOnExit)
+        {
+            Log(Debug::Verbose) << "Waiting for all navmesh jobs to be done...";
+            mNavigator->wait(DetourNavigator::WaitConditionType::allJobsDone, nullptr);
+        }
     }
 
     void World::setRandomSeed(uint32_t seed)
diff --git a/components/settings/categories/navigator.hpp b/components/settings/categories/navigator.hpp
index d6d7adcd56..c65dd3392e 100644
--- a/components/settings/categories/navigator.hpp
+++ b/components/settings/categories/navigator.hpp
@@ -63,6 +63,7 @@ namespace Settings
         SettingValue<bool> mEnableNavMeshDiskCache{ mIndex, "Navigator", "enable nav mesh disk cache" };
         SettingValue<bool> mWriteToNavmeshdb{ mIndex, "Navigator", "write to navmeshdb" };
         SettingValue<std::uint64_t> mMaxNavmeshdbFileSize{ mIndex, "Navigator", "max navmeshdb file size" };
+        SettingValue<bool> mWaitForAllJobsOnExit{ mIndex, "Navigator", "wait for all jobs on exit" };
     };
 }
 
diff --git a/docs/source/reference/modding/settings/navigator.rst b/docs/source/reference/modding/settings/navigator.rst
index 55b9e19b19..6fafdcdfd2 100644
--- a/docs/source/reference/modding/settings/navigator.rst
+++ b/docs/source/reference/modding/settings/navigator.rst
@@ -245,6 +245,16 @@ Absent pieces usually mean a bug in recast mesh tiles building.
 Allows to do in-game debug.
 Potentially decreases performance.
 
+wait for all jobs on exit
+-------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Wait until all queued async navmesh jobs are processed before exiting the engine.
+Useful when a benchmark generates jobs to write into navmeshdb faster than they are processed.
+
 Expert settings
 ***************
 
diff --git a/files/settings-default.cfg b/files/settings-default.cfg
index 2f236bf55a..10c25bb430 100644
--- a/files/settings-default.cfg
+++ b/files/settings-default.cfg
@@ -999,6 +999,9 @@ write to navmeshdb = true
 # Approximate maximum file size of navigation mesh cache stored on disk in bytes (value > 0)
 max navmeshdb file size = 2147483648
 
+# Wait until all queued async navmesh jobs are processed before exiting the engine (true, false)
+wait for all jobs on exit = false
+
 [Shadows]
 
 # Enable or disable shadows. Bear in mind that this will force OpenMW to use shaders as if "[Shaders]/force shaders" was set to true.