Interface PositionEffect

Description

An Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component.

Example

// @input Component.AudioComponent audio
var spatialAudio = script.audio.spatialAudio;

var positionEffect = spatialAudio.positionEffect;
positionEffect.enabled = true;
interface PositionEffect {
    enabled: boolean;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled

Methods

getTypeName isOfType isSame

Properties

enabled

enabled: boolean

Description

If enabled, the position effect will be applied.

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc