Add enginePreloadWorldArea function for preloading areas (#3646)

Author: MegadreamsBE

Client/game_sa/CStreamingSA.cpp

@@ -503,3 +503,15 @@ void CStreamingSA::RemoveBigBuildings()
 {
     (reinterpret_cast<void(__cdecl*)()>(0x4093B0))();
 }
+
+void CStreamingSA::LoadScene(const CVector* position)
+{
+    auto CStreaming_LoadScene = (void(__cdecl*)(const CVector*))FUNC_CStreaming_LoadScene;
+    CStreaming_LoadScene(position);
+}
+
+void CStreamingSA::LoadSceneCollision(const CVector* position)
+{
+    auto CStreaming_LoadSceneCollision = (void(__cdecl*)(const CVector*))FUNC_CStreaming_LoadSceneCollision;
+    CStreaming_LoadSceneCollision(position);
+}

Client/game_sa/CStreamingSA.h

@@ -20,6 +20,8 @@
 #define FUNC_LoadAllRequestedModels                  0x40EA10
 #define FUNC_CStreaming__HasVehicleUpgradeLoaded     0x407820
 #define FUNC_CStreaming_RequestSpecialModel          0x409d10
+#define FUNC_CStreaming_LoadScene                    0x40EB70
+#define FUNC_CStreaming_LoadSceneCollision           0x40ED80
 
 struct CArchiveInfo
 {
@@ -77,6 +79,9 @@ class CStreamingSA final : public CStreaming
     void          MakeSpaceFor(std::uint32_t memoryToCleanInBytes) override;
     std::uint32_t GetMemoryUsed() const override;
 
+    void LoadScene(const CVector* position);
+    void LoadSceneCollision(const CVector* position);
+
 private:
     void AllocateArchive();
 

Client/mods/deathmatch/logic/lua/CLuaFunctionParseHelpers.cpp

@@ -904,6 +904,12 @@ ADD_ENUM(eModelLoadState::LOADSTATE_READING, "reading")
 ADD_ENUM(eModelLoadState::LOADSTATE_FINISHING, "finishing")
 IMPLEMENT_ENUM_CLASS_END("model-load-state")
 
+IMPLEMENT_ENUM_CLASS_BEGIN(PreloadAreaOption)
+ADD_ENUM(PreloadAreaOption::MODELS, "models")
+ADD_ENUM(PreloadAreaOption::COLLISIONS, "collisions")
+ADD_ENUM(PreloadAreaOption::ALL, "all")
+IMPLEMENT_ENUM_CLASS_END("preload-area-option")
+
 //
 // CResource from userdata
 //

Client/mods/deathmatch/logic/lua/CLuaFunctionParseHelpers.h

@@ -87,6 +87,7 @@ DECLARE_ENUM_CLASS(eFxParticleSystems);
 DECLARE_ENUM(ePools);
 DECLARE_ENUM(eWorldProperty);
 DECLARE_ENUM_CLASS(eModelLoadState);
+DECLARE_ENUM_CLASS(PreloadAreaOption);
 
 class CRemoteCall;
 

Client/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp

@@ -145,6 +145,7 @@ void CLuaEngineDefs::LoadFunctions()
         {"engineGetPoolDefaultCapacity", ArgumentParser<EngineGetPoolDefaultCapacity>},
         {"engineGetPoolUsedCapacity", ArgumentParser<EngineGetPoolUsedCapacity>},
         {"engineSetPoolCapacity", ArgumentParser<EngineSetPoolCapacity>},
+        {"enginePreloadWorldArea", ArgumentParser<EnginePreloadWorldArea>},
 
         // CLuaCFunctions::AddFunction ( "engineReplaceMatchingAtomics", EngineReplaceMatchingAtomics );
         // CLuaCFunctions::AddFunction ( "engineReplaceWheelAtomics", EngineReplaceWheelAtomics );
@@ -2547,3 +2548,15 @@ eModelLoadState CLuaEngineDefs::EngineStreamingGetModelLoadState(std::uint16_t m
 
     return g_pGame->GetStreaming()->GetStreamingInfo(modelId)->loadState;
 }
+
+void CLuaEngineDefs::EnginePreloadWorldArea(CVector position, std::optional<PreloadAreaOption> option)
+{
+    if (!option.has_value())
+        option = PreloadAreaOption::ALL;
+
+    if (option == PreloadAreaOption::ALL || option == PreloadAreaOption::MODELS)
+        g_pGame->GetStreaming()->LoadScene(&position);
+
+    if (option == PreloadAreaOption::ALL || option == PreloadAreaOption::COLLISIONS)
+        g_pGame->GetStreaming()->LoadSceneCollision(&position);
+}

Client/mods/deathmatch/logic/luadefs/CLuaEngineDefs.h

@@ -92,6 +92,8 @@ class CLuaEngineDefs : public CLuaDefs
     static bool EngineStreamingReleaseModel(lua_State* const luaVM, std::uint16_t modelId, std::optional<bool> removeReference);
     static eModelLoadState EngineStreamingGetModelLoadState(std::uint16_t modelId);
 
+    static void EnginePreloadWorldArea(CVector position, std::optional<PreloadAreaOption> option);
+
 private:
     static void AddEngineColClass(lua_State* luaVM);
     static void AddEngineTxdClass(lua_State* luaVM);

Client/sdk/game/CStreaming.h

@@ -37,6 +37,13 @@ enum class eModelLoadState : std::uint32_t
     LOADSTATE_FINISHING = 4
 };
 
+enum class PreloadAreaOption
+{
+    MODELS = 0,
+    COLLISIONS,
+    ALL
+};
+
 struct CStreamingInfo
 {
     uint16_t prevId = (uint16_t)-1;
@@ -68,4 +75,6 @@ class CStreaming
     virtual void   MakeSpaceFor(std::uint32_t memoryToCleanInBytes) = 0;
     virtual std::uint32_t GetMemoryUsed() const = 0;
     virtual void          RemoveBigBuildings() = 0;
+    virtual void          LoadScene(const CVector* position) = 0;
+    virtual void          LoadSceneCollision(const CVector* position) = 0;
 };