C4SoundSystem.h File Reference

#include "c4group/C4Group.h"
#include "platform/C4SoundModifiers.h"

Include dependency graph for C4SoundSystem.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	C4SoundSystem

Functions
C4SoundInstance *	StartSoundEffect (const char *szSndName, bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
C4SoundInstance *	StartSoundEffectAt (const char *szSndName, int32_t iX, int32_t iY, int32_t iVolume=100, int32_t iCustomFallofDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
C4SoundInstance *	GetSoundInstance (const char *szSndName, C4Object *pObj)
void	StopSoundEffect (const char *szSndName, C4Object *pObj)
void	SoundLevel (const char *szSndName, C4Object *pObj, int32_t iLevel)
void	SoundPan (const char *szSndName, C4Object *pObj, int32_t iPan)
void	SoundPitch (const char *szSndName, C4Object *pObj, int32_t iPitch)
void	SoundUpdate (C4SoundInstance *inst, int32_t iLevel, int32_t iPitch)

Variables
const int32_t	C4MaxSoundName =100
const int32_t	C4MaxSoundInstances =20
const int32_t	C4NearSoundRadius =50
const int32_t	C4AudibilityRadius =700
const int32_t	SoundUnloadTime =60
const int32_t	SoundMaxUnloadSize =100000

Function Documentation

GetSoundInstance()

C4SoundInstance* GetSoundInstance	(	const char *	szSndName,
		C4Object *	pObj
	)

Definition at line 283 of file C4SoundSystem.cpp.

{
    return Application.SoundSystem.FindInstance(szSndName, pObj);
}

References Application, C4SoundSystem::FindInstance(), and C4Application::SoundSystem.

Here is the call graph for this function:

SoundLevel()

void SoundLevel	(	const char *	szSndName,
		C4Object *	pObj,
		int32_t	iLevel
	)

Definition at line 296 of file C4SoundSystem.cpp.

{
    // Sound level zero? Stop
    if (!iLevel) { StopSoundEffect(szSndName, pObj); return; }
    // Find or create instance
    C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
    if (!pInst) pInst = StartSoundEffect(szSndName, true, iLevel, pObj);
    if (!pInst) return;
    // Set volume
    pInst->SetVolume(iLevel);
    pInst->Execute();
}

References Application, C4SoundInstance::Execute(), C4SoundSystem::FindInstance(), C4SoundInstance::SetVolume(), C4Application::SoundSystem, StartSoundEffect(), and StopSoundEffect().

Here is the call graph for this function:

SoundPan()

void SoundPan	(	const char *	szSndName,
		C4Object *	pObj,
		int32_t	iPan
	)

Definition at line 309 of file C4SoundSystem.cpp.

{
    // Find instance
    C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
    if (!pInst) return;
    // Set pan
    pInst->SetPan(iPan);
    pInst->Execute();
}

References Application, C4SoundInstance::Execute(), C4SoundSystem::FindInstance(), C4SoundInstance::SetPan(), and C4Application::SoundSystem.

Here is the call graph for this function:

SoundPitch()

void SoundPitch	(	const char *	szSndName,
		C4Object *	pObj,
		int32_t	iPitch
	)

Definition at line 319 of file C4SoundSystem.cpp.

{
    // Find instance
    C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
    if (!pInst) return;
    // Set pitch
    pInst->SetPitch(iPitch);
    pInst->Execute();
}

References Application, C4SoundInstance::Execute(), C4SoundSystem::FindInstance(), C4SoundInstance::SetPitch(), and C4Application::SoundSystem.

Here is the call graph for this function:

SoundUpdate()

void SoundUpdate	(	C4SoundInstance *	inst,
		int32_t	iLevel,
		int32_t	iPitch
	)

Definition at line 329 of file C4SoundSystem.cpp.

{
    // Set sound data
    pInst->SetVolume(iLevel);
    pInst->SetPitch(iPitch);
    // Ensure it's reflected in audio engine
    pInst->Execute();
}

References C4SoundInstance::Execute(), C4SoundInstance::SetPitch(), and C4SoundInstance::SetVolume().

Here is the call graph for this function:

StartSoundEffect()

C4SoundInstance* StartSoundEffect	(	const char *	szSndName,
		bool	fLoop = false,
		int32_t	iVolume = 100,
		C4Object *	pObj = nullptr,
		int32_t	iCustomFalloffDistance = 0,
		int32_t	iPitch = 0,
		C4SoundModifier *	modifier = nullptr
	)

Definition at line 263 of file C4SoundSystem.cpp.

{
    // Sound check
    if (!Config.Sound.RXSound) return nullptr;
    // Start new
    return Application.SoundSystem.NewEffect(szSndName, fLoop, iVolume, pObj, iCustomFalloffDistance, iPitch, modifier);
}

References Application, Config, C4SoundSystem::NewEffect(), C4ConfigSound::RXSound, C4Config::Sound, and C4Application::SoundSystem.

Referenced by C4ViewportList::CloseViewport(), C4ControlEMMoveObject::CreateObject(), C4ViewportList::CreateViewport(), C4Object::DirectComContents(), C4Player::DoWealth(), C4Player::Eliminate(), C4Object::ExecLife(), C4GUI::GUISound(), C4GameLobby::MainDlg::OnCountdownPacket(), C4GameLobby::MainDlg::OnError(), C4Object::Promote(), C4Game::QuickSave(), C4Object::SetAction(), C4Player::SetHostility(), SoundLevel(), StartSoundEffectAt(), and C4Player::Surrender().

Here is the call graph for this function:

Here is the caller graph for this function:

StartSoundEffectAt()

C4SoundInstance* StartSoundEffectAt	(	const char *	szSndName,
		int32_t	iX,
		int32_t	iY,
		int32_t	iVolume = 100,
		int32_t	iCustomFallofDistance = 0,
		int32_t	iPitch = 0,
		C4SoundModifier *	modifier = nullptr
	)

Definition at line 41 of file stub-handle.cpp.

{ return nullptr; }

References Config, C4ConfigSound::RXSound, C4SoundInstance::SetVolumeByPos(), C4Config::Sound, and StartSoundEffect().

Here is the call graph for this function:

StopSoundEffect()

void StopSoundEffect	(	const char *	szSndName,
		C4Object *	pObj
	)

Definition at line 288 of file C4SoundSystem.cpp.

{
    // Find instance
    C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
    if (!pInst) return;
    // Stop
    pInst->Stop();
}

References Application, C4SoundSystem::FindInstance(), C4Application::SoundSystem, and C4SoundInstance::Stop().

Referenced by C4Object::SetAction(), and SoundLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C4AudibilityRadius

const int32_t C4AudibilityRadius =700

Definition at line 30 of file C4SoundSystem.h.

Referenced by C4SoundInstance::Execute(), and C4ViewportList::GetAudibility().

C4MaxSoundInstances

const int32_t C4MaxSoundInstances =20

Definition at line 28 of file C4SoundSystem.h.

Referenced by C4SoundSystem::Init(), and C4SoundEffect::New().

C4MaxSoundName

const int32_t C4MaxSoundName =100

Definition at line 27 of file C4SoundSystem.h.

Referenced by C4SoundSystem::FindInstance(), C4SoundSystem::GetEffect(), and C4SoundEffect::Load().

C4NearSoundRadius

const int32_t C4NearSoundRadius =50

Definition at line 29 of file C4SoundSystem.h.

Referenced by C4SoundInstance::CheckStart().

SoundMaxUnloadSize

const int32_t SoundMaxUnloadSize =100000

Definition at line 32 of file C4SoundSystem.h.

SoundUnloadTime

const int32_t SoundUnloadTime =60

Definition at line 32 of file C4SoundSystem.h.