Interface SoundEmitterOptions

Used for configuring properties of a SoundEmitter game object

SoundEmitterOptions

interface SoundEmitterOptions {
    fallOffFunction?: ((distance) => number);
    listener: GameObject;
    loop?: boolean;
    maxDistance?: number;
    minDistance?: number;
    playbackRate?: number;
    source: string;
    startPlaying?: boolean;
    volume?: number;
}

Hierarchy (view full)

Properties

fallOffFunction? listener loop? maxDistance? minDistance? playbackRate? source startPlaying? volume?

Properties

Optional fallOffFunction

fallOffFunction?: ((distance) => number)

A function that takes the distance from the listener and returns the volume of the sound. Default is a linear fall off function

Type declaration

    • (distance): number

    • A function that takes the distance from the listener and returns the volume of the sound. Default is a linear fall off function

      Parameters

      • distance: number

      Returns number

listener

listener: GameObject

The game object that will listen to the sound- eg: the player. Distance from the source is calculated from this object

Optional loop

loop?: boolean

Set to true to loop the sound, default is false

Optional maxDistance

maxDistance?: number

The maximum distance the sound can be heard from (if outside this range, the volume of the sound will be 0)

Optional minDistance

minDistance?: number

The minimum distance the sound can be heard from (if inside this range, the volume of the sound will be 1)

Optional playbackRate

playbackRate?: number

The playback rate of the sound, default is 1

source

source: string

The source of the sound (eg: "sound.mp3")

Optional startPlaying

startPlaying?: boolean

Set to false to prevent the sound from playing when the scene starts (default is true)

Optional volume

volume?: number

The volume of the sound, default is 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc