Add a new stock for clarity and remove an old stock (#370)

Sarrus1 · web-flow · commit c2c898f63366 · 2022-01-18T19:30:40.000Z
* Fix: `surftimer_OnNewWRCP` forwards formatted time

* Fix: Time formatting

* Add a new stock for clarity
diff --git a/addons/sourcemod/scripting/surftimer/buttonpress.sp b/addons/sourcemod/scripting/surftimer/buttonpress.sp
@@ -12,7 +12,7 @@ public void CL_OnStartTimerPress(int client)
 				if (fGetGameTime - g_fErrorMessage[client] > 1.0)
 				{
 					CPrintToChat(client, "%t", "BPress1", g_szChatPrefix);
-					ClientCommand(client, "play buttons\\button10.wav");
+					EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);
 					g_fErrorMessage[client] = fGetGameTime;
 				}
 				return;
@@ -22,7 +22,7 @@ public void CL_OnStartTimerPress(int client)
 				if (fGetGameTime - g_fErrorMessage[client] > 1.0)
 				{
 					CPrintToChat(client, "%t", "BPress2", g_szChatPrefix);
-					ClientCommand(client, "play buttons\\button10.wav");
+					EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);
 					g_fErrorMessage[client] = fGetGameTime;
 				}
 				return;
@@ -32,7 +32,7 @@ public void CL_OnStartTimerPress(int client)
 				if (fGetGameTime - g_fErrorMessage[client] > 1.0)
 				{
 					CPrintToChat(client, "%t", "BPress3", g_szChatPrefix);
-					ClientCommand(client, "play buttons\\button10.wav");
+					EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);
 					g_fErrorMessage[client] = fGetGameTime;
 				}
 				return;
@@ -176,7 +176,7 @@ public void CL_OnEndTimerPress(int client)
 	// If timer is not on, play error sound and return
 	if (!g_bTimerRunning[client])
 	{
-		ClientCommand(client, "play buttons\\button10.wav");
+		EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);
 		return;
 	}
 	else
diff --git a/addons/sourcemod/scripting/surftimer/commands.sp b/addons/sourcemod/scripting/surftimer/commands.sp
@@ -1326,7 +1326,7 @@ public Action Command_Restart(int client, int args)
 			g_fClientRestarting[client] = GetGameTime();
 			g_bClientRestarting[client] = true;
 			CPrintToChat(client, "%t", "Commands34", g_szChatPrefix);
-			ClientCommand(client, "play ambient/misc/clank4");
+			EmitSoundToClientNoPreCache(client, "play ambient/misc/clank4", false);
 			return Plugin_Handled;
 		}
 	}
diff --git a/addons/sourcemod/scripting/surftimer/misc.sp b/addons/sourcemod/scripting/surftimer/misc.sp
@@ -1124,8 +1124,7 @@ public void PlayButtonSound(int client)
 	{
 		char buffer[255];
 		GetConVarString(g_hSoundPath, buffer, 255);
-		Format(buffer, sizeof(buffer), "play %s", buffer);
-		ClientCommand(client, buffer);
+		EmitSoundToClientNoPreCache(client, buffer);
 	}
 
 	// Spectators button sound
@@ -1141,8 +1140,7 @@ public void PlayButtonSound(int client)
 				{
 					char szsound[255];
 					GetConVarString(g_hSoundPath, szsound, 256);
-					Format(szsound, sizeof(szsound), "play %s", szsound);
-					ClientCommand(i, szsound);
+					EmitSoundToClientNoPreCache(client, szsound);
 				}
 			}
 		}
@@ -1535,8 +1533,7 @@ public void PlayRecordSound(int iRecordtype)
 		{
 			if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)
 			{
-				Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWR);
-				ClientCommand(i, buffer);
+				EmitSoundToClientNoPreCache(i, buffer);
 			}
 		}
 	}
@@ -1546,8 +1543,7 @@ public void PlayRecordSound(int iRecordtype)
 		{
 			if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)
 			{
-				Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWR);
-				ClientCommand(i, buffer);
+				EmitSoundToClientNoPreCache(i, buffer);
 			}
 		}
 	}
@@ -1557,8 +1553,7 @@ public void PlayRecordSound(int iRecordtype)
 		{
 			if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)
 			{
-				Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathTop);
-				ClientCommand(i, buffer);
+				EmitSoundToClientNoPreCache(i, buffer);
 			}
 		}
 	}
@@ -1568,19 +1563,18 @@ public void PlayRecordSound(int iRecordtype)
 		{
 			if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)
 			{
-				Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathTop);
-				ClientCommand(i, buffer);
+				EmitSoundToClientNoPreCache(i, buffer);
 			}
 		}
 	}
 }
 
 public void PlayUnstoppableSound(int client)
 {
-	char buffer[255];
-	Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathPB);
 	if (!IsFakeClient(client) && g_bEnableQuakeSounds[client])
-		ClientCommand(client, buffer);
+	{
+		EmitSoundToClientNoPreCache(client, g_szRelativeSoundPathPB);
+	}
 	// Spec Stop Sound
 	for (int i = 1; i <= MaxClients; i++)
 	{
@@ -1591,7 +1585,9 @@ public void PlayUnstoppableSound(int client)
 			{
 				int Target = GetEntPropEnt(i, Prop_Send, "m_hObserverTarget");
 				if (Target == client && g_bEnableQuakeSounds[i])
-					ClientCommand(i, buffer);
+				{
+					EmitSoundToClientNoPreCache(i, g_szRelativeSoundPathPB);
+				}
 			}
 		}
 	}
@@ -1604,8 +1600,7 @@ public void PlayWRCPRecord()
 	{
 		if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)
 		{
-			Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWRCP);
-			ClientCommand(i, buffer);
+			EmitSoundToClientNoPreCache(i, buffer);
 		}
 	}
 }
@@ -2813,25 +2808,6 @@ stock int BooltoInt(bool status)
 	return (status) ? 1:0;
 }
 
-public void PlayQuakeSound_Spec(int client, char[] buffer)
-{
-	int SpecMode;
-	for (int x = 1; x <= MaxClients; x++)
-	{
-		if (IsValidClient(x) && !IsPlayerAlive(x))
-		{
-			SpecMode = GetEntProp(x, Prop_Send, "m_iObserverMode");
-			if (SpecMode == 4 || SpecMode == 5)
-			{
-				int Target = GetEntPropEnt(x, Prop_Send, "m_hObserverTarget");
-				if (Target == client)
-					if (g_bEnableQuakeSounds[x])
-					ClientCommand(x, buffer);
-			}
-		}
-	}
-}
-
 public void AttackProtection(int client, int &buttons)
 {
 	if (GetConVarBool(g_hAttackSpamProtection))
@@ -5337,3 +5313,26 @@ void RemoveColors(char[] message, int maxlength)
 	CRemoveTags(message, maxlength);
 	CRemoveColors(message, maxlength);
 }
+
+
+/**
+ * Emit a sound to a client without having to precache the sound.
+ * See https://wiki.alliedmods.net/Csgo_quirks#The_.22play.22_client_command for more details.
+ * 
+ * @param client      The client's id.
+ * @param szPath      The path of the sound with or without "play " as a suffix.
+ * @param addPlay     Whether or not "play " should be append to the begining of szPath (default = true).
+ */
+stock void EmitSoundToClientNoPreCache(int client, const char[] szPath, bool addPlay = true)
+{
+	char szBuffer[256];
+	if(addPlay)
+	{
+		Format(szBuffer, sizeof szBuffer, "play %s", szPath);
+	}
+	else
+	{
+		strcopy(szBuffer, sizeof szBuffer, szPath);
+	}
+	ClientCommand(client, szBuffer);
+}
diff --git a/addons/sourcemod/scripting/surftimer/surfzones.sp b/addons/sourcemod/scripting/surftimer/surfzones.sp
@@ -594,7 +594,7 @@ public void EndTouch(int client, int action[3])
 				if (g_bNoClip[client] || (!g_bNoClip[client] && (GetGameTime() - g_fLastTimeNoClipUsed[client]) < 3.0))
 				{
 					CPrintToChat(client, "%t", "SurfZones1", g_szChatPrefix);
-					ClientCommand(client, "play buttons\\button10.wav");
+					EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);
 					// fluffys
 					// ClientCommand(client, "sm_stuck");
 				}

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public void CL_OnStartTimerPress(int client)`
`12`	`12`	`if (fGetGameTime - g_fErrorMessage[client] > 1.0)`
`13`	`13`	`{`
`14`	`14`	`CPrintToChat(client, "%t", "BPress1", g_szChatPrefix);`
`15`		`- ClientCommand(client, "play buttons\\button10.wav");`
	`15`	`+ EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);`
`16`	`16`	`g_fErrorMessage[client] = fGetGameTime;`
`17`	`17`	`}`
`18`	`18`	`return;`
`@@ -22,7 +22,7 @@ public void CL_OnStartTimerPress(int client)`
`22`	`22`	`if (fGetGameTime - g_fErrorMessage[client] > 1.0)`
`23`	`23`	`{`
`24`	`24`	`CPrintToChat(client, "%t", "BPress2", g_szChatPrefix);`
`25`		`- ClientCommand(client, "play buttons\\button10.wav");`
	`25`	`+ EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);`
`26`	`26`	`g_fErrorMessage[client] = fGetGameTime;`
`27`	`27`	`}`
`28`	`28`	`return;`
`@@ -32,7 +32,7 @@ public void CL_OnStartTimerPress(int client)`
`32`	`32`	`if (fGetGameTime - g_fErrorMessage[client] > 1.0)`
`33`	`33`	`{`
`34`	`34`	`CPrintToChat(client, "%t", "BPress3", g_szChatPrefix);`
`35`		`- ClientCommand(client, "play buttons\\button10.wav");`
	`35`	`+ EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);`
`36`	`36`	`g_fErrorMessage[client] = fGetGameTime;`
`37`	`37`	`}`
`38`	`38`	`return;`
`@@ -176,7 +176,7 @@ public void CL_OnEndTimerPress(int client)`
`176`	`176`	`// If timer is not on, play error sound and return`
`177`	`177`	`if (!g_bTimerRunning[client])`
`178`	`178`	`{`
`179`		`- ClientCommand(client, "play buttons\\button10.wav");`
	`179`	`+ EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);`
`180`	`180`	`return;`
`181`	`181`	`}`
`182`	`182`	`else`
Original file line number	Diff line number	Diff line change
`@@ -1326,7 +1326,7 @@ public Action Command_Restart(int client, int args)`
`1326`	`1326`	`g_fClientRestarting[client] = GetGameTime();`
`1327`	`1327`	`g_bClientRestarting[client] = true;`
`1328`	`1328`	`CPrintToChat(client, "%t", "Commands34", g_szChatPrefix);`
`1329`		`- ClientCommand(client, "play ambient/misc/clank4");`
	`1329`	`+ EmitSoundToClientNoPreCache(client, "play ambient/misc/clank4", false);`
`1330`	`1330`	`return Plugin_Handled;`
`1331`	`1331`	`}`
`1332`	`1332`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1124,8 +1124,7 @@ public void PlayButtonSound(int client)`
`1124`	`1124`	`{`
`1125`	`1125`	`char buffer[255];`
`1126`	`1126`	`GetConVarString(g_hSoundPath, buffer, 255);`
`1127`		`- Format(buffer, sizeof(buffer), "play %s", buffer);`
`1128`		`- ClientCommand(client, buffer);`
	`1127`	`+ EmitSoundToClientNoPreCache(client, buffer);`
`1129`	`1128`	`}`
`1130`	`1129`
`1131`	`1130`	`// Spectators button sound`
`@@ -1141,8 +1140,7 @@ public void PlayButtonSound(int client)`
`1141`	`1140`	`{`
`1142`	`1141`	`char szsound[255];`
`1143`	`1142`	`GetConVarString(g_hSoundPath, szsound, 256);`
`1144`		`- Format(szsound, sizeof(szsound), "play %s", szsound);`
`1145`		`- ClientCommand(i, szsound);`
	`1143`	`+ EmitSoundToClientNoPreCache(client, szsound);`
`1146`	`1144`	`}`
`1147`	`1145`	`}`
`1148`	`1146`	`}`
`@@ -1535,8 +1533,7 @@ public void PlayRecordSound(int iRecordtype)`
`1535`	`1533`	`{`
`1536`	`1534`	`if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)`
`1537`	`1535`	`{`
`1538`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWR);`
`1539`		`- ClientCommand(i, buffer);`
	`1536`	`+ EmitSoundToClientNoPreCache(i, buffer);`
`1540`	`1537`	`}`
`1541`	`1538`	`}`
`1542`	`1539`	`}`
`@@ -1546,8 +1543,7 @@ public void PlayRecordSound(int iRecordtype)`
`1546`	`1543`	`{`
`1547`	`1544`	`if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)`
`1548`	`1545`	`{`
`1549`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWR);`
`1550`		`- ClientCommand(i, buffer);`
	`1546`	`+ EmitSoundToClientNoPreCache(i, buffer);`
`1551`	`1547`	`}`
`1552`	`1548`	`}`
`1553`	`1549`	`}`
`@@ -1557,8 +1553,7 @@ public void PlayRecordSound(int iRecordtype)`
`1557`	`1553`	`{`
`1558`	`1554`	`if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)`
`1559`	`1555`	`{`
`1560`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathTop);`
`1561`		`- ClientCommand(i, buffer);`
	`1556`	`+ EmitSoundToClientNoPreCache(i, buffer);`
`1562`	`1557`	`}`
`1563`	`1558`	`}`
`1564`	`1559`	`}`
`@@ -1568,19 +1563,18 @@ public void PlayRecordSound(int iRecordtype)`
`1568`	`1563`	`{`
`1569`	`1564`	`if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)`
`1570`	`1565`	`{`
`1571`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathTop);`
`1572`		`- ClientCommand(i, buffer);`
	`1566`	`+ EmitSoundToClientNoPreCache(i, buffer);`
`1573`	`1567`	`}`
`1574`	`1568`	`}`
`1575`	`1569`	`}`
`1576`	`1570`	`}`
`1577`	`1571`
`1578`	`1572`	`public void PlayUnstoppableSound(int client)`
`1579`	`1573`	`{`
`1580`		`- char buffer[255];`
`1581`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathPB);`
`1582`	`1574`	`if (!IsFakeClient(client) && g_bEnableQuakeSounds[client])`
`1583`		`- ClientCommand(client, buffer);`
	`1575`	`+ {`
	`1576`	`+ EmitSoundToClientNoPreCache(client, g_szRelativeSoundPathPB);`
	`1577`	`+ }`
`1584`	`1578`	`// Spec Stop Sound`
`1585`	`1579`	`for (int i = 1; i <= MaxClients; i++)`
`1586`	`1580`	`{`
`@@ -1591,7 +1585,9 @@ public void PlayUnstoppableSound(int client)`
`1591`	`1585`	`{`
`1592`	`1586`	`int Target = GetEntPropEnt(i, Prop_Send, "m_hObserverTarget");`
`1593`	`1587`	`if (Target == client && g_bEnableQuakeSounds[i])`
`1594`		`- ClientCommand(i, buffer);`
	`1588`	`+ {`
	`1589`	`+ EmitSoundToClientNoPreCache(i, g_szRelativeSoundPathPB);`
	`1590`	`+ }`
`1595`	`1591`	`}`
`1596`	`1592`	`}`
`1597`	`1593`	`}`
`@@ -1604,8 +1600,7 @@ public void PlayWRCPRecord()`
`1604`	`1600`	`{`
`1605`	`1601`	`if (IsValidClient(i) && !IsFakeClient(i) && g_bEnableQuakeSounds[i] == true)`
`1606`	`1602`	`{`
`1607`		`- Format(buffer, sizeof(buffer), "play %s", g_szRelativeSoundPathWRCP);`
`1608`		`- ClientCommand(i, buffer);`
	`1603`	`+ EmitSoundToClientNoPreCache(i, buffer);`
`1609`	`1604`	`}`
`1610`	`1605`	`}`
`1611`	`1606`	`}`
`@@ -2813,25 +2808,6 @@ stock int BooltoInt(bool status)`
`2813`	`2808`	`return (status) ? 1:0;`
`2814`	`2809`	`}`
`2815`	`2810`
`2816`		`-public void PlayQuakeSound_Spec(int client, char[] buffer)`
`2817`		`-{`
`2818`		`- int SpecMode;`
`2819`		`- for (int x = 1; x <= MaxClients; x++)`
`2820`		`- {`
`2821`		`- if (IsValidClient(x) && !IsPlayerAlive(x))`
`2822`		`- {`
`2823`		`- SpecMode = GetEntProp(x, Prop_Send, "m_iObserverMode");`
`2824`		`- if (SpecMode == 4 \|\| SpecMode == 5)`
`2825`		`- {`
`2826`		`- int Target = GetEntPropEnt(x, Prop_Send, "m_hObserverTarget");`
`2827`		`- if (Target == client)`
`2828`		`- if (g_bEnableQuakeSounds[x])`
`2829`		`- ClientCommand(x, buffer);`
`2830`		`- }`
`2831`		`- }`
`2832`		`- }`
`2833`		`-}`
`2834`		`-`
`2835`	`2811`	`public void AttackProtection(int client, int &buttons)`
`2836`	`2812`	`{`
`2837`	`2813`	`if (GetConVarBool(g_hAttackSpamProtection))`
`@@ -5337,3 +5313,26 @@ void RemoveColors(char[] message, int maxlength)`
`5337`	`5313`	`CRemoveTags(message, maxlength);`
`5338`	`5314`	`CRemoveColors(message, maxlength);`
`5339`	`5315`	`}`
	`5316`	`+`
	`5317`	`+`
	`5318`	`+/**`
	`5319`	`+ * Emit a sound to a client without having to precache the sound.`
	`5320`	`+ * See https://wiki.alliedmods.net/Csgo_quirks#The_.22play.22_client_command for more details.`
	`5321`	`+ *`
	`5322`	`+ * @param client The client's id.`
	`5323`	`+ * @param szPath The path of the sound with or without "play " as a suffix.`
	`5324`	`+ * @param addPlay Whether or not "play " should be append to the begining of szPath (default = true).`
	`5325`	`+ */`
	`5326`	`+stock void EmitSoundToClientNoPreCache(int client, const char[] szPath, bool addPlay = true)`
	`5327`	`+{`
	`5328`	`+ char szBuffer[256];`
	`5329`	`+ if(addPlay)`
	`5330`	`+ {`
	`5331`	`+ Format(szBuffer, sizeof szBuffer, "play %s", szPath);`
	`5332`	`+ }`
	`5333`	`+ else`
	`5334`	`+ {`
	`5335`	`+ strcopy(szBuffer, sizeof szBuffer, szPath);`
	`5336`	`+ }`
	`5337`	`+ ClientCommand(client, szBuffer);`
	`5338`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -594,7 +594,7 @@ public void EndTouch(int client, int action[3])`
`594`	`594`	`if (g_bNoClip[client] \|\| (!g_bNoClip[client] && (GetGameTime() - g_fLastTimeNoClipUsed[client]) < 3.0))`
`595`	`595`	`{`
`596`	`596`	`CPrintToChat(client, "%t", "SurfZones1", g_szChatPrefix);`
`597`		`- ClientCommand(client, "play buttons\\button10.wav");`
	`597`	`+ EmitSoundToClientNoPreCache(client, "play buttons\\button10.wav", false);`
`598`	`598`	`// fluffys`
`599`	`599`	`// ClientCommand(client, "sm_stuck");`
`600`	`600`	`}`