Added save/restore to client-side VScript

Author: Blixibon

sp/src/game/client/c_baseentity.cpp

@@ -429,6 +429,7 @@ BEGIN_RECV_TABLE_NOBASE( C_BaseEntity, DT_AnimTimeMustBeFirst )
 END_RECV_TABLE()
 
 BEGIN_ENT_SCRIPTDESC_ROOT( C_BaseEntity, "Root class of all client-side entities" )
+	DEFINE_SCRIPT_INSTANCE_HELPER( &g_BaseEntityScriptInstanceHelper )
 	DEFINE_SCRIPTFUNC_NAMED( GetAbsOrigin, "GetOrigin", "" )
 	DEFINE_SCRIPTFUNC_NAMED( ScriptGetForward, "GetForwardVector", "Get the forward vector of the entity" )
 #ifdef MAPBASE_VSCRIPT
@@ -6130,6 +6131,9 @@ BEGIN_DATADESC_NO_BASE( C_BaseEntity )
 	DEFINE_FIELD( m_angAbsRotation, FIELD_VECTOR ),
 	DEFINE_ARRAY( m_rgflCoordinateFrame, FIELD_FLOAT, 12 ), // NOTE: MUST BE IN LOCAL SPACE, NOT POSITION_VECTOR!!! (see CBaseEntity::Restore)
 	DEFINE_FIELD( m_fFlags, FIELD_INTEGER ),
+#ifdef MAPBASE_VSCRIPT
+	DEFINE_FIELD( m_iszScriptId, FIELD_STRING ),
+#endif
 END_DATADESC()
 
 //-----------------------------------------------------------------------------

sp/src/game/client/c_world.cpp

@@ -13,6 +13,9 @@
 #include "ivieweffects.h"
 #include "shake.h"
 #include "eventlist.h"
+#ifdef MAPBASE
+#include "mapentities_shared.h"
+#endif
 // NVNT haptic include for notification of world precache
 #include "haptics/haptic_utils.h"
 // memdbgon must be the last include file in a .cpp file!!!
@@ -62,9 +65,6 @@ BEGIN_RECV_TABLE( C_World, DT_World )
 #ifdef MAPBASE
 	RecvPropString(RECVINFO(m_iszChapterTitle)),
 #endif
-#ifdef MAPBASE_VSCRIPT
-	RecvPropInt(RECVINFO(m_iScriptLanguageClient)),
-#endif
 END_RECV_TABLE()
 
 #ifdef MAPBASE_VSCRIPT
@@ -86,6 +86,11 @@ bool C_World::Init( int entnum, int iSerialNum )
 	ActivityList_Init();
 	EventList_Init();
 
+#ifdef MAPBASE_VSCRIPT
+	m_iScriptLanguageServer = SL_NONE;
+	m_iScriptLanguageClient = SL_NONE;
+#endif
+
 	return BaseClass::Init( entnum, iSerialNum );
 }
 
@@ -129,11 +134,6 @@ void C_World::OnDataChanged( DataUpdateType_t updateType )
 		engine->SetOcclusionParameters( params );
 
 		modelinfo->SetLevelScreenFadeRange( m_flMinPropScreenSpaceWidth, m_flMaxPropScreenSpaceWidth );
-
-#ifdef MAPBASE_VSCRIPT
-		// This is now here so that C_World has time to receive the selected script language
-		VScriptClientInit();
-#endif
 	}
 }
 
@@ -199,6 +199,72 @@ void C_World::Spawn( void )
 	Precache();
 }
 
+//-----------------------------------------------------------------------------
+// Parse data from a map file
+//-----------------------------------------------------------------------------
+bool C_World::KeyValue( const char *szKeyName, const char *szValue ) 
+{
+#ifdef MAPBASE_VSCRIPT
+	if ( FStrEq( szKeyName, "vscriptlanguage" ) )
+	{
+		m_iScriptLanguageServer = atoi( szValue );
+	}
+	else if ( FStrEq( szKeyName, "vscriptlanguage_client" ) )
+	{
+		m_iScriptLanguageClient = atoi( szValue );
+	}
+	else
+#endif
+		return BaseClass::KeyValue( szKeyName, szValue );
+
+	return true;
+}
+
+#ifdef MAPBASE
+//-----------------------------------------------------------------------------
+// Parses worldspawn data from BSP on the client
+//-----------------------------------------------------------------------------
+void C_World::ParseWorldMapData( const char *pMapData )
+{
+	char szTokenBuffer[MAPKEY_MAXLENGTH];
+	for ( ; true; pMapData = MapEntity_SkipToNextEntity(pMapData, szTokenBuffer) )
+	{
+		//
+		// Parse the opening brace.
+		//
+		char token[MAPKEY_MAXLENGTH];
+		pMapData = MapEntity_ParseToken( pMapData, token );
+
+		//
+		// Check to see if we've finished or not.
+		//
+		if (!pMapData)
+			break;
+
+		if (token[0] != '{')
+		{
+			Error( "MapEntity_ParseAllEntities: found %s when expecting {", token);
+			continue;
+		}
+
+		CEntityMapData entData( (char*)pMapData );
+		char className[MAPKEY_MAXLENGTH];
+
+		if (!entData.ExtractValue( "classname", className ))
+		{
+			Error( "classname missing from entity!\n" );
+		}
+
+		if ( !Q_strcmp( className, "worldspawn" ) )
+		{
+			// Set up keyvalues.
+			ParseMapData( &entData );
+			return;
+		}
+	}
+}
+#endif
+
 
 
 C_World *GetClientWorldEntity()

sp/src/game/client/c_world.h

@@ -31,6 +31,7 @@ class C_World : public C_BaseEntity
 
 	virtual void Precache();
 	virtual void Spawn();
+	virtual bool KeyValue( const char *szKeyName, const char *szValue );
 
 	// Don't worry about adding the world to the collision list; it's already there
 	virtual CollideType_t	GetCollideType( void )	{ return ENTITY_SHOULD_NOT_COLLIDE; }
@@ -41,8 +42,15 @@ class C_World : public C_BaseEntity
 	float GetWaveHeight() const;
 	const char *GetDetailSpriteMaterial() const;
 
+#ifdef MAPBASE
+	// A special function which parses map data for the client world entity before LevelInitPreEntity().
+	// This can be used to access keyvalues early and without transmitting from the server.
+	void ParseWorldMapData( const char *pMapData );
+#endif
+
 #ifdef MAPBASE_VSCRIPT
-	ScriptLanguage_t GetScriptLanguage() { return (ScriptLanguage_t)m_iScriptLanguageClient; }
+	// -2 = Use server language
+	ScriptLanguage_t GetScriptLanguage() { return (ScriptLanguage_t)(m_iScriptLanguageClient != -2 ? m_iScriptLanguageClient : m_iScriptLanguageServer); }
 #endif
 
 public:
@@ -64,6 +72,7 @@ class C_World : public C_BaseEntity
 	char	m_iszChapterTitle[64];
 #endif
 #ifdef MAPBASE_VSCRIPT
+	int		m_iScriptLanguageServer;
 	int		m_iScriptLanguageClient;
 #endif
 

sp/src/game/client/cdll_client_int.cpp

@@ -147,6 +147,10 @@
 #include "fbxsystem/fbxsystem.h"
 #endif
 
+#ifdef MAPBASE_VSCRIPT
+#include "vscript_client.h"
+#endif
+
 extern vgui::IInputInternal *g_InputInternal;
 
 //=============================================================================
@@ -1104,6 +1108,9 @@ int CHLClient::Init( CreateInterfaceFn appSystemFactory, CreateInterfaceFn physi
 	g_pGameSaveRestoreBlockSet->AddBlockHandler( GetEntitySaveRestoreBlockHandler() );
 	g_pGameSaveRestoreBlockSet->AddBlockHandler( GetPhysSaveRestoreBlockHandler() );
 	g_pGameSaveRestoreBlockSet->AddBlockHandler( GetViewEffectsRestoreBlockHandler() );
+#ifdef MAPBASE_VSCRIPT
+	g_pGameSaveRestoreBlockSet->AddBlockHandler( GetVScriptSaveRestoreBlockHandler() );
+#endif
 
 	ClientWorldFactoryInit();
 
@@ -1216,6 +1223,9 @@ void CHLClient::Shutdown( void )
 	g_pGameSaveRestoreBlockSet->RemoveBlockHandler( GetViewEffectsRestoreBlockHandler() );
 	g_pGameSaveRestoreBlockSet->RemoveBlockHandler( GetPhysSaveRestoreBlockHandler() );
 	g_pGameSaveRestoreBlockSet->RemoveBlockHandler( GetEntitySaveRestoreBlockHandler() );
+#ifdef MAPBASE_VSCRIPT
+	g_pGameSaveRestoreBlockSet->RemoveBlockHandler( GetVScriptSaveRestoreBlockHandler() );
+#endif
 
 	ClientVoiceMgr_Shutdown();
 
@@ -1635,6 +1645,10 @@ void CHLClient::LevelInitPreEntity( char const* pMapName )
 	tempents->LevelInit();
 	ResetToneMapping(1.0);
 
+#ifdef MAPBASE
+	GetClientWorldEntity()->ParseWorldMapData( engine->GetMapEntitiesString() );
+#endif
+
 	IGameSystem::LevelInitPreEntityAllSystems(pMapName);
 
 #ifdef USES_ECON_ITEMS

sp/src/game/client/vscript_client.cpp

@@ -176,7 +176,16 @@ class CScriptMaterialProxy : public IMaterialProxy, public IClientScriptPersista
 	HSCRIPT			m_hFuncOnBind;
 };
 
+class CMaterialProxyScriptInstanceHelper : public IScriptInstanceHelper
+{
+	bool ToString( void *p, char *pBuf, int bufSize );
+	void *BindOnRead( HSCRIPT hInstance, void *pOld, const char *pszId );
+};
+
+CMaterialProxyScriptInstanceHelper g_MaterialProxyScriptInstanceHelper;
+
 BEGIN_SCRIPTDESC_ROOT_NAMED( CScriptMaterialProxy, "CScriptMaterialProxy", "Material proxy for VScript" )
+	DEFINE_SCRIPT_INSTANCE_HELPER( &g_MaterialProxyScriptInstanceHelper )
 	DEFINE_SCRIPTFUNC( GetVarString, "Gets a material var's string value" )
 	DEFINE_SCRIPTFUNC( GetVarInt, "Gets a material var's int value" )
 	DEFINE_SCRIPTFUNC( GetVarFloat, "Gets a material var's float value" )
@@ -406,6 +415,19 @@ void CScriptMaterialProxy::SetVarVector( int i, const Vector &value )
 }
 
 EXPOSE_INTERFACE( CScriptMaterialProxy, IMaterialProxy, "VScriptProxy" IMATERIAL_PROXY_INTERFACE_VERSION );
+
+bool CMaterialProxyScriptInstanceHelper::ToString( void *p, char *pBuf, int bufSize )
+{
+	CScriptMaterialProxy *pProxy = (CScriptMaterialProxy *)p;
+	V_snprintf( pBuf, bufSize, "(proxy: %s)", pProxy->GetMaterial() != NULL ? pProxy->GetMaterial()->GetName() : "<no material>" );
+	return true; 
+}
+
+void *CMaterialProxyScriptInstanceHelper::BindOnRead( HSCRIPT hInstance, void *pOld, const char *pszId )
+{
+	// TODO: Material proxy save/restore?
+	return NULL;
+}
 #endif // MAPBASE_VSCRIPT
 
 //-----------------------------------------------------------------------------
@@ -616,6 +638,12 @@ bool VScriptClientInit()
 				CGWarning( 1, CON_GROUP_VSCRIPT, "VM Did not start!\n" );
 			}
 		}
+#ifdef MAPBASE_VSCRIPT
+		else
+		{
+			CGMsg( 0, CON_GROUP_VSCRIPT, "VSCRIPT CLIENT: Not starting because language is set to 'none'\n" );
+		}
+#endif
 	}
 	else
 	{
@@ -657,9 +685,7 @@ class CVScriptGameSystem : public CAutoGameSystemPerFrame
 	virtual void LevelInitPreEntity( void )
 	{
 		m_bAllowEntityCreationInScripts = true;
-#ifndef MAPBASE_VSCRIPT // Now initted in C_World
 		VScriptClientInit();
-#endif
 	}
 
 	virtual void LevelInitPostEntity( void )