DistanceEffect
ClassAn audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.
- Available on all platforms
Index
Properties
Methods
Example
// @input Component.AudioComponent audio
var distanceEffect = script.audio.spatialAudio.distanceEffect;
distanceEffect.enabled = true;
distanceEffect.maxDistance = 200;
distanceEffect.minDistance = 50;
distanceEffect.type = Audio.DistanceCurveType.Linear;
Extends
Properties
enabled
enabled:
boolean
If enabled, the distance effect will be applied.
Since
Lens Scripting Version 147
Default Value
false
maxDistance
maxDistance:
number
If the distance is higher than this value, the sound cannot be heard at all.
Default Value
100
minDistance
minDistance:
number
If the distance is less than this value, the distance effect is not applied at all.
Default Value
0
type
type:
DistanceCurveType
Curve type that describes how volume attenuates with distance.
Default Value
Audio.DistanceCurveType.Logarithm
Methods
getTypeName()
staticgetTypeName():TypeName<DistanceEffect>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<DistanceEffect>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean