Add hud system with HTML formatting & priority handling

To avoid conflicting with env_hudhint usage in maps, CS2Fixes will now use this instead of HUD_PRINTCENTER

Author: Vauff

AMBuilder

@@ -48,6 +48,7 @@ for sdk_target in MMSPlugin.sdk_targets:
     'src/events.cpp',
     'src/utils/entity.cpp',
     'src/utils/weapon.cpp',
+    'src/utils/hud_manager.cpp',
     'src/cs2_sdk/entity/services.cpp',
     'src/cs2_sdk/entity/ccsplayerpawn.cpp',
     'src/cs2_sdk/entity/cbasemodelentity.cpp',

CS2Fixes.vcxproj

@@ -217,6 +217,7 @@
     <ClCompile Include="src\utils\plat_unix.cpp" />
     <ClCompile Include="src\utils\plat_win.cpp" />
     <ClCompile Include="src\utils\weapon.cpp" />
+    <ClCompile Include="src\utils\hud_manager.cpp" />
     <ClCompile Include="src\cs2_sdk\entity\services.cpp" />
     <ClCompile Include="src\cs2_sdk\entity\ccsplayerpawn.cpp" />
     <ClCompile Include="src\cs2_sdk\entity\cbasemodelentity.cpp" />
@@ -294,6 +295,7 @@
     <ClInclude Include="src\netmessages.h" />
     <ClInclude Include="src\utils\weapon.h" />
     <ClInclude Include="src\utils\version_gen_placeholder.h" />
+    <ClInclude Include="src\utils\hud_manager.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets" />

CS2Fixes.vcxproj.filters

@@ -182,6 +182,9 @@
     <ClCompile Include="src\utils\weapon.cpp">
       <Filter>Source Files\utils</Filter>
     </ClCompile>
+    <ClCompile Include="src\utils\hud_manager.cpp">
+      <Filter>Source Files\utils</Filter>
+    </ClCompile>
     <ClCompile Include="src\cs2_sdk\entity\services.cpp">
       <Filter>Source Files\cs2_sdk\entity</Filter>
     </ClCompile>
@@ -409,5 +412,8 @@
     <ClInclude Include="src\utils\version_gen_placeholder.h">
       <Filter>Header Files\utils</Filter>
     </ClInclude>
+    <ClInclude Include="src\utils\hud_manager.h">
+      <Filter>Header Files\utils</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

cfg/cs2fixes/cs2fixes.cfg

@@ -26,6 +26,7 @@ cs2f_prevent_using_players		0		// Whether to prevent +use from hitting players (
 cs2f_map_steamids_enable		0		// Whether to make Steam ID's available to maps
 cs2f_fix_game_bans				0		// Whether to fix CS2 game bans spreading to all new joining players
 cs2f_free_armor					0		// Whether kevlar (1+) and/or helmet (2) are given automatically
+cs2f_fix_hud_flashing			0		// Whether to fix hud flashing using a workaround, this BREAKS warmup so pick one or the other
 
 cs2f_beacon_particle			"particles/cs2fixes/admin_beacon.vpcf" // .vpcf file to be precached and used for player beacon
 

src/adminsystem.cpp

@@ -29,6 +29,7 @@
 #include "entwatch.h"
 #include "filesystem.h"
 #include "gamesystem.h"
+#include "hud_manager.h"
 #include "icvar.h"
 #include "interfaces/interfaces.h"
 #include "map_votes.h"
@@ -560,7 +561,7 @@ CON_COMMAND_CHAT_FLAGS(hsay, "<message> - Say something as a hud hint", ADMFLAG_
 		return;
 	}
 
-	ClientPrintAll(HUD_PRINTCENTER, "%s", args.ArgS());
+	SendHudMessageAll(10, 99, "<span class='fontSize-l'><span color='#FFFFFF'>ADMIN: </span><span color='#D11313'>%s</span></span>", args.ArgS());
 }
 
 CON_COMMAND_CHAT_FLAGS(rcon, "<command> - Send a command to server console", ADMFLAG_RCON)

src/cs2_sdk/entity/cgamerules.h

@@ -73,6 +73,8 @@ class CCSGameRules : public CGameRules
 	SCHEMA_FIELD_POINTER(CUtlVector<SpawnPoint*>, m_TerroristSpawnPoints)
 	SCHEMA_FIELD(int, m_iMaxNumTerrorists)
 	SCHEMA_FIELD(int, m_iMaxNumCTs)
+	SCHEMA_FIELD(bool, m_bGameRestart)
+	SCHEMA_FIELD(bool, m_bWarmupPeriod)
 
 	void TerminateRound(float flDelay, CSRoundEndReason reason)
 	{

src/cs2fixes.cpp

@@ -41,6 +41,7 @@
 #include "gameevents.pb.h"
 #include "gamesystem.h"
 #include "httpmanager.h"
+#include "hud_manager.h"
 #include "icvar.h"
 #include "idlemanager.h"
 #include "interface.h"
@@ -1315,6 +1316,8 @@ void CS2Fixes::OnLevelInit(char const* pMapName,
 
 	if (g_cvarEnableEntWatch.Get())
 		EW_OnLevelInit(pMapName);
+
+	StartFlashingFixTimer();
 }
 
 void CS2Fixes::OnLevelShutdown()

src/events.cpp

@@ -26,6 +26,7 @@
 #include "entity/cgamerules.h"
 #include "entwatch.h"
 #include "eventlistener.h"
+#include "hud_manager.h"
 #include "idlemanager.h"
 #include "leader.h"
 #include "map_votes.h"
@@ -257,6 +258,10 @@ GAME_EVENT_F(round_start)
 	if (g_cvarFullAllTalk.Get())
 		g_pEngineServer2->ServerCommand("sv_full_alltalk 1");
 
+	// Ensure there's no warmup, because mp_warmup_online_enabled gets randomly ignored for some reason, this is a problem with cs2f_fix_hud_flashing
+	if (g_cvarFixHudFlashing.Get() && g_pGameRules && g_pGameRules->m_bWarmupPeriod)
+		g_pEngineServer2->ServerCommand("mp_warmup_end");
+
 	if (!g_cvarEnableTopDefender.Get() || !GetGlobals())
 		return;
 
@@ -275,6 +280,9 @@ GAME_EVENT_F(round_start)
 
 GAME_EVENT_F(round_end)
 {
+	if (g_cvarFixHudFlashing.Get() && g_pGameRules)
+		g_pGameRules->m_bGameRestart = false;
+
 	if (!g_cvarEnableTopDefender.Get() || !GetGlobals())
 		return;
 

src/utils/hud_manager.cpp

@@ -0,0 +1,148 @@
+/**
+ * =============================================================================
+ * CS2Fixes
+ * Copyright (C) 2023-2025 Source2ZE
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "hud_manager.h"
+#include "../cs2fixes.h"
+#include "../ctimer.h"
+#include "../recipientfilters.h"
+#include "engine/igameeventsystem.h"
+#include "entity/cgamerules.h"
+#include "gameevents.pb.h"
+#include "networksystem/inetworkmessages.h"
+
+extern CCSGameRules* g_pGameRules;
+extern IGameEventManager2* g_gameEventManager;
+extern IGameEventSystem* g_gameEventSystem;
+extern CGlobalVars* GetGlobals();
+
+CConVar<bool> g_cvarFixHudFlashing("cs2f_fix_hud_flashing", FCVAR_NONE, "Whether to fix hud flashing using a workaround, this BREAKS warmup so pick one or the other", false);
+static std::vector<std::shared_ptr<CHudMessage>> g_vecHudMessages;
+
+bool ShouldDisplayForPlayer(ZEPlayerHandle hPlayer, int iPriority)
+{
+	for (std::shared_ptr<CHudMessage> pHudMessage : g_vecHudMessages)
+	{
+		// Require higher priority to block, so if priority matches most recent message takes precedence
+		if (pHudMessage->HasRecipient(hPlayer) && pHudMessage->GetPriority() > iPriority)
+			return false;
+	}
+
+	return true;
+}
+
+void CreateHudMessage(std::shared_ptr<CHudMessage> pHudMessage)
+{
+	IGameEvent* pEvent = g_gameEventManager->CreateEvent("show_survival_respawn_status");
+
+	if (!pEvent)
+		return;
+
+	pEvent->SetString("loc_token", pHudMessage->GetMessage());
+	pEvent->SetInt("duration", pHudMessage->GetDuration());
+	pEvent->SetInt("userid", -1);
+
+	INetworkMessageInternal* pMsg = g_pNetworkMessages->FindNetworkMessageById(GE_Source1LegacyGameEvent);
+
+	if (!pMsg)
+	{
+		g_gameEventManager->FreeEvent(pEvent);
+		return;
+	}
+
+	CNetMessagePB<CMsgSource1LegacyGameEvent>* data = pMsg->AllocateMessage()->ToPB<CMsgSource1LegacyGameEvent>();
+	CRecipientFilter filter;
+
+	for (ZEPlayerHandle hPlayer : pHudMessage->GetRecipients())
+		if (ShouldDisplayForPlayer(hPlayer, pHudMessage->GetPriority()))
+			filter.AddRecipient(hPlayer.Get()->GetPlayerSlot());
+
+	// Store the new hud message
+	g_vecHudMessages.push_back(pHudMessage);
+
+	// Start a timer to remove this hud message after its duration passes
+	new CTimer(pHudMessage->GetDuration(), true, true, [pHudMessage]() {
+		g_vecHudMessages.erase(std::remove(g_vecHudMessages.begin(), g_vecHudMessages.end(), pHudMessage), g_vecHudMessages.end());
+
+		return -1.0f;
+	});
+
+	g_gameEventManager->SerializeEvent(pEvent, data);
+	g_gameEventSystem->PostEventAbstract(-1, false, &filter, pMsg, data, 0);
+	delete data;
+	g_gameEventManager->FreeEvent(pEvent);
+}
+
+void SendHudMessage(ZEPlayer* pPlayer, int iDuration, int iPriority, const char* pszMessage, ...)
+{
+	va_list args;
+	va_start(args, pszMessage);
+
+	char buf[1024];
+	V_vsnprintf(buf, sizeof(buf), pszMessage, args);
+
+	va_end(args);
+
+	std::shared_ptr<CHudMessage> pHudMessage = std::make_shared<CHudMessage>(buf, iDuration, iPriority);
+
+	pHudMessage->AddRecipient(pPlayer->GetHandle());
+	CreateHudMessage(pHudMessage);
+}
+
+void SendHudMessageAll(int iDuration, int iPriority, const char* pszMessage, ...)
+{
+	if (!GetGlobals())
+		return;
+
+	va_list args;
+	va_start(args, pszMessage);
+
+	char buf[1024];
+	V_vsnprintf(buf, sizeof(buf), pszMessage, args);
+
+	va_end(args);
+
+	std::shared_ptr<CHudMessage> pHudMessage = std::make_shared<CHudMessage>(buf, iDuration, iPriority);
+
+	for (int i = 0; i < GetGlobals()->maxClients; i++)
+	{
+		ZEPlayer* pPlayer = g_playerManager->GetPlayer(i);
+
+		if (pPlayer)
+			pHudMessage->AddRecipient(pPlayer->GetHandle());
+	}
+
+	CreateHudMessage(pHudMessage);
+}
+
+void StartFlashingFixTimer()
+{
+	// Timer that fakes m_bGameRestart enabled, to fix flashing with show_survival_respawn_status
+	new CTimer(0.5f, false, true, []() {
+		if (!g_cvarFixHudFlashing.Get() || !g_pGameRules)
+			return 0.5f;
+
+		// Faking m_bGameRestart as true close to a round ending causes UI to falsely show game is restarting
+		if (g_pGameRules->m_flRestartRoundTime.Get().GetTime() == 0.0f)
+			g_pGameRules->m_bGameRestart = true;
+		else
+			g_pGameRules->m_bGameRestart = false;
+
+		return 0.5f;
+	});
+}

src/utils/hud_manager.h

@@ -0,0 +1,57 @@
+/**
+ * =============================================================================
+ * CS2Fixes
+ * Copyright (C) 2023-2025 Source2ZE
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "../playermanager.h"
+#include <string>
+#include <vector>
+
+class CHudMessage
+{
+public:
+	CHudMessage(std::string sMessage, int iDuration, int iPriority)
+	{
+		m_strMessage = sMessage;
+		m_iDuration = iDuration;
+		m_iPriority = iPriority;
+	}
+
+	const char* GetMessage() { return m_strMessage.c_str(); };
+	int GetDuration() { return m_iDuration; };
+	int GetPriority() { return m_iPriority; };
+	std::vector<ZEPlayerHandle> GetRecipients() { return m_vecRecipients; };
+	bool HasRecipient(ZEPlayerHandle hPlayer) { return std::find(m_vecRecipients.begin(), m_vecRecipients.end(), hPlayer) != m_vecRecipients.end(); };
+	void AddRecipient(ZEPlayerHandle hPlayer) { m_vecRecipients.push_back(hPlayer); };
+
+private:
+	std::string m_strMessage;
+	int m_iDuration;
+	int m_iPriority;
+	std::vector<ZEPlayerHandle> m_vecRecipients;
+};
+
+// When multiple hud messages are active, whichever one has highest priority one will display
+// Note this is a basic implementation (TODO: is this worth expanding?), so e.g. a previously sent lower priority message will not display once a higher priority one expires
+void SendHudMessage(ZEPlayer* pPlayer, int iDuration, int iPriority, const char* pszMessage, ...);
+void SendHudMessageAll(int iDuration, int iPriority, const char* pszMessage, ...);
+
+void StartFlashingFixTimer();
+
+extern CConVar<bool> g_cvarFixHudFlashing;