OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4SoundSystem.h File Reference
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

C4SoundInstanceStartSoundEffect (const char *szSndName, bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
 
C4SoundInstanceStartSoundEffectAt (const char *szSndName, int32_t iX, int32_t iY, int32_t iVolume=100, int32_t iCustomFallofDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
 
C4SoundInstanceGetSoundInstance (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

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

Definition at line 283 of file C4SoundSystem.cpp.

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

284 {
285  return Application.SoundSystem.FindInstance(szSndName, pObj);
286 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
C4SoundInstance * FindInstance(const char *szSound, C4Object *pObj)
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

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

Definition at line 296 of file C4SoundSystem.cpp.

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

297 {
298  // Sound level zero? Stop
299  if (!iLevel) { StopSoundEffect(szSndName, pObj); return; }
300  // Find or create instance
301  C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
302  if (!pInst) pInst = StartSoundEffect(szSndName, true, iLevel, pObj);
303  if (!pInst) return;
304  // Set volume
305  pInst->SetVolume(iLevel);
306  pInst->Execute();
307 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
void StopSoundEffect(const char *szSndName, C4Object *pObj)
C4SoundInstance * StartSoundEffect(const char *szSndName, bool fLoop, int32_t iVolume, C4Object *pObj, int32_t iCustomFalloffDistance, int32_t iPitch, C4SoundModifier *modifier)
void SetVolume(int32_t inVolume)
C4SoundInstance * FindInstance(const char *szSound, C4Object *pObj)
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

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

Definition at line 309 of file C4SoundSystem.cpp.

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

310 {
311  // Find instance
312  C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
313  if (!pInst) return;
314  // Set pan
315  pInst->SetPan(iPan);
316  pInst->Execute();
317 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
void SetPan(int32_t inPan)
C4SoundInstance * FindInstance(const char *szSound, C4Object *pObj)
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

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

Definition at line 319 of file C4SoundSystem.cpp.

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

320 {
321  // Find instance
322  C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
323  if (!pInst) return;
324  // Set pitch
325  pInst->SetPitch(iPitch);
326  pInst->Execute();
327 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
void SetPitch(int32_t inPitch)
C4SoundInstance * FindInstance(const char *szSound, C4Object *pObj)
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

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

Definition at line 329 of file C4SoundSystem.cpp.

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

330 {
331  // Set sound data
332  pInst->SetVolume(iLevel);
333  pInst->SetPitch(iPitch);
334  // Ensure it's reflected in audio engine
335  pInst->Execute();
336 }

Here is the call graph for this function:

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.

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().

264 {
265  // Sound check
266  if (!Config.Sound.RXSound) return nullptr;
267  // Start new
268  return Application.SoundSystem.NewEffect(szSndName, fLoop, iVolume, pObj, iCustomFalloffDistance, iPitch, modifier);
269 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
C4Config Config
Definition: C4Config.cpp:833
int32_t RXSound
Definition: C4Config.h:126
C4SoundInstance * NewEffect(const char *szSound, bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
C4ConfigSound Sound
Definition: C4Config.h:254
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

Here is the caller graph for this function:

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.

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

Referenced by C4MaterialMap::mrfCorrode(), and C4MaterialMap::mrfPoof().

41 { return nullptr; }

Here is the call graph for this function:

Here is the caller graph for this function:

void StopSoundEffect ( const char *  szSndName,
C4Object pObj 
)

Definition at line 288 of file C4SoundSystem.cpp.

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

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

289 {
290  // Find instance
291  C4SoundInstance *pInst = Application.SoundSystem.FindInstance(szSndName, pObj);
292  if (!pInst) return;
293  // Stop
294  pInst->Stop();
295 }
C4SoundSystem SoundSystem
Definition: C4Application.h:42
C4SoundInstance * FindInstance(const char *szSound, C4Object *pObj)
C4Application Application
Definition: C4Globals.cpp:44

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

const int32_t C4AudibilityRadius =700

Definition at line 30 of file C4SoundSystem.h.

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

const int32_t C4MaxSoundInstances =20

Definition at line 28 of file C4SoundSystem.h.

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

const int32_t C4MaxSoundName =100
const int32_t C4NearSoundRadius =50

Definition at line 29 of file C4SoundSystem.h.

Referenced by C4SoundInstance::CheckStart().

const int32_t SoundMaxUnloadSize =100000

Definition at line 32 of file C4SoundSystem.h.

const int32_t SoundUnloadTime =60

Definition at line 32 of file C4SoundSystem.h.