Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

AudioListener2D

Inherits: Node2D < CanvasItem < Node < Object

Overrides the location sounds are heard from.

Description

Once added to the scene tree and enabled using make_current, this node will override the location sounds are heard from. Only one AudioListener2D can be current. Using make_current will disable the previous AudioListener2D.

If there is no active AudioListener2D in the current Viewport, center of the screen will be used as a hearing point for the audio. AudioListener2D needs to be inside SceneTree to function.

Methods

void	clear_current ( )
bool	is_current ( ) const
void	make_current ( )

---

Method Descriptions

void clear_current ( )

Disables the AudioListener2D. If it's not set as current, this method will have no effect.

---

bool is_current ( ) const

Returns true if this AudioListener2D is currently active.

---

void make_current ( )

Makes the AudioListener2D active, setting it as the hearing point for the sounds. If there is already another active AudioListener2D, it will be disabled.

This method will have no effect if the AudioListener2D is not added to SceneTree.