Resource Sound
(NOTE) Decreases a positional sound's volume as the SoundEmitter gets further away from a SoundListener.
| Methods | Properties | Base Classes | Derived Classes |
|---|---|---|---|
| FalloffCurve | dataresource | ||
| FalloffCurveType | |||
| LowPassCutoffFreq | |||
| LowPassStartDistance | |||
| MinAttenuatedVolume | |||
| StartDistance | |||
| StopDistance | |||
| UseLowPassFilter |
Properties
FalloffCurve : samplecurve
The SampleCurve resource to use as the attenuation's falloff curve. It will be normalized and stretched to fit between the StartDistance and StopDistance values.
var FalloffCurve : SampleCurve
FalloffCurveType : FalloffCurveType
The type of curve used to reduce the sound's volume over distance. The default is a logarithmic curve which mimics the real world.
var FalloffCurveType : FalloffCurveType
LowPassCutoffFreq : real
The lowest cutoff frequency of the low pass filter, reached at the StopDistance. The cutoff frequency will be interpolated logarithmically from 15000.00 (a value with very little effect on the sound) to the LowPassCutoffFreq between the LowPassStartDistance and the StopDistance.
var LowPassCutoffFreq : Real
LowPassStartDistance : real
The distance at which the low pass filter begins to take effect.
var LowPassStartDistance : Real
MinAttenuatedVolume : real
The lowest volume that the attenuation will reach. If set above 0, the sound will continue to be heard at all distances.
var MinAttenuatedVolume : Real
StartDistance : real
The distance from a SoundListener at which the sound's volume begins attenuating. At shorter distances the volume will not be changed. Cannot be larger than the StopDistance.
var StartDistance : Real
StopDistance : real
The distance at which the attenuation reaches the minimum volume. No volume changes will happen past this distance. Cannot be smaller than the StartDistance.
var StopDistance : Real
UseLowPassFilter : boolean
If true, a low pass filter will be applied to the sound after reaching a specified distance, mimicking the way sound is muffled with distance in real life. The filter begins at the LowPassStartDistance and interpolates its cutoff frequency logarithmically until the StopDistance. The filter will not change past the StopDistance.
var UseLowPassFilter : Boolean