Initial Mapbase commit (squashed from mapbase-beta)

2026-09-23 20:09:45 +03:00 · 2019-08-31 19:28:20 +00:00
parent 0d8dceea43
commit 3d464bc051
816 changed files with 105527 additions and 957 deletions
@@ -0,0 +1,435 @@
+//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose: Carries the Mapbase CAutoGameSystem that loads manifest among other things.
+//			Also includes code that does not fit anywhere else.
+//
+// $NoKeywords: $
+//=============================================================================//
+
+#include "cbase.h"
+
+#include "tier0/icommandline.h"
+#include "igamesystem.h"
+#include "filesystem.h"
+#include <vgui_controls/Controls.h> 
+#include <vgui/ILocalize.h>
+#include "saverestore_utlvector.h"
+#include "props_shared.h"
+#include "utlbuffer.h"
+#ifdef CLIENT_DLL
+#include "hud_closecaption.h"
+#include "panelmetaclassmgr.h"
+#include "c_soundscape.h"
+#else
+#include "soundscape_system.h"
+#include "AI_ResponseSystem.h"
+#include "mapbase/SystemConvarMod.h"
+#endif
+
+// memdbgon must be the last include file in a .cpp file!!!
+#include "tier0/memdbgon.h"
+
+#define GENERIC_MANIFEST_FILE "scripts/mapbase_default_manifest.txt"
+
+#ifdef CLIENT_DLL
+#define AUTOLOADED_MANIFEST_FILE VarArgs("maps/%s_manifest.txt", g_MapName)
+#else
+#define AUTOLOADED_MANIFEST_FILE UTIL_VarArgs("maps/%s_manifest.txt", g_MapName)
+#endif
+
+// The soundscape system does not operate in a way that supports soundscape loading after map initialization.
+// I have decided to make a direct change to the system that loads "maps/%mapname%_soundscapes.txt" instead and suggest the usage of #include and #base to users.
+// Sorry. It's not broken, so I won't fix it.
+#define MAPBASE_SOUNDSCAPE_SUPPORT 0
+
+const char *g_MapName;
+
+extern ISoundEmitterSystemBase *soundemitterbase;
+
+ConVar mapbase_load_default_manifest("mapbase_load_default_manifest", "1", FCVAR_ARCHIVE, "Should we automatically load our default manifest file? (\"maps/%mapname%_manifest.txt\")");
+
+ConVar mapbase_load_soundscripts("mapbase_load_soundscripts", "1", FCVAR_ARCHIVE, "Should we load map-specific soundscripts? e.g. \"maps/mapname_level_sounds.txt\"");
+
+//ConVar mapbase_load_propdata("mapbase_load_propdata", "1", FCVAR_ARCHIVE, "Should we load map-specific propdata files? e.g. \"maps/mapname_propdata.txt\"");
+
+#if MAPBASE_SOUNDSCAPE_SUPPORT
+ConVar mapbase_load_soundscapes("mapbase_load_soundscapes", "1", FCVAR_ARCHIVE, "Should we load map-specific soundscapes? e.g. \"maps/mapname_soundscapes.txt\"");
+#endif
+
+#ifdef CLIENT_DLL
+
+//ConVar mapbase_load_cc("mapbase_load_cc", "1", FCVAR_ARCHIVE, "Should we load map-specific closed captioning? e.g. \"maps/mapname_closecaption_english.txt\" and \"maps/mapname_closecaption_english.dat\"");
+
+ConVar mapbase_load_localization("mapbase_load_localization", "1", FCVAR_ARCHIVE, "Should we load map-specific localized text files? e.g. \"maps/mapname_english.txt\"");
+
+#else
+
+ConVar mapbase_load_sentences("mapbase_load_sentences", "1", FCVAR_ARCHIVE, "Should we load map-specific sentences? e.g. \"maps/mapname_sentences.txt\"");
+
+ConVar mapbase_load_talker("mapbase_load_talker", "1", FCVAR_ARCHIVE, "Should we load map-specific talker files? e.g. \"maps/mapname_talker.txt\"");
+ConVar mapbase_flush_talker("mapbase_flush_talker", "1", FCVAR_NONE, "Normally, when a map with custom talker files is unloaded, the response system resets to rid itself of the custom file(s). Turn this convar off to prevent that from happening.");
+
+ConVar mapbase_load_actbusy("mapbase_load_actbusy", "1", FCVAR_ARCHIVE, "Should we load map-specific actbusy files? e.g. \"maps/mapname_actbusy.txt\"");
+
+#endif
+
+#ifdef GAME_DLL
+extern void ParseCustomActbusyFile(const char *file);
+
+extern bool LoadResponseSystemFile(const char *scriptfile);
+extern void ReloadResponseSystem();
+
+// Reloads the response system when the map changes to avoid custom talker leaking
+static bool g_bMapContainsCustomTalker;
+#endif
+
+// Indicates this is a core Mapbase mod and not a mod using its code.
+static bool g_bMapbaseCore;
+
+// The game's name found in gameinfo.txt. Mostly used for Discord RPC.
+char g_iszGameName[128];
+
+enum
+{
+	MANIFEST_SOUNDSCRIPTS,
+	//MANIFEST_PROPDATA,
+#if MAPBASE_SOUNDSCAPE_SUPPORT
+	MANIFEST_SOUNDSCAPES,
+#endif
+#ifdef CLIENT_DLL
+	//MANIFEST_CLOSECAPTION,
+	MANIFEST_LOCALIZATION,
+	MANIFEST_VGUI,
+#else
+	MANIFEST_TALKER,
+	MANIFEST_SENTENCES,
+	MANIFEST_ACTBUSY,
+#endif
+
+	// Must always be kept below
+	MANIFEST_NUM_TYPES,
+};
+
+struct ManifestType_t
+{
+	//int type;
+	const char *string;
+	ConVar *cvar;
+};
+
+// KEEP THS IN SYNC WITH THE ENUM!
+static const ManifestType_t gm_szManifestFileStrings[MANIFEST_NUM_TYPES] = {
+	{ "soundscripts",		&mapbase_load_soundscripts },
+	//{ "propdata",			&mapbase_load_propdata },
+#if MAPBASE_SOUNDSCAPE_SUPPORT
+	{ "soundscapes",		&mapbase_load_soundscapes },
+#endif
+#ifdef CLIENT_DLL
+	//{ "closecaption",		&mapbase_load_cc },
+	{ "localization",		&mapbase_load_localization },
+	{ "vgui",				NULL },
+#else
+	{ "talker",				&mapbase_load_talker },
+	{ "sentences",			&mapbase_load_sentences },
+	{ "actbusy",			&mapbase_load_actbusy },
+#endif
+};
+
+//-----------------------------------------------------------------------------
+// Purpose: System used to load map-specific files, etc.
+//-----------------------------------------------------------------------------
+class CMapbaseSystem : public CAutoGameSystem
+{
+public:
+	DECLARE_DATADESC();
+
+	CMapbaseSystem() : CAutoGameSystem( "CMapbaseSystem" )
+	{
+	}
+
+	inline bool GetGameInfoKeyValues(KeyValues *pKeyValues)
+	{
+		return pKeyValues->LoadFromFile( filesystem, "gameinfo.txt", "GAME" );
+	}
+
+	virtual void LevelInitPreEntity()
+	{
+#ifdef GAME_DLL
+		Msg("Mapbase system loaded\n");
+#endif
+
+		// Checks gameinfo.txt for Mapbase-specific options
+		KeyValues *gameinfo = new KeyValues("GameInfo");
+		if (GetGameInfoKeyValues(gameinfo))
+		{
+			// Indicates this is a core Mapbase mod and not a mod using its code
+			g_bMapbaseCore = gameinfo->GetBool("mapbase_core", false);
+
+			if (!gameinfo->GetBool("hide_mod_name", false))
+			{
+				// Store the game's name
+				Q_strncpy(g_iszGameName, gameinfo->GetString("game"), sizeof(g_iszGameName));
+			}
+		}
+		gameinfo->deleteThis();
+
+
+#ifdef GAME_DLL
+		if (g_bMapContainsCustomTalker && mapbase_flush_talker.GetBool())
+		{
+			DevMsg("Mapbase: Reloading response system to flush custom talker\n");
+			ReloadResponseSystem();
+			g_bMapContainsCustomTalker = false;
+		}
+
+		g_MapName = STRING(gpGlobals->mapname);
+#else
+		//char mapname[128];
+		//Q_StripExtension(MapName(), mapname, sizeof(mapname));
+		g_MapName = MapName() - 4; // Removes ".bsp"
+
+		// Shared Mapbase localization file
+		g_pVGuiLocalize->AddFile( "resource/mapbase_%language%.txt" );
+#endif
+		// Check for a generic "mapname_manifest.txt" file and load it.
+		if (filesystem->FileExists(AUTOLOADED_MANIFEST_FILE, "GAME") /*&& !FStrEq(name, "closecaption")*/)
+		{
+			AddManifestFile(AUTOLOADED_MANIFEST_FILE);
+		}
+		else
+		{
+			// Load the generic script instead.
+			ParseGenericManifest();
+		}
+	}
+
+	virtual void LevelShutdownPreEntity()
+	{
+		// How would we make sure they don't last between maps?
+		// TODO: Investigate ReloadLocalizationFiles()
+		//g_pVGuiLocalize->RemoveAll();
+		//g_pVGuiLocalize->ReloadLocalizationFiles();
+	}
+
+	virtual void LevelShutdownPostEntity()
+	{
+		g_MapName = NULL;
+	}
+
+	// Get a generic, hardcoded manifest with hardcoded names.
+	void ParseGenericManifest()
+	{
+		if (!mapbase_load_default_manifest.GetBool())
+			return;
+
+		KeyValues *pKV = new KeyValues("DefaultManifest");
+		pKV->LoadFromFile(filesystem, GENERIC_MANIFEST_FILE);
+
+		AddManifestFile(pKV/*, true*/);
+
+		pKV->deleteThis();
+	}
+	
+	void AddManifestFile( const char *file, bool bDontStore = false )
+	{
+		KeyValues *pKV = new KeyValues(file);
+		if ( !pKV->LoadFromFile( filesystem, file ) )
+		{
+			Warning("Mapbase Manifest: \"%s\" is unreadable or missing (can't load KV, check for syntax errors)\n", file);
+			pKV->deleteThis();
+			return;
+		}
+
+		DevMsg("===== Mapbase Manifest: Loading manifest file %s =====\n", file);
+
+		AddManifestFile(pKV, false);
+
+		DevMsg("==============================================================================\n");
+
+		pKV->deleteThis();
+	}
+
+	void LoadFromValue( const char *value, int type, bool bDontWarn )
+	{
+		if (!filesystem->FileExists(value, "GAME") /*&& !FStrEq(name, "closecaption")*/)
+		{
+			if (!bDontWarn)
+			{
+				Warning("Mapbase Manifest: WARNING! \"%s\" does not exist!\n", value);
+			}
+			return;
+		}
+
+		switch (type)
+		{
+			case MANIFEST_SOUNDSCRIPTS: { soundemitterbase->AddSoundOverrides(value); } break;
+			//case MANIFEST_PROPDATA: { g_PropDataSystem.ParsePropDataFile(value); } break;
+#ifdef CLIENT_DLL
+			//case MANIFEST_CLOSECAPTION: { todo } break;
+			case MANIFEST_LOCALIZATION: { g_pVGuiLocalize->AddFile( value, "GAME", true ); } break;
+			case MANIFEST_VGUI: { PanelMetaClassMgr()->LoadMetaClassDefinitionFile( value ); } break;
+#if MAPBASE_SOUNDSCAPE_SUPPORT
+			case MANIFEST_SOUNDSCAPES: { Soundscape_AddFile(value); } break;
+#endif
+#else
+			case MANIFEST_TALKER: {
+					g_bMapContainsCustomTalker = true;
+					LoadResponseSystemFile(value); //PrecacheCustomResponseSystem( value );
+				} break;
+#if MAPBASE_SOUNDSCAPE_SUPPORT
+			case MANIFEST_SOUNDSCAPES: { g_SoundscapeSystem.AddSoundscapeFile(value); } break;
+#endif
+			case MANIFEST_SENTENCES: { engine->PrecacheSentenceFile(value); } break;
+			case MANIFEST_ACTBUSY: { ParseCustomActbusyFile(value); } break;
+#endif
+		}
+	}
+
+	// This doesn't call deleteThis()!
+	void AddManifestFile(KeyValues *pKV, bool bDontWarn = false)
+	{
+		const char *name;
+		char value[MAX_PATH];
+		char *szToken;
+		bool inparam = false;
+		for (KeyValues *pKey = pKV->GetFirstSubKey(); pKey; pKey = pKey->GetNextKey())
+		{
+			name = pKey->GetName();
+
+			// Parse %mapname%, etc.
+			inparam = false;
+			value[0] = '\0';
+			szToken = strtok(strdup(pKey->GetString()), "%"); // Was tempvalue
+			while (szToken != NULL)
+			{
+				if (inparam)
+				{
+					const char *append = szToken;
+					if (FStrEq(szToken, "mapname"))
+						append = g_MapName;
+					//else if (FStrEq(szToken, "mapdir"))
+					//{
+					//	// TODO
+					//}
+#ifdef CLIENT_DLL
+					else if (FStrEq(szToken, "language"))
+					{
+						char uilanguage[64];
+						engine->GetUILanguage(uilanguage, sizeof(uilanguage));
+						append = uilanguage;
+					}
+#endif
+					Q_strncat(value, append, sizeof(value));
+
+					inparam = false;
+				}
+				else
+				{
+					Q_strncat(value, szToken, sizeof(value));
+
+					inparam = true;
+				}
+				szToken = strtok(NULL, "%");
+			}
+
+			if (FStrEq(name, "NoErrors"))
+			{
+				bDontWarn = pKey->GetBool();
+			}
+
+			for (int i = 0; i < MANIFEST_NUM_TYPES; i++)
+			{
+				if (FStrEq(name, gm_szManifestFileStrings[i].string))
+				{
+					if (!gm_szManifestFileStrings[i].cvar || gm_szManifestFileStrings[i].cvar->GetBool())
+					{
+						LoadFromValue(value, i, bDontWarn);
+					}
+					break;
+				}
+			}
+		}
+	}
+};
+
+CMapbaseSystem	g_MapbaseSystem;
+
+BEGIN_DATADESC_NO_BASE( CMapbaseSystem )
+
+	//DEFINE_UTLVECTOR( m_StoredManifestFiles, FIELD_STRING ),
+
+END_DATADESC()
+
+#ifdef GAME_DLL
+ThreeState_t Flashlight_GetLegacyVersionKey()
+{
+	KeyValues *gameinfo = new KeyValues( "GameInfo" );
+	if (g_MapbaseSystem.GetGameInfoKeyValues( gameinfo ))
+	{
+		// -1 = default
+		int iUseLegacyFlashlight = gameinfo->GetInt( "use_legacy_flashlight", -1 );
+		if (iUseLegacyFlashlight > -1)
+			return iUseLegacyFlashlight != 0 ? TRS_TRUE : TRS_FALSE;
+	}
+	gameinfo->deleteThis();
+
+	return TRS_NONE;
+}
+
+static void CC_Mapbase_LoadManifestFile( const CCommand& args )
+{
+	g_MapbaseSystem.AddManifestFile(args[1], args[2]);
+}
+
+static ConCommand mapbase_loadmanifestfile("mapbase_loadmanifestfile", CC_Mapbase_LoadManifestFile, "Loads a Mapbase manifest file. If you don't want this to be saved and found when reloaded, type a '1' after the file path." );
+
+#define SF_MANIFEST_START_ACTIVATED (1 << 0)
+
+class CMapbaseManifestEntity : public CPointEntity
+{
+public:
+	DECLARE_DATADESC();
+
+	DECLARE_CLASS( CMapbaseManifestEntity, CPointEntity );
+
+	void Spawn( void )
+	{
+		BaseClass::Spawn();
+		if (HasSpawnFlags(SF_MANIFEST_START_ACTIVATED))
+		{
+			LoadManifestFile();
+		}
+	}
+
+	void LoadManifestFile( void )
+	{
+		const char *scriptfile = STRING(m_target);
+		if ( filesystem->FileExists( scriptfile, "GAME" ) )
+		{
+			Msg("Mapbase: Adding manifest file \"%s\"\n", scriptfile);
+			g_MapbaseSystem.AddManifestFile(scriptfile);
+		}
+		else
+		{
+			Warning("Mapbase: Manifest file \"%s\" does not exist!", scriptfile);
+		}
+	}
+
+	void InputActivate(inputdata_t &inputdata)
+	{
+		LoadManifestFile();
+	}
+};
+
+LINK_ENTITY_TO_CLASS( mapbase_manifest, CMapbaseManifestEntity );
+
+BEGIN_DATADESC( CMapbaseManifestEntity )
+
+	// Needs to be set up in the Activate methods of derived classes
+	//DEFINE_CUSTOM_FIELD( m_pInstancedResponseSystem, responseSystemSaveRestoreOps ),
+
+	// Function Pointers
+	DEFINE_INPUTFUNC( FIELD_VOID, "Activate", InputActivate ),
+
+END_DATADESC()
+#endif