Interface AudioListenerComponent

A component that receives input from Audio Components that have Spatial Audio enabled. Calculates their positions relative to the scene object it is attached to,and properly mixes them.

interface AudioListenerComponent {
    enabled: boolean;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Component
- AudioListenerComponent

Index

Properties

enabled sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

`Readonly`sceneObject

sceneObject: SceneObject

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

destroy

destroy(): void
Destroys the component.

Returns void
Inherited from Component.destroy

getSceneObject

getSceneObject(): SceneObject
Returns the SceneObject the component is attached to.

Returns SceneObject
Inherited from Component.getSceneObject

getTransform

getTransform(): Transform
Returns the Transform this component is attached to.

Returns Transform
Inherited from Component.getTransform

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Component.getTypeName

isOfType

isOfType(type): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Component.isOfType

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
- other: ScriptObject
Returns boolean
Inherited from Component.isSame