Interface DistanceEffect

An audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.

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;
interface DistanceEffect {
    enabled: boolean;
    maxDistance: number;
    minDistance: number;
    type: DistanceCurveType;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

enabled maxDistance minDistance type

Methods

getTypeName isOfType isSame

Properties

enabled

enabled: boolean

If enabled, the distance effect will be applied.

maxDistance

maxDistance: number

If the distance is higher than this value, the sound cannot be heard at all.

minDistance

minDistance: number

If the distance is less than this value, the distance effect is not applied at all.

type

type: DistanceCurveType

Curve type that describes how volume attenuates with distance.

Methods

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods