scripting+ecs: introduce an ability to despawn entities on gamemode u…

…nload
MafiaHub · Jan 10, 2024 · b2947a3 · b2947a3
1 parent d8a6e31
commit b2947a3
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 0 deletions.
diff --git a/code/framework/src/scripting/engines/node/engine.cpp b/code/framework/src/scripting/engines/node/engine.cpp
@@ -12,6 +12,10 @@
 #include "engine.h"
 #include "../../events.h"
 
+#include "core_modules.h"
+
+#include "world/server.h"
+
 static const char bootstrap_code[] = R"(
 const publicRequire = require("module").createRequire(process.cwd() + "/gamemode/");
 globalThis.require = publicRequire;
@@ -274,6 +278,10 @@ namespace Framework::Scripting::Engines::Node {
         // Invoke the gamemode loaded event
         InvokeEvent(Events[EventIDs::GAMEMODE_UNLOADING]);
 
+        const auto worldEngine = CoreModules::GetWorldEngine();
+        if (worldEngine)
+            worldEngine->PurgeAllGameModeEntities();
+
         // Stop node environment
         node::Stop(_gamemodeEnvironment);
 

diff --git a/code/framework/src/world/engine.cpp b/code/framework/src/world/engine.cpp
@@ -62,4 +62,13 @@ namespace Framework::World {
     flecs::entity Engine::WrapEntity(flecs::entity_t serverID) const {
         return flecs::entity(_world->get_world(), serverID);
     }
+
+    void Engine::PurgeAllGameModeEntities() {
+        _world->defer_begin();
+        _findAllGameModeEntities.each([this](flecs::entity e, Modules::Base::RemovedOnGameModeReload &rhs) {
+            if (e.is_alive())
+                e.add<Modules::Base::PendingRemoval>();
+        });
+        _world->defer_end();
+    }
 } // namespace Framework::World
diff --git a/code/framework/src/world/engine.h b/code/framework/src/world/engine.h
@@ -38,11 +38,20 @@
         }                                                                                                                                                                                                                                                                              \
     } while (0)
 
+namespace Framework::Scripting::Engines::Node {
+    class Engine;
+}
+
 namespace Framework::World {
     class Engine {
+      private:
+        friend class Framework::Scripting::Engines::Node::Engine;
+        void PurgeAllGameModeEntities();
+
       protected:
         flecs::query<Modules::Base::Streamer> _findAllStreamerEntities;
         flecs::query<Modules::Base::Transform, Modules::Base::Streamable> _allStreamableEntities;
+        flecs::query<Modules::Base::RemovedOnGameModeReload> _findAllGameModeEntities;
         std::unique_ptr<flecs::world> _world;
         Networking::NetworkPeer *_networkPeer = nullptr;
 

diff --git a/code/framework/src/world/modules/base.hpp b/code/framework/src/world/modules/base.hpp
@@ -45,6 +45,10 @@ namespace Framework::World::Modules {
             [[maybe_unused]] uint8_t _unused;
         };
 
+        struct RemovedOnGameModeReload {
+            [[maybe_unused]] uint8_t _unused;
+        };
+
         struct ServerID {
             flecs::entity_t id;
         };
@@ -114,6 +118,7 @@ namespace Framework::World::Modules {
             auto _streamable = world.component<Streamable>();
             auto _streamer   = world.component<Streamer>();
 
+            world.component<RemovedOnGameModeReload>();
             world.component<PendingRemoval>();
             world.component<ServerID>();
 

diff --git a/code/framework/src/world/server.cpp b/code/framework/src/world/server.cpp
@@ -24,6 +24,8 @@ namespace Framework::World {
         GetWorld()->set<flecs::Rest>({});
         GetWorld()->import <flecs::monitor>();
 
+        _findAllGameModeEntities = _world->query_builder<Modules::Base::RemovedOnGameModeReload>().build();
+
         // Set up a proc to validate entity visibility.
         _isEntityVisible = [](const flecs::entity streamerEntity, const flecs::entity e, const Modules::Base::Transform &lhsTr, const Modules::Base::Streamer &streamer, const Modules::Base::Streamable &lhsS, const Modules::Base::Transform &rhsTr,
                                const Modules::Base::Streamable &rhsS) -> bool {