Removed debug test commands from previous commit, added ambientsounds module, removed old, and removed some unused translations phrases.

src/zr/soundeffects/ambientsounds.inc

@@ -0,0 +1,214 @@
+/*
+ * ============================================================================
+ *
+ *   Zombie:Reloaded
+ *
+ *   File:        ambientsounds.inc
+ *   Description: Plays ambient sounds to clients.
+ *
+ * ============================================================================
+ */
+
+/**
+ * Global variable that tells if ambient sound cvar data was loaded successfully.
+ */ 
+new bool:g_bAmbientSounds;
+
+/**
+ * Global variable to store ambient sounds timer handle.
+ */
+new Handle:tAmbientSounds = INVALID_HANDLE;
+
+/**
+ * Array for flagging client to play sound.
+ */
+new bool:bAmbientSoundsIsPlaying[MAXPLAYERS + 1]; 
+
+/**
+ * Load ambient sound data.
+ */
+AmbientSoundsLoad()
+{
+    // Validate cvars.
+    g_bAmbientSounds = AmbientSoundsValidateConfig();
+}
+
+/**
+ * Client is joining the server.
+ * 
+ * @param client    The client index.
+ */
+AmbientSoundsClientInit(client)
+{
+    // Reset flag to play sound on client.
+    bAmbientSoundsIsPlaying[client] = false;
+}
+
+/**
+ * Validate ambient sounds cvars.
+ */
+bool:AmbientSoundsValidateConfig()
+{
+    // If ambience is disabled, then stop.
+    new bool:ambience = GetConVarBool(gCvars[CVAR_AMBIENTSOUNDS]);
+    if (!ambience)
+    {
+        return false;
+    }
+    
+    // If logging is disabled for ambient sounds, then stop.
+    if (!LogFlagCheck(LOG_CORE_EVENTS, LOG_MODULE_AMBIENTSOUNDS))
+    {
+        return false;
+    }
+    
+    // Get ambient sound file.
+    decl String:sound[SOUND_MAX_PATH];
+    GetConVarString(gCvars[CVAR_AMBIENTSOUNDS_FILE], sound, sizeof(sound));
+    Format(sound, sizeof(sound), "sound/%s", sound);
+    
+    // If file doesn't exist, then log error and stop.
+    if (!FileExists(sound, true))
+    {
+        // Log invalid sound file error.
+        ZR_LogMessageFormatted(-1, "Ambient Sounds", "Config Validation", "Invalid sound file specified in zr_ambientsounds_file.", LOG_FORMAT_TYPE_ERROR);
+        return false;
+    }
+    
+    // If volume is muted or invalid, then log error and stop.
+    new Float:ambientvolume = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_VOLUME]);
+    if (ambientvolume <= 0.0)
+    {
+        // Log invalid ambient sound volume error.
+        ZR_LogMessageFormatted(-1, "Ambient Sounds", "Config Validation", "Ambient sound is either muted or invalid.", LOG_FORMAT_TYPE_ERROR);
+        return false;
+    }
+    
+    // If length is invalid, then log error and stop.
+    new Float:ambientlength = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_LENGTH]);
+    if (ambientlength <= 0.0)
+    {
+        // Log invalid ambient sound length error.
+        ZR_LogMessageFormatted(-1, "Ambient Sounds", "Config Validation", "Ambient sound length is invalid.", LOG_FORMAT_TYPE_ERROR);
+        return false;
+    }
+    
+    // Add sound file to downloads table.
+    AddFileToDownloadsTable(sound);
+    
+    return true;
+}
+
+/**
+ * Map is starting.
+ */ 
+AmbientSoundsOnMapStart()
+{
+    // Reset timer handle.
+    tAmbientSounds = INVALID_HANDLE;
+}
+
+/**
+ * The round is starting.
+ */
+AmbientSoundsOnRoundStart()
+{
+    // Restart ambient sound for all clients.
+    AmbientSoundsRestart();
+}
+
+/**
+ * Client is spawning into the game.
+ * 
+ * @param client    The client index.
+ */
+AmbientSoundsOnClientSpawn(client)
+{
+    // If ambience is disabled, then stop.
+    if (!g_bAmbientSounds)
+    {
+        return;
+    }
+    
+    // If flag is enabled, then stop.
+    if (bAmbientSoundsIsPlaying[client])
+    {
+        return;
+    }
+    
+    // Get ambient sound file.
+    decl String:sound[SOUND_MAX_PATH];
+    GetConVarString(gCvars[CVAR_AMBIENTSOUNDS_FILE], sound, sizeof(sound));
+    
+    // Get ambient sound volume.
+    new Float:ambientvolume = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_VOLUME]);
+    
+    // Emit ambient sound.
+    SEffectsEmitAmbientSound(sound, ambientvolume, client);
+}
+
+/**
+ * Restart ambient sound for all clients.
+ */
+AmbientSoundsRestart()
+{
+    // If timer is running, kill it.
+    if (tAmbientSounds != INVALID_HANDLE)
+    {
+        KillTimer(tAmbientSounds);
+    }
+    
+    // If ambience is disabled, then stop.
+    if (!g_bAmbientSounds)
+    {
+        return;
+    }
+    
+    // x = client index
+    for (new x = 1; x <= MaxClients; x++)
+    {
+        // If client isn't in-game, then stop.
+        if (!IsClientInGame(x))
+        {
+            continue;
+        }
+        
+        bAmbientSoundsIsPlaying[x] = false;
+    }
+    
+    // Get ambient sound length.
+    new Float:ambientlength = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_LENGTH]);
+    
+    // Start ambient sounds timer.
+    tAmbientSounds = CreateTimer(ambientlength, AmbientSoundsTimer, _, TIMER_FLAG_NO_MAPCHANGE);
+}
+
+/**
+ * Timer callback, Replays ambient sound on all clients.
+ * 
+ * @param timer     The timer handle.  
+*/
+public Action:AmbientSoundsTimer(Handle:timer)
+{
+    // If ambience is disabled, then stop.
+    if (!g_bAmbientSounds)
+    {
+        return;
+    }
+    
+    // Get ambient sound file.
+    decl String:sound[SOUND_MAX_PATH];
+    GetConVarString(gCvars[CVAR_AMBIENTSOUNDS_FILE], sound, sizeof(sound));
+    
+    // Get ambient sound volume.
+    new Float:ambientvolume = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_VOLUME]);
+    
+    // Emit ambient sound.
+    SEffectsEmitAmbientSound(sound, ambientvolume);
+    
+    // Get ambient sound length.
+    new Float:ambientlength = GetConVarFloat(gCvars[CVAR_AMBIENTSOUNDS_LENGTH]);
+    
+    // Start new timer with sound length as delay.
+    tAmbientSounds = CreateTimer(ambientlength, AmbientSoundsTimer, _, TIMER_FLAG_NO_MAPCHANGE);
+}