Implement ValveSoftware#1483 with ways to easily disable it when needed.

Author: Bitl

README.md

@@ -91,6 +91,12 @@ BDSBASE_ACHIEVEMENT_NOTIFICATIONS
 - Users can easily change the look of the panels with the cl_achievements_theme command.
 - This allows users to easily see unlocked achievements and achievement progress.
 
+BDSBASE_TEMP_FIXDYNAMICMODELS
+- Games: All
+- This enables Pull Request #1483 (https://github.com/ValveSoftware/source-sdk-2013/pull/1483) by default which fixes issues with dynamic models in listen servers.
+- This is a temporary workaround and is not recomended to be enabled with future versions of the engine.
+- If this is disabled, use the command line variable -dynamicmodelsfix to enable the fix.
+
 ## Credits:
 - TheBetaM for the custom schema code. (https://github.com/TheBetaM/tf-solo)
 - rafradek for some bot AI changes (sigsegv-mvm) (https://github.com/rafradek/sigsegv-mvm)

src/game/client/cdll_client_int.cpp

@@ -1969,6 +1969,24 @@ void CHLClient::ResetStringTablePointers()
 #endif
 }
 
+#ifdef BDSBASE
+static void ClearClientDynamicModelList()
+{
+#ifndef BDSBASE_TEMP_FIXDYNAMICMODELS
+	if (CommandLine()->CheckParm("-dynamicmodelsfix"))
+#endif
+	{
+		// engine bugfix: clear out client dynamic model list for listen servers
+		// TODO remove this when the engine is updated
+		struct CModelInfo : IVModelInfoClient
+		{
+			CUtlVector< model_t* > m_vecDynamicModels;
+		};
+		static_cast<CModelInfo*>(modelinfo)->m_vecDynamicModels.Purge();
+	}
+}
+#endif
+
 //-----------------------------------------------------------------------------
 // Purpose: Per level de-init
 //-----------------------------------------------------------------------------
@@ -2040,6 +2058,10 @@ void CHLClient::LevelShutdown( void )
 
 	messagechars->Clear();
 
+#ifdef BDSBASE
+	ClearClientDynamicModelList();
+#endif
+
 #ifndef TF_CLIENT_DLL
 	// don't want to do this for TF2 because we have particle systems in our
 	// character loadout screen that can be viewed when we're not connected to a server

src/game/client/client_quiver.vpc

@@ -30,6 +30,8 @@ $Configuration
 		$PreprocessorDefinitions		"$BASE;DISABLE_GC_CONNECTION;DISABLE_IN_SOURCESDK;INVENTORY_VIA_WEBAPI" [$SOURCESDK]
 		//custom options
 		$PreprocessorDefinitions		"$BASE;QUIVER_DLL;BDSBASE_DISCORD;BDSBASE_USE_LOCAL_SCHEMA;BDSBASE_CUSTOM_SCHEMA;BDSBASE_LEGACY_MAINMENU;BDSBASE_CURATED_ITEMS;BDSBASE_LEGACY_VIEWMODELS;BDSBASE_CURATED_ITEMS_ALLOWCOSMETICWEAPONS;BDSBASE_CURATED_ITEMS_GIVEWHITELISTEDITEMS;BDSBASE_ACHIEVEMENT_NOTIFICATIONS"
+		//temp
+		$PreprocessorDefinitions		"$BASE;BDSBASE_TEMP_FIXDYNAMICMODELS"
 	}
 }
 

src/game/server/baseentity.cpp

@@ -318,6 +318,30 @@ IMPLEMENT_SERVERCLASS_ST_NOBASE( CBaseEntity, DT_BaseEntity )
 
 END_SEND_TABLE()
 
+#ifdef BDSBASE
+static bool g_bInRegisterModelLoadCallback = false;
+static void MarkDynamicModelLoadedStringTable(const model_t* pModel)
+{
+#ifndef BDSBASE_TEMP_FIXDYNAMICMODELS
+	if (CommandLine()->CheckParm("-dynamicmodelsfix"))
+#endif
+	{
+		// engine bugfix: ensure this dynamic model is marked as loaded in the string table
+		// TODO remove this when the engine is updated
+		extern INetworkStringTable* g_pStringTableDynamicModels;
+		if (g_pStringTableDynamicModels)
+		{
+			const char* pModelName = modelinfo->GetModelName(pModel);
+			int nIdx = g_pStringTableDynamicModels->FindStringIndex(pModelName);
+			if (nIdx != INVALID_STRING_INDEX)
+			{
+				bool bLoaded = true;
+				g_pStringTableDynamicModels->SetStringUserData(nIdx, sizeof(bLoaded), &bLoaded);
+			}
+		}
+	}
+}
+#endif
 
 // dynamic models
 class CBaseEntityModelLoadProxy
@@ -335,7 +359,16 @@ class CBaseEntityModelLoadProxy
 public:
 	explicit CBaseEntityModelLoadProxy( CBaseEntity *pEntity ) : m_pHandler( new Handler( pEntity ) ) { }
 	~CBaseEntityModelLoadProxy() { delete m_pHandler; }
+#ifdef BDSBASE
+	void Register(int nModelIndex) const
+	{
+		g_bInRegisterModelLoadCallback = true;
+		modelinfo->RegisterModelLoadCallback(nModelIndex, m_pHandler);
+		g_bInRegisterModelLoadCallback = false;
+	}
+#else
 	void Register( int nModelIndex ) const { modelinfo->RegisterModelLoadCallback( nModelIndex, m_pHandler ); }
+#endif
 	operator CBaseEntity * () const { return m_pHandler->m_pEntity; }
 
 private:
@@ -347,6 +380,9 @@ static CUtlHashtable< CBaseEntityModelLoadProxy, empty_t, PointerHashFunctor, Po
 
 void CBaseEntityModelLoadProxy::Handler::OnModelLoadComplete( const model_t *pModel )
 {
+#ifdef BDSBASE
+	MarkDynamicModelLoadedStringTable(pModel);
+#endif
 	m_pEntity->OnModelLoadComplete( pModel );
 	sg_DynamicLoadHandlers.Remove( m_pEntity ); // NOTE: destroys *this!
 }

src/game/server/gameinterface.cpp

@@ -236,6 +236,10 @@ INetworkStringTable *g_pStringTableServerPopFiles = NULL;
 INetworkStringTable *g_pStringTableServerMapCycleMvM = NULL;
 #endif
 
+#ifdef BDSBASE
+INetworkStringTable* g_pStringTableDynamicModels = NULL;
+#endif
+
 CStringTableSaveRestoreOps g_VguiScreenStringOps;
 
 // Holds global variables shared between engine and game.
@@ -1514,6 +1518,10 @@ void CServerGameDLL::CreateNetworkStringTables( void )
 	g_pStringTableServerMapCycleMvM = networkstringtable->CreateStringTable( "ServerMapCycleMvM", 128 );
 #endif
 
+#ifdef BDSBASE
+	g_pStringTableDynamicModels = networkstringtable->FindTable("DynamicModels");
+#endif
+
 	bool bPopFilesValid = true;
 	(void)bPopFilesValid; // Avoid unreferenced variable warning
 

src/game/server/server_quiver.vpc

@@ -23,6 +23,8 @@ $Configuration
 		$PreprocessorDefinitions		"$BASE;DISABLE_GC_CONNECTION;DISABLE_IN_SOURCESDK;INVENTORY_VIA_WEBAPI" [$SOURCESDK]
 		//custom options
 		$PreprocessorDefinitions		"$BASE;QUIVER_DLL;BDSBASE_DISCORD;BDSBASE_USE_LOCAL_SCHEMA;BDSBASE_CUSTOM_SCHEMA;BDSBASE_LEGACY_MAINMENU;BDSBASE_CURATED_ITEMS;BDSBASE_LEGACY_VIEWMODELS;BDSBASE_CURATED_ITEMS_ALLOWCOSMETICWEAPONS;BDSBASE_CURATED_ITEMS_GIVEWHITELISTEDITEMS;BDSBASE_ACHIEVEMENT_NOTIFICATIONS"
+		//temp
+		$PreprocessorDefinitions		"$BASE;BDSBASE_TEMP_FIXDYNAMICMODELS"
 	}
 }