sound.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2024 Vera Visions LLC.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
.float maxspeed;
.float flags;
 
var bool autocvar_s_developer = false;
void
_SndLog(string functionName, string msg)
{
        if (autocvar_g_developerTimestamps)
                print(sprintf("^9%f ^xF50%s^7: %s\n", time, functionName, msg));
        else
                print(sprintf("^xF50%s^7: %s\n", functionName, msg));
}
 
#define SndLog(...) if (autocvar_s_developer) _SndLog(__FUNC__, sprintf(__VA_ARGS__))
 
void
_SndEntLog(string className, string functionName, float edictNum, string warnMessage)
{
        if (autocvar_g_developerTimestamps)
                print(sprintf("^9%f ^xF50%s (id: %d)^7: %s\n", time, functionName, edictNum, warnMessage));
        else
                print(sprintf("^xF50%s (id: %d)^7: %s\n", functionName, edictNum, warnMessage));
}
 
#define SndEntLog(...) if (autocvar_s_developer) _SndEntLog(classname, __FUNC__, num_for_edict(this), sprintf(__VA_ARGS__))
 
var hashtable g_hashsounds;
 
typedef enumflags
{
        SNDFL_LOOPING,  
        SNDFL_NODUPS,   
        SNDFL_GLOBAL,   
        SNDFL_NOREVERB, 
        SNDFL_OMNI,             
        SNDFL_PRIVATE,  
        SNDFL_STEP,             
        SNDFL_FOLLOW,   
        SNDFL_ALERTS    
} soundFlag_t;
 
typedef struct
{
        float dist_min; 
        float dist_max; 
        float offset;   
        float pitch_min; 
        float pitch_max; 
        float shakes; 
        float volume; 
        soundFlag_t flags; 
        int playc; 
        int sample_count; 
        string samples; 
        string name; 
        string distshader; 
        float pointparticle;
} snd_t;
 
typedef struct
{
        string m_strSnd;
        float m_flLength;
        float m_flPitch;
} sound_t;
 
snd_t *g_sounds;
int g_sounds_count; 
 
void Sound_Init(void);
void Sound_Shutdown(void);
int Sound_Precache(string sndDef);
void Sound_Play(entity targetEntity, int sndChannel, string sndDef);
void Sound_PlayAt(vector worldPos, string sndDef);
 
#ifdef CLIENT
void Sound_PlayLocal(string shader);
void Sound_Update(entity targetEntity, int sndChannel, int sndSample, float desiredVolume);
 
int Sound_GetID(string sndDef);
#else
void Sound_Speak(entity targetEntity, string sentencesEntry);
#endif
 
void Sound_Stop(entity target, int chan);
 
void Sound_DebugList();