| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AudioListener2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AudioListener2D:
- AudioListener2D
- ===============
- **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Overrides the location sounds are heard from.
- Description
- -----------
- Once added to the scene tree and enabled using :ref:`make_current<class_AudioListener2D_method_make_current>`, this node will override the location sounds are heard from. Only one ``AudioListener2D`` can be current. Using :ref:`make_current<class_AudioListener2D_method_make_current>` will disable the previous ``AudioListener2D``.
- If there is no active ``AudioListener2D`` in the current :ref:`Viewport<class_Viewport>`, center of the screen will be used as a hearing point for the audio. ``AudioListener2D`` needs to be inside :ref:`SceneTree<class_SceneTree>` to function.
- Methods
- -------
- +-------------------------+--------------------------------------------------------------------------------+
- | void | :ref:`clear_current<class_AudioListener2D_method_clear_current>` **(** **)** |
- +-------------------------+--------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_current<class_AudioListener2D_method_is_current>` **(** **)** |const| |
- +-------------------------+--------------------------------------------------------------------------------+
- | void | :ref:`make_current<class_AudioListener2D_method_make_current>` **(** **)** |
- +-------------------------+--------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_AudioListener2D_method_clear_current:
- - void **clear_current** **(** **)**
- Disables the ``AudioListener2D``. If it's not set as current, this method will have no effect.
- ----
- .. _class_AudioListener2D_method_is_current:
- - :ref:`bool<class_bool>` **is_current** **(** **)** |const|
- Returns ``true`` if this ``AudioListener2D`` is currently active.
- ----
- .. _class_AudioListener2D_method_make_current:
- - 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 :ref:`SceneTree<class_SceneTree>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
