Slippers Engine
 
Loading...
Searching...
No Matches
OccludableSnd Class Reference

Responsible for Occlusion Sound functions. More...

#include <OccludableSnd.h>

Public Member Functions

virtual void SubmitRegistration ()
 Called when wanting to make a sound be blocked by objects.
 
virtual void SubmitDeregistration ()
 Called when no longer wanting to make a sound be blocked by objects.
 
- Public Member Functions inherited from SoundSourceBase
virtual bool GetLooping ()
 Returns if sound is looping.
 
virtual void SetLooping (bool l)
 Sets if sound is looping.
 
virtual float GetPitch ()
 Returns sound's pitch.
 
virtual void SetPitch (float p)
 Sets sound's pitch.
 
virtual float GetGain ()=0
 Returns sound's gain.
 
virtual void SetGain (float g)=0
 Sets sound's gain.
 
virtual float GetOffset ()
 Returns sound's offset.
 
virtual void SetOffset (float o)
 Sets sound's offset.
 
virtual PlayState GetPlayState ()
 Returns sound's PlayState.
 
virtual void SetSound (SoundManager::Sound s)=0
 Sets sound to be played.
 
virtual void Play ()
 Plays a sound starting at it's offset.
 
virtual void PlayStart ()
 Plays a sound starting at the beginning.
 
virtual void Pause ()
 Pauses a sound.
 
virtual void Stop ()
 Fully Stops a sound.
 

Additional Inherited Members

- Public Types inherited from SoundSourceBase
enum class  PlayState { PLAYING , PAUSED , STOPPED }
 Potential States a source can be in. More...
 

Detailed Description

Responsible for Occlusion Sound functions.

Check OccludableObj to make Objects blockable. By default the Terrain is blockable if Terrain material is assigned to 1 then does nothing.

Member Function Documentation

◆ SubmitDeregistration()

void OccludableSnd::SubmitDeregistration ( )
virtual

Called when no longer wanting to make a sound be blocked by objects.

Example:

sound->OccludableSnd::SubmitDeregistration();

◆ SubmitRegistration()

void OccludableSnd::SubmitRegistration ( )
virtual

Called when wanting to make a sound be blocked by objects.

Warning
Only SoundSourceWorld can be occludable.

Example:

sound->OccludableSnd::SubmitRegistration();