ncSoundScape Class Reference

About this class

Shared-Entity: Sound System Scape/Reverb Controller.

QUAKED ncSoundScape (1 .5 0) (-8 -8 -8) (8 8 8)

OVERVIEW

Environmental soundscape and reverb controller.

KEYS

• "efx_file" : File to load EFX values from. See EFX Definition
• "density" : See SetDensity()
• "diffusion" : See SetDiffusion()
• "gain" : See SetGain()
• "gain_hf" : See SetGainHF()
• "gain_lf" : See SetGainLF()
• "decay_time" : See SetDecayTime()
• "decay_hf_ratio" : See SetDecayHFRatio()
• "decay_lf_ratio" : See SetDecayLFRatio()
• "reflection_gain" : See SetReflectionGain()
• "reflection_delay" : See SetReflectionDelay()
• "reflection_pan" : See SetReflectionPan()
• "late_reverb_gain" : See SetLateGain()
• "late_reverb_delay" : See SetLateDelay()
• "late_reverb_pan" : See SetLatePan()
• "echo_time" : See SetEchoTime()
• "echo_depth" : See SetEchoDepth()
• "modulation_time" : See SetModulationTime()
• "modulation_depth" : See SetModulationDepth()
• "air_absorbtion_hf" : See SetAirAbsorptionGainHF()
• "hf_reference" : See SetHFReference()
• "lf_reference" : See SetLFReference()
• "room_rolloff_factor" : See SetRoomRolloffFactor()
• "decay_limit" : See SetDecayHFLimit()
• "radius" : See SetRadius()

Inheritance diagram for ncSoundScape:

Public Member Functions
void	ncSoundScape (void)
nonvirtual void	SetDensity (float)
	Reverb Density, controls the effect of the reverb.
nonvirtual void	SetDiffusion (float)
	Reverb Diffusion, linear multiplier.
nonvirtual void	SetGain (float)
	Reverb Gain, linear gain control.
nonvirtual void	SetGainHF (float)
	Reverb Gain HF, linear gain control for high frequency sounds.
nonvirtual void	SetGainLF (float)
	Reverb Gain LF, linear gain control for low frequency sounds.
nonvirtual void	SetDecayTime (float)
	Decay Time, in seconds.
nonvirtual void	SetDecayHFRatio (float)
	Decay HF Ratio, linear multiplier.
nonvirtual void	SetDecayLFRatio (float)
	Decay LF Ratio, linear multiplier.
nonvirtual void	SetReflectionGain (float)
	Reflection Gain, linear gain control.
nonvirtual void	SetReflectionDelay (float)
	Reflection Delay, in seconds.
nonvirtual void	SetReflectionPan (vector)
	Reflection Pan.
nonvirtual void	SetLateGain (float)
	Late Reverb Gain, linear gain control.
nonvirtual void	SetLateDelay (float)
	Late Reverb Delay, in seconds.
nonvirtual void	SetLatePan (vector)
	Late Reverb Pan.
nonvirtual void	SetEchoTime (float)
	Echo Time, in seconds.
nonvirtual void	SetEchoDepth (float)
	Echo Depth, linear multiplier.
nonvirtual void	SetModulationTime (float)
	Modulation Time, in seconds.
nonvirtual void	SetModulationDepth (float)
	Modulation Depth, linear multiplier.
nonvirtual void	SetAirAbsorptionGainHF (float)
	Air Absorption Gain HF, linear gain per meter.
nonvirtual void	SetHFReference (float)
	HF Reference, in Hz.
nonvirtual void	SetLFReference (float)
	LF Reference, in Hz.
nonvirtual void	SetRoomRolloffFactor (float)
	Room Rolloff Factor, linear multiplier.
nonvirtual void	SetDecayHFLimit (int)
	Decay HF Limit, integer value.
nonvirtual void	SetRadius (float)
	Sets the radius of the soundscape.
nonvirtual float	GetDensity (void)
nonvirtual float	GetDiffusion (void)
nonvirtual float	GetGain (void)
nonvirtual float	GetGainHF (void)
nonvirtual float	GetGainLF (void)
nonvirtual float	GetDecayTime (void)
nonvirtual float	GetDecayHFRatio (void)
nonvirtual float	GetDecayLFRatio (void)
nonvirtual float	GetReflectionGain (void)
nonvirtual float	GetReflectionDelay (void)
nonvirtual vector	GetReflectionPan (void)
nonvirtual float	GetLateGain (void)
nonvirtual float	GetLateDelay (void)
nonvirtual vector	GetLatePan (void)
nonvirtual float	GetEchoTime (void)
nonvirtual float	GetEchoDepth (void)
nonvirtual float	GetModulationTime (void)
nonvirtual float	GetModulationDepth (void)
nonvirtual float	GetAirAbsorptionGainHF (void)
nonvirtual float	GetHFReference (void)
nonvirtual float	GetLFReference (void)
nonvirtual float	GetRoomRolloffFactor (void)
nonvirtual int	GetDecayHFLimit (void)
nonvirtual float	GetRadius (void)
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load.
virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message.
virtual void	EvaluateEntity (void)
	Run each tic after physics are run to determine if we need to send updates over the network.
virtual float	SendEntity (entity, float)
	Called by the engine whenever we need to send a client an update about this entity.
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle.
virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields.
nonvirtual bool	LoadFromEFX (string)
virtual void	DebugDraw (void)
virtual void	ReceiveEntity (float, float)
	Client: Handles network updates from the server for the associated entity.
nonvirtual void	SetupEFXReverb (reverbinfo_t *)

Constructor & Destructor Documentation

ncSoundScape()

void ncSoundScape::ncSoundScape

(

void

)

Member Function Documentation

DebugDraw()

void ncSoundScape::DebugDraw ( void )

virtual

Reimplemented from ncPointTrigger.

EvaluateEntity()

void ncSoundScape::EvaluateEntity ( void )

virtual

Run each tic after physics are run to determine if we need to send updates over the network.

Reimplemented from ncEntity.

GetAirAbsorptionGainHF()

float ncSoundScape::GetAirAbsorptionGainHF

(

void

)

GetDecayHFLimit()

int ncSoundScape::GetDecayHFLimit

(

void

)

GetDecayHFRatio()

float ncSoundScape::GetDecayHFRatio

(

void

)

GetDecayLFRatio()

float ncSoundScape::GetDecayLFRatio

(

void

)

GetDecayTime()

float ncSoundScape::GetDecayTime

(

void

)

GetDensity()

float ncSoundScape::GetDensity

(

void

)

GetDiffusion()

float ncSoundScape::GetDiffusion

(

void

)

GetEchoDepth()

float ncSoundScape::GetEchoDepth

(

void

)

GetEchoTime()

float ncSoundScape::GetEchoTime

(

void

)

GetGain()

float ncSoundScape::GetGain

(

void

)

GetGainHF()

float ncSoundScape::GetGainHF

(

void

)

GetGainLF()

float ncSoundScape::GetGainLF

(

void

)

GetHFReference()

float ncSoundScape::GetHFReference

(

void

)

GetLateDelay()

float ncSoundScape::GetLateDelay

(

void

)

GetLateGain()

float ncSoundScape::GetLateGain

(

void

)

GetLatePan()

vector ncSoundScape::GetLatePan

(

void

)

GetLFReference()

float ncSoundScape::GetLFReference

(

void

)

GetModulationDepth()

float ncSoundScape::GetModulationDepth

(

void

)

GetModulationTime()

float ncSoundScape::GetModulationTime

(

void

)

GetRadius()

float ncSoundScape::GetRadius

(

void

)

GetReflectionDelay()

float ncSoundScape::GetReflectionDelay

(

void

)

GetReflectionGain()

float ncSoundScape::GetReflectionGain

(

void

)

GetReflectionPan()

vector ncSoundScape::GetReflectionPan

(

void

)

GetRoomRolloffFactor()

float ncSoundScape::GetRoomRolloffFactor

(

void

)

Input()

void ncSoundScape::Input ( entity eAct, string strInput, string strData )

virtual

Called when we are being prompted by another object/function with an input message.

Reimplemented from ncEntity.

LoadFromEFX()

bool ncSoundScape::LoadFromEFX

(

string

efxFile

)

ReceiveEntity()

virtual void ncSoundScape::ReceiveEntity ( float flNew, float flChanged )

virtual

Client: Handles network updates from the server for the associated entity.

Reimplemented from ncEntity.

Restore()

void ncSoundScape::Restore ( string keyName, string setValue )

virtual

Similar to ncIO::SpawnKey() but for save-game fields.

Whatever you write into file handles within your ncIO::Save() method needs to be read back in here.

Reimplemented from ncEntity.

Save()

void ncSoundScape::Save ( float handle )

virtual

Handles saving a copy of this entity to a given filehandle.

Within you want to use the ncIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.

Reimplemented from ncEntity.

SendEntity()

float ncSoundScape::SendEntity ( entity , float  )

virtual

Called by the engine whenever we need to send a client an update about this entity.

Reimplemented from ncEntity.

SetAirAbsorptionGainHF()

void ncSoundScape::SetAirAbsorptionGainHF

(

float

newAirAbsorptionGainHF

)

Air Absorption Gain HF, linear gain per meter.

Values 0.892f to 1.0f. Default is 0.994f.

SetDecayHFLimit()

void ncSoundScape::SetDecayHFLimit

(

int

newDecayHFLimit

)

Decay HF Limit, integer value.

Values are 0i (false) and 1i (true). Default is 1i (true).

SetDecayHFRatio()

void ncSoundScape::SetDecayHFRatio

(

float

newDecayHFRatio

)

Decay HF Ratio, linear multiplier.

Values 0.1f to 20.0f. Default is 0.83f.

SetDecayLFRatio()

void ncSoundScape::SetDecayLFRatio

(

float

newDecayLFRatio

)

Decay LF Ratio, linear multiplier.

Values 0.1f to 20.0f. Default is 1.0f.

SetDecayTime()

void ncSoundScape::SetDecayTime

(

float

newDecayTime

)

Decay Time, in seconds.

Values 0.1f to 20.0f. Default is 1.49f.

SetDensity()

void ncSoundScape::SetDensity

(

float

newDensity

)

Reverb Density, controls the effect of the reverb.

Values 0.0f to 1.0f. Default is 1.0f.

SetDiffusion()

void ncSoundScape::SetDiffusion

(

float

newDiffusion

)

Reverb Diffusion, linear multiplier.

Values 0.0f to 1.0f. Default is 1.0f.

SetEchoDepth()

void ncSoundScape::SetEchoDepth

(

float

newEchoDepth

)

Echo Depth, linear multiplier.

Values 0.0f to 1.0f. Default is 0.0f.

SetEchoTime()

void ncSoundScape::SetEchoTime

(

float

newLateEchoTime

)

Echo Time, in seconds.

Values 0.075f to 0.25f. Default is 0.25f.

SetGain()

void ncSoundScape::SetGain

(

float

newGain

)

Reverb Gain, linear gain control.

Affects the volume of sound reflections and reverberation. Values 0.0f to 1.0f. Default is 0.32f.

SetGainHF()

void ncSoundScape::SetGainHF

(

float

newGainHF

)

Reverb Gain HF, linear gain control for high frequency sounds.

Values 0.0f to 1.0f. Default is 0.89f.

SetGainLF()

void ncSoundScape::SetGainLF

(

float

newGainLF

)

Reverb Gain LF, linear gain control for low frequency sounds.

Values 0.0f to 1.0f. Default is 0.0f.

SetHFReference()

void ncSoundScape::SetHFReference

(

float

newHFReference

)

HF Reference, in Hz.

Values 1000.0f to 20000.0f. Default is 5000.0f.

SetLateDelay()

void ncSoundScape::SetLateDelay

(

float

newLateDelay

)

Late Reverb Delay, in seconds.

values 0.0f to 0.1f. Default is 0.011f.

SetLateGain()

void ncSoundScape::SetLateGain

(

float

newLateGain

)

Late Reverb Gain, linear gain control.

Values 0.0f to 10.0f. Default is 1.26f.

SetLatePan()

void ncSoundScape::SetLatePan

(

vector

newLatePan

)

Late Reverb Pan.

X = Left/Right, Y = Up/Down, Z = Forward/Back. Values from -1.0f to 1.0 on each axis. Default is [0,0,0].

SetLFReference()

void ncSoundScape::SetLFReference

(

float

newLFReference

)

LF Reference, in Hz.

Values 20.0f to 1000.0f. Default is 250.0f.

SetModulationDepth()

void ncSoundScape::SetModulationDepth

(

float

newModulationDepth

)

Modulation Depth, linear multiplier.

Values 0.0f to 1.0f. Default is 0.0f.

SetModulationTime()

void ncSoundScape::SetModulationTime

(

float

newModulationTime

)

Modulation Time, in seconds.

Values 0.004f to 4.0f. Default is 0.25f.

SetRadius()

void ncSoundScape::SetRadius

(

float

newRadius

)

Sets the radius of the soundscape.

When a client is outside the radius the effects are nil.

SetReflectionDelay()

void ncSoundScape::SetReflectionDelay

(

float

newReflectionDelay

)

Reflection Delay, in seconds.

Values 0.0f to 0.3f. Default is 0.007f.

SetReflectionGain()

void ncSoundScape::SetReflectionGain

(

float

newReflectionGain

)

Reflection Gain, linear gain control.

Values 0.0f to 3.16f. Default is 0.05f.

SetReflectionPan()

void ncSoundScape::SetReflectionPan

(

vector

newReflectionPan

)

Reflection Pan.

X = Left/Right, Y = Up/Down, Z = Forward/Back. Values from -1.0f to 1.0 on each axis. Default is [0,0,0].

SetRoomRolloffFactor()

void ncSoundScape::SetRoomRolloffFactor

(

float

newRoomRolloffFactor

)

Room Rolloff Factor, linear multiplier.

Values 0.0f to 10.0f. Default is 0.0f.

SetupEFXReverb()

void ncSoundScape::SetupEFXReverb

(

reverbinfo_t *

info

)

SpawnKey()

void ncSoundScape::SpawnKey ( string keyName, string setValue )

virtual

This method handles entity key/value pairs on map load.

You can easily convert the strValue parameter using the ReadFloat etc. methods that are part of ncIO.

Reimplemented from ncEntity.

Reimplemented in env_sound.

---

The documentation for this class was generated from the following files:

• src/shared/audio/SoundScape.h
• src/shared/audio/SoundScape.qc