From 514f954797d7485842c3d5c80c9de124110d6fa9 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 22 Jun 2024 03:29:23 +0000 Subject: [PATCH] classref: Sync with current master branch (8a6c1e8) --- classes/class_@gdscript.rst | 2 +- classes/class_audiosample.rst | 33 +++++++ classes/class_audiosampleplayback.rst | 33 +++++++ classes/class_audioserver.rst | 90 +++++++++++++++++ classes/class_audiostream.rst | 46 +++++++++ classes/class_audiostreamplayback.rst | 74 ++++++++++---- .../class_audiostreamplaybackpolyphonic.rst | 26 ++--- classes/class_audiostreamplayer.rst | 21 ++++ classes/class_audiostreamplayer2d.rst | 71 +++++++++----- classes/class_audiostreamplayer3d.rst | 21 ++++ classes/class_color.rst | 8 +- classes/class_csgshape3d.rst | 2 +- classes/class_editorexportplatformios.rst | 14 +++ classes/class_editorscript.rst | 6 +- classes/class_lightmapprobe.rst | 4 +- classes/class_node3d.rst | 2 +- classes/class_object.rst | 2 + classes/class_occluderinstance3d.rst | 2 +- classes/class_os.rst | 30 ++++++ classes/class_projectsettings.rst | 44 ++++++++- classes/class_refcounted.rst | 2 +- classes/class_resourceimporterimagefont.rst | 4 +- classes/class_rid.rst | 2 + classes/class_spriteframes.rst | 4 +- classes/class_tlsoptions.rst | 98 +++++++++++++++++-- classes/class_vector2.rst | 2 +- classes/class_vector3.rst | 2 +- classes/class_visualinstance3d.rst | 2 +- classes/index.rst | 2 + 29 files changed, 559 insertions(+), 90 deletions(-) create mode 100644 classes/class_audiosample.rst create mode 100644 classes/class_audiosampleplayback.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 32f3134da71..637da62db00 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -158,7 +158,7 @@ Mark the following property as exported (editable in the Inspector dock and save @export var image_array: Array[Image] @export var node_array: Array[Node] -\ **Note:** Custom resources and nodes must be registered as global classes using ``class_name``. +\ **Note:** Custom resources and nodes should be registered as global classes using ``class_name``, since the Inspector currently only supports global classes. Otherwise, a less specific type will be exported instead. \ **Note:** Node export is only supported in :ref:`Node`-derived classes and has a number of other limitations. diff --git a/classes/class_audiosample.rst b/classes/class_audiosample.rst new file mode 100644 index 00000000000..e01dc39c481 --- /dev/null +++ b/classes/class_audiosample.rst @@ -0,0 +1,33 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioSample.xml. + +.. _class_AudioSample: + +AudioSample +=========== + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Base class for audio samples. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Base class for audio samples. + +.. |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.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiosampleplayback.rst b/classes/class_audiosampleplayback.rst new file mode 100644 index 00000000000..864a87e06c4 --- /dev/null +++ b/classes/class_audiosampleplayback.rst @@ -0,0 +1,33 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioSamplePlayback.xml. + +.. _class_AudioSamplePlayback: + +AudioSamplePlayback +=================== + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Meta class for playing back audio samples. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Meta class for playing back audio samples. + +.. |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.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 49137077052..5a10f28eec9 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -109,10 +109,14 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_bus_solo`\ (\ bus_idx\: :ref:`int`\ ) |const| | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_stream_registered_as_sample`\ (\ stream\: :ref:`AudioStream`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lock`\ (\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`move_bus`\ (\ index\: :ref:`int`, to_index\: :ref:`int`\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_stream_as_sample`\ (\ stream\: :ref:`AudioStream`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_bus`\ (\ index\: :ref:`int`\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_bus_effect`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) | @@ -216,6 +220,60 @@ A 5.1 channel surround setup was detected. A 7.1 channel surround setup was detected. +.. rst-class:: classref-item-separator + +---- + +.. _enum_AudioServer_PlaybackType: + +.. rst-class:: classref-enumeration + +enum **PlaybackType**: :ref:`🔗` + +.. _class_AudioServer_constant_PLAYBACK_TYPE_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`PlaybackType` **PLAYBACK_TYPE_DEFAULT** = ``0`` + +**Experimental:** This constant may be changed or removed in future versions. + +The playback will be considered of the type declared at :ref:`ProjectSettings.audio/general/default_playback_type`. + +.. _class_AudioServer_constant_PLAYBACK_TYPE_STREAM: + +.. rst-class:: classref-enumeration-constant + +:ref:`PlaybackType` **PLAYBACK_TYPE_STREAM** = ``1`` + +**Experimental:** This constant may be changed or removed in future versions. + +Force the playback to be considered as a stream. + +.. _class_AudioServer_constant_PLAYBACK_TYPE_SAMPLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`PlaybackType` **PLAYBACK_TYPE_SAMPLE** = ``2`` + +**Experimental:** This constant may be changed or removed in future versions. + +Force the playback to be considered as a sample. This can provide lower latency and more stable playback (with less risk of audio crackling), at the cost of having less flexibility. + +\ **Note:** Only currently supported on the web platform. + +\ **Note:** :ref:`AudioEffect`\ s are not supported when playback is considered as a sample. + +.. _class_AudioServer_constant_PLAYBACK_TYPE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`PlaybackType` **PLAYBACK_TYPE_MAX** = ``3`` + +**Experimental:** This constant may be changed or removed in future versions. + +Represents the size of the :ref:`PlaybackType` enum. + .. rst-class:: classref-section-separator ---- @@ -592,6 +650,22 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode. ---- +.. _class_AudioServer_method_is_stream_registered_as_sample: + +.. rst-class:: classref-method + +:ref:`bool` **is_stream_registered_as_sample**\ (\ stream\: :ref:`AudioStream`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +If ``true``, the stream is registered as a sample. The engine will not have to register it before playing the sample. + +If ``false``, the stream will have to be registered before playing it. To prevent lag spikes, register the stream as sample with :ref:`register_stream_as_sample`. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioServer_method_lock: .. rst-class:: classref-method @@ -618,6 +692,22 @@ Moves the bus from index ``index`` to index ``to_index``. ---- +.. _class_AudioServer_method_register_stream_as_sample: + +.. rst-class:: classref-method + +|void| **register_stream_as_sample**\ (\ stream\: :ref:`AudioStream`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Forces the registration of a stream as a sample. + +\ **Note:** Lag spikes may occur when calling this method, especially on single-threaded builds. It is suggested to call this method while loading assets, where the lag spike could be masked, instead of registering the sample right before it needs to be played. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioServer_method_remove_bus: .. rst-class:: classref-method diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index c43c231d081..00ef203ba4d 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -59,10 +59,16 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_monophonic`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_be_sampled`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioSample` | :ref:`generate_sample`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_length`\ (\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStreamPlayback` | :ref:`instantiate_playback`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_meta_stream`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_monophonic`\ (\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ @@ -180,6 +186,34 @@ Override this method to customize the returned value of :ref:`is_monophonic` **can_be_sampled**\ (\ ) |const| :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns if the current **AudioStream** can be used as a sample. Only static streams can be sampled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStream_method_generate_sample: + +.. rst-class:: classref-method + +:ref:`AudioSample` **generate_sample**\ (\ ) |const| :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Generates an :ref:`AudioSample` based on the current stream. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStream_method_get_length: .. rst-class:: classref-method @@ -204,6 +238,18 @@ Returns a newly created :ref:`AudioStreamPlayback` in ---- +.. _class_AudioStream_method_is_meta_stream: + +.. rst-class:: classref-method + +:ref:`bool` **is_meta_stream**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if the stream is a collection of other streams, ``false`` otherwise. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStream_method_is_monophonic: .. rst-class:: classref-method diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 8f404986464..76f12f3987b 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -38,27 +38,31 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_stop`\ (\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stop`\ (\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioSamplePlayback` | :ref:`get_sample_playback`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_playback`\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -187,6 +191,34 @@ Override this method to customize what happens when the playback is stopped, suc Overridable method. Called whenever the audio stream is mixed if the playback is active and :ref:`AudioServer.set_enable_tagging_used_audio_streams` has been set to ``true``. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview. +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlayback_method_get_sample_playback: + +.. rst-class:: classref-method + +:ref:`AudioSamplePlayback` **get_sample_playback**\ (\ ) |const| :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns the :ref:`AudioSamplePlayback` associated with this **AudioStreamPlayback** for playing back the audio sample of this stream. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlayback_method_set_sample_playback: + +.. rst-class:: classref-method + +|void| **set_sample_playback**\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Associates :ref:`AudioSamplePlayback` to this **AudioStreamPlayback** for playing back the audio sample of this stream. + .. |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.)` diff --git a/classes/class_audiostreamplaybackpolyphonic.rst b/classes/class_audiostreamplaybackpolyphonic.rst index 9321f96422b..c6d5c216ea8 100644 --- a/classes/class_audiostreamplaybackpolyphonic.rst +++ b/classes/class_audiostreamplaybackpolyphonic.rst @@ -29,17 +29,17 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_stream_playing`\ (\ stream\: :ref:`int`\ ) |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`play_stream`\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_stream_pitch_scale`\ (\ stream\: :ref:`int`, pitch_scale\: :ref:`float`\ ) | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_stream_volume`\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`stop_stream`\ (\ stream\: :ref:`int`\ ) | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_stream_playing`\ (\ stream\: :ref:`int`\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`play_stream`\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0, playback_type\: :ref:`PlaybackType` = 0, bus\: :ref:`StringName` = &"Master"\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream_pitch_scale`\ (\ stream\: :ref:`int`, pitch_scale\: :ref:`float`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream_volume`\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop_stream`\ (\ stream\: :ref:`int`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,9 +83,9 @@ Return true whether the stream associated with an integer ID is still playing. C .. rst-class:: classref-method -:ref:`int` **play_stream**\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) :ref:`🔗` +:ref:`int` **play_stream**\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0, playback_type\: :ref:`PlaybackType` = 0, bus\: :ref:`StringName` = &"Master"\ ) :ref:`🔗` -Play an :ref:`AudioStream` at a given offset, volume and pitch scale. Playback starts immediately. +Play an :ref:`AudioStream` at a given offset, volume, pitch scale, playback type, and bus. Playback starts immediately. The return value is a unique integer ID that is associated to this playback stream and which can be used to control it. diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index a91e4b7e571..9f709e104b4 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -64,6 +64,8 @@ Properties +----------------------------------------------------+----------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`pitch_scale` | ``1.0`` | +----------------------------------------------------+----------------------------------------------------------------------+---------------+ + | :ref:`PlaybackType` | :ref:`playback_type` | ``0`` | + +----------------------------------------------------+----------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`playing` | ``false`` | +----------------------------------------------------+----------------------------------------------------------------------+---------------+ | :ref:`AudioStream` | :ref:`stream` | | @@ -247,6 +249,25 @@ The audio's pitch and tempo, as a multiplier of the :ref:`stream` **playback_type** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_playback_type**\ (\ value\: :ref:`PlaybackType`\ ) +- :ref:`PlaybackType` **get_playback_type**\ (\ ) + +**Experimental:** This property may be changed or removed in future versions. + +The playback type of the stream player. If set other than to the default value, it will force that playback type. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStreamPlayer_property_playing: .. rst-class:: classref-property diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index c2cd8a42dfb..ac52ce133d0 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -45,31 +45,33 @@ Properties .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`int` | :ref:`area_mask` | ``1`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`attenuation` | ``1.0`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`bool` | :ref:`autoplay` | ``false`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`StringName` | :ref:`bus` | ``&"Master"`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`max_distance` | ``2000.0`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`int` | :ref:`max_polyphony` | ``1`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`panning_strength` | ``1.0`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`pitch_scale` | ``1.0`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`bool` | :ref:`playing` | ``false`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`AudioStream` | :ref:`stream` | | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`bool` | :ref:`stream_paused` | ``false`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`volume_db` | ``0.0`` | - +---------------------------------------+------------------------------------------------------------------------------+---------------+ + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`area_mask` | ``1`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`attenuation` | ``1.0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`autoplay` | ``false`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`StringName` | :ref:`bus` | ``&"Master"`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`max_distance` | ``2000.0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`max_polyphony` | ``1`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`panning_strength` | ``1.0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`pitch_scale` | ``1.0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`PlaybackType` | :ref:`playback_type` | ``0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`playing` | ``false`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`AudioStream` | :ref:`stream` | | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`stream_paused` | ``false`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`volume_db` | ``0.0`` | + +----------------------------------------------------+------------------------------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group @@ -257,6 +259,25 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp ---- +.. _class_AudioStreamPlayer2D_property_playback_type: + +.. rst-class:: classref-property + +:ref:`PlaybackType` **playback_type** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_playback_type**\ (\ value\: :ref:`PlaybackType`\ ) +- :ref:`PlaybackType` **get_playback_type**\ (\ ) + +**Experimental:** This property may be changed or removed in future versions. + +The playback type of the stream player. If set other than to the default value, it will force that playback type. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStreamPlayer2D_property_playing: .. rst-class:: classref-property diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index d9bdd501b02..1160b7cd272 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -76,6 +76,8 @@ Properties +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`pitch_scale` | ``1.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`PlaybackType` | :ref:`playback_type` | ``0`` | + +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`playing` | ``false`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`AudioStream` | :ref:`stream` | | @@ -473,6 +475,25 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp ---- +.. _class_AudioStreamPlayer3D_property_playback_type: + +.. rst-class:: classref-property + +:ref:`PlaybackType` **playback_type** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_playback_type**\ (\ value\: :ref:`PlaybackType`\ ) +- :ref:`PlaybackType` **get_playback_type**\ (\ ) + +**Experimental:** This property may be changed or removed in future versions. + +The playback type of the stream player. If set other than to the default value, it will force that playback type. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStreamPlayer3D_property_playing: .. rst-class:: classref-property diff --git a/classes/class_color.rst b/classes/class_color.rst index b9b83e07097..f91df07a16d 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -1795,7 +1795,7 @@ Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclus :ref:`Color` **hex**\ (\ hex\: :ref:`int`\ ) |static| :ref:`🔗` -Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel). +Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel). This method is the inverse of :ref:`to_rgba32`. In GDScript and C#, the :ref:`int` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRGGBBAA"``). @@ -1826,7 +1826,7 @@ In GDScript and C#, the :ref:`int` is best visualized with hexadecima :ref:`Color` **hex64**\ (\ hex\: :ref:`int`\ ) |static| :ref:`🔗` -Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel). +Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel). This method is the inverse of :ref:`to_rgba64`. In GDScript and C#, the :ref:`int` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRRRGGGGBBBBAAAA"``). @@ -2174,7 +2174,7 @@ Setting ``with_alpha`` to ``false``, excludes alpha from the hexadecimal string, :ref:`int` **to_rgba32**\ (\ ) |const| :ref:`🔗` -Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. +Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. This method is the inverse of :ref:`hex`. .. tabs:: @@ -2201,7 +2201,7 @@ Returns the color converted to a 32-bit integer in RGBA format (each component i :ref:`int` **to_rgba64**\ (\ ) |const| :ref:`🔗` -Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. +Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. This method is the inverse of :ref:`hex64`. .. tabs:: diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 428dd5dca83..315f161d6af 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -226,7 +226,7 @@ The operation that is performed on this shape. This is ignored for the first CSG - |void| **set_snap**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_snap**\ (\ ) -Snap makes the mesh vertices snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. +Snap makes the mesh vertices snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. The top-level CSG shape's snap value is used for the entire CSG tree. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 4f7df4bd8e0..52e39a1acc6 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -50,6 +50,8 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/export_project_only` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/generate_simulator_library_if_missing` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/icon_interpolation` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/min_ios_version` | @@ -547,6 +549,18 @@ If ``true``, exports iOS project files without building an XCArchive or ``.ipa`` ---- +.. _class_EditorExportPlatformIOS_property_application/generate_simulator_library_if_missing: + +.. rst-class:: classref-property + +:ref:`bool` **application/generate_simulator_library_if_missing** :ref:`🔗` + +If ``true``, and ARM64 simulator library is missing from the export template, it is automatically generated from ARM64 device library. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_application/icon_interpolation: .. rst-class:: classref-property diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 676d36590a1..81769525bd9 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -100,9 +100,7 @@ This method is executed by the Editor when **File > Run** is used. |void| **add_root_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` -Adds ``node`` as a child of the root node in the editor context. - -\ **Warning:** The implementation of this method is currently disabled. +Makes ``node`` root of the currently opened scene. Only works if the scene is empty. If the ``node`` is a scene instance, an inheriting scene will be created. .. rst-class:: classref-item-separator @@ -128,7 +126,7 @@ Returns the :ref:`EditorInterface` singleton instance. :ref:`Node` **get_scene**\ (\ ) |const| :ref:`🔗` -Returns the Editor's currently active scene. +Returns the edited (current) scene's root :ref:`Node`. Equivalent of :ref:`EditorInterface.get_edited_scene_root`. .. |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.)` diff --git a/classes/class_lightmapprobe.rst b/classes/class_lightmapprobe.rst index a13f61b7636..0c85da5bea0 100644 --- a/classes/class_lightmapprobe.rst +++ b/classes/class_lightmapprobe.rst @@ -19,10 +19,12 @@ Represents a single manually placed probe for dynamic object lighting with :ref: Description ----------- -**LightmapProbe** represents the position of a single manually placed probe for dynamic object lighting with :ref:`LightmapGI`. +**LightmapProbe** represents the position of a single manually placed probe for dynamic object lighting with :ref:`LightmapGI`. Lightmap probes affect the lighting of :ref:`GeometryInstance3D`-derived nodes that have their :ref:`GeometryInstance3D.gi_mode` set to :ref:`GeometryInstance3D.GI_MODE_DYNAMIC`. Typically, :ref:`LightmapGI` probes are placed automatically by setting :ref:`LightmapGI.generate_probes_subdiv` to a value other than :ref:`LightmapGI.GENERATE_PROBES_DISABLED`. By creating **LightmapProbe** nodes before baking lightmaps, you can add more probes in specific areas for greater detail, or disable automatic generation and rely only on manually placed probes instead. +\ **Note:** **LightmapProbe** nodes that are placed after baking lightmaps are ignored by dynamic objects. You must bake lightmaps again after creating or modifying **LightmapProbe**\ s for the probes to be effective. + .. |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.)` diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index 8721fcb3051..f8a6153a0cc 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -12,7 +12,7 @@ Node3D **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`OpenXRCompositionLayer`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` +**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OpenXRCompositionLayer`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` Most basic 3D game object, parent of all 3D-related nodes. diff --git a/classes/class_object.rst b/classes/class_object.rst index a95ce41bb5b..4910f84f598 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -1202,6 +1202,8 @@ Gets the object's property indexed by the given ``property_path``. The path shou Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedObjectAsID`, and can be used to retrieve this object instance with :ref:`@GlobalScope.instance_from_id`. +\ **Note:** This ID is only useful during the current session. It won't correspond to a similar object if the ID is sent over a network, or loaded from a file at a later time. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index cec65f8afbf..332353bd8fc 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -10,7 +10,7 @@ OccluderInstance3D ================== -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` Provides occlusion culling for 3D nodes, which improves performance in closed areas. diff --git a/classes/class_os.rst b/classes/class_os.rst index 2e3a023b748..1eca41e0573 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -89,6 +89,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_distribution_name`\ (\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_entropy`\ (\ size\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_environment`\ (\ variable\: :ref:`String`\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_executable_path`\ (\ ) |const| | @@ -123,6 +125,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_static_memory_usage`\ (\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_system_ca_certificates`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_system_dir`\ (\ dir\: :ref:`SystemDir`, shared_storage\: :ref:`bool` = true\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_system_font_path`\ (\ font_name\: :ref:`String`, weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| | @@ -787,6 +791,20 @@ Returns the same value as :ref:`get_name` for other pl ---- +.. _class_OS_method_get_entropy: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **get_entropy**\ (\ size\: :ref:`int`\ ) :ref:`🔗` + +Generates a :ref:`PackedByteArray` of cryptographically secure random bytes with given ``size``. + +\ **Note:** Generating large quantities of bytes using this method can result in locking and entropy of lower quality on most platforms. Using :ref:`Crypto.generate_random_bytes` is preferred in most cases. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_get_environment: .. rst-class:: classref-method @@ -1121,6 +1139,18 @@ Returns the amount of static memory being used by the program in bytes. Only wor ---- +.. _class_OS_method_get_system_ca_certificates: + +.. rst-class:: classref-method + +:ref:`String` **get_system_ca_certificates**\ (\ ) :ref:`🔗` + +Returns the list of certification authorities trusted by the operating system as a string of concatenated certificates in PEM format. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_get_system_dir: .. rst-class:: classref-method diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index f04fb10f045..2c171e352b7 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -137,6 +137,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`audio/general/3d_panning_strength` | ``0.5`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/general/default_playback_type` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/general/default_playback_type.web` | ``1`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`audio/general/ios/mix_with_others` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio/general/ios/session_category` | ``0`` | @@ -2252,7 +2256,7 @@ Safer override for :ref:`audio/driver/mix_rate` **audio/driver/output_latency** = ``15`` :ref:`🔗` -Specifies the preferred output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. +Specifies the preferred output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible crackling on slower hardware. Audio output latency may be constrained by the host operating system and audio hardware drivers. If the host can not provide the specified audio output latency then Godot will attempt to use the nearest latency allowed by the host. As such you should always use :ref:`AudioServer.get_output_latency` to determine the actual audio output latency. @@ -2304,6 +2308,40 @@ The default value of ``0.5`` is tuned for headphones. When using speakers, you m ---- +.. _class_ProjectSettings_property_audio/general/default_playback_type: + +.. rst-class:: classref-property + +:ref:`int` **audio/general/default_playback_type** = ``0`` :ref:`🔗` + +**Experimental:** This property may be changed or removed in future versions. + +Specifies the default playback type of the platform. + +The default value is set to **Stream**, as most platforms have no issues mixing streams. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_audio/general/default_playback_type.web: + +.. rst-class:: classref-property + +:ref:`int` **audio/general/default_playback_type.web** = ``1`` :ref:`🔗` + +**Experimental:** This property may be changed or removed in future versions. + +Specifies the default playback type of the Web platform. + +The default value is set to **Sample** as the Web platform is not suited to mix audio streams outside of the Web Audio API, especially when exporting a single-threaded game. **Sample** allows for lower latency on the web platform at the cost of flexibility (:ref:`AudioEffect`\ s are not supported). + +\ **Warning:** Forcing **Stream** on the Web platform may cause high audio latency and crackling, especially when exporting a multi-threaded game. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_audio/general/ios/mix_with_others: .. rst-class:: classref-property @@ -10696,9 +10734,9 @@ Decreasing this value may improve GPU performance on certain setups, even if the :ref:`int` **rendering/limits/global_shader_variables/buffer_size** = ``65536`` :ref:`🔗` -.. container:: contribute +The maximum number of uniforms that can be used by the global shader uniform buffer. Each item takes up one slot. In other words, a single uniform float and a uniform vec4 will take the same amount of space in the buffer. - There is currently no description for this property. Please help us by :ref:`contributing one `! +\ **Note:** When using the Compatibility backend, most mobile devices (and all web exports) will be limited to a maximum size of 1024 due to hardware constraints. .. rst-class:: classref-item-separator diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index b7e993b8f0a..fefdffe9bce 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst index 4cf144ee34f..989f5f61ffb 100644 --- a/classes/class_resourceimporterimagefont.rst +++ b/classes/class_resourceimporterimagefont.rst @@ -12,14 +12,14 @@ ResourceImporterImageFont **Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` -Imports a fixed-width bitmap font where all glyphs have the same width and height. +Imports a bitmap font where all glyphs have the same width and height. .. rst-class:: classref-introduction-group Description ----------- -This image-based workflow can be easier to use than :ref:`ResourceImporterBMFont`, but it requires all glyphs to have the same width and height. This makes **ResourceImporterImageFont** most suited to fixed-width fonts. +This image-based workflow can be easier to use than :ref:`ResourceImporterBMFont`, but it requires all glyphs to have the same width and height, glyph advances and drawing offsets can be customized. This makes **ResourceImporterImageFont** most suited to fixed-width fonts. See also :ref:`ResourceImporterDynamicFont`. diff --git a/classes/class_rid.rst b/classes/class_rid.rst index fa93b9bde11..38c0f0141b0 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -21,6 +21,8 @@ The RID :ref:`Variant` type is used to access a low-level resourc A low-level resource may correspond to a high-level :ref:`Resource`, such as :ref:`Texture` or :ref:`Mesh`. +\ **Note:** RIDs are only useful during the current session. It won't correspond to a similar resource if sent over a network, or loaded from a file at a later time. + .. note:: There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 5476c1006e2..86e11ef0a13 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -92,7 +92,7 @@ Adds a new ``anim`` animation to the library. |void| **add_frame**\ (\ anim\: :ref:`StringName`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0, at_position\: :ref:`int` = -1\ ) :ref:`🔗` -Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame will be added to the end of the animation. +Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame will be added to the end of the animation. ``duration`` specifies the relative duration, see :ref:`get_frame_duration` for details. .. rst-class:: classref-item-separator @@ -278,7 +278,7 @@ Sets the speed for the ``anim`` animation in frames per second. |void| **set_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0\ ) :ref:`🔗` -Sets the ``texture`` and the ``duration`` of the frame ``idx`` in the ``anim`` animation. +Sets the ``texture`` and the ``duration`` of the frame ``idx`` in the ``anim`` animation. ``duration`` specifies the relative duration, see :ref:`get_frame_duration` for details. .. |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.)` diff --git a/classes/class_tlsoptions.rst b/classes/class_tlsoptions.rst index 6a20091b837..c7f121a1ca6 100644 --- a/classes/class_tlsoptions.rst +++ b/classes/class_tlsoptions.rst @@ -47,13 +47,25 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`client`\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`client_unsafe`\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`server`\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`client`\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`client_unsafe`\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_common_name_override`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`X509Certificate` | :ref:`get_own_certificate`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CryptoKey` | :ref:`get_private_key`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`X509Certificate` | :ref:`get_trusted_ca_chain`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_server`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_unsafe_client`\ (\ ) |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`server`\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -94,6 +106,78 @@ Creates an **unsafe** TLS client configuration where certificate validation is o ---- +.. _class_TLSOptions_method_get_common_name_override: + +.. rst-class:: classref-method + +:ref:`String` **get_common_name_override**\ (\ ) |const| :ref:`🔗` + +Returns the common name (domain name) override specified when creating with :ref:`client`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TLSOptions_method_get_own_certificate: + +.. rst-class:: classref-method + +:ref:`X509Certificate` **get_own_certificate**\ (\ ) |const| :ref:`🔗` + +Returns the :ref:`X509Certificate` specified when creating with :ref:`server`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TLSOptions_method_get_private_key: + +.. rst-class:: classref-method + +:ref:`CryptoKey` **get_private_key**\ (\ ) |const| :ref:`🔗` + +Returns the :ref:`CryptoKey` specified when creating with :ref:`server`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TLSOptions_method_get_trusted_ca_chain: + +.. rst-class:: classref-method + +:ref:`X509Certificate` **get_trusted_ca_chain**\ (\ ) |const| :ref:`🔗` + +Returns the CA :ref:`X509Certificate` chain specified when creating with :ref:`client` or :ref:`client_unsafe`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TLSOptions_method_is_server: + +.. rst-class:: classref-method + +:ref:`bool` **is_server**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if created with :ref:`server`, ``false`` otherwise. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TLSOptions_method_is_unsafe_client: + +.. rst-class:: classref-method + +:ref:`bool` **is_unsafe_client**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if created with :ref:`client_unsafe`, ``false`` otherwise. + +.. rst-class:: classref-item-separator + +---- + .. _class_TLSOptions_method_server: .. rst-class:: classref-method diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 8f812dff1eb..c2f41ef798a 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -626,7 +626,7 @@ Returns the distance between this vector and ``to``. Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. -The dot product will be ``0`` for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. +The dot product will be ``0`` for a right angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. When using unit (normalized) vectors, the result will always be between ``-1.0`` (180 degree angle) when the vectors are facing opposite directions, and ``1.0`` (0 degree angle) when the vectors are aligned. diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 303bf8adb88..55c07fdab80 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -666,7 +666,7 @@ Returns the distance between this vector and ``to``. Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. -The dot product will be ``0`` for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. +The dot product will be ``0`` for a right angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. When using unit (normalized) vectors, the result will always be between ``-1.0`` (180 degree angle) when the vectors are facing opposite directions, and ``1.0`` (0 degree angle) when the vectors are aligned. diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 3ff32cf6412..713d99f60ff 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -12,7 +12,7 @@ VisualInstance3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Decal`, :ref:`FogVolume`, :ref:`GeometryInstance3D`, :ref:`GPUParticlesAttractor3D`, :ref:`GPUParticlesCollision3D`, :ref:`Light3D`, :ref:`LightmapGI`, :ref:`ReflectionProbe`, :ref:`RootMotionView`, :ref:`VisibleOnScreenNotifier3D`, :ref:`VoxelGI` +**Inherited By:** :ref:`Decal`, :ref:`FogVolume`, :ref:`GeometryInstance3D`, :ref:`GPUParticlesAttractor3D`, :ref:`GPUParticlesCollision3D`, :ref:`Light3D`, :ref:`LightmapGI`, :ref:`OccluderInstance3D`, :ref:`ReflectionProbe`, :ref:`RootMotionView`, :ref:`VisibleOnScreenNotifier3D`, :ref:`VoxelGI` Parent of all visual 3D nodes. diff --git a/classes/index.rst b/classes/index.rst index 9d0275ef3dd..fd3c02edabc 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -701,6 +701,8 @@ Other objects class_astargrid2d class_audioeffectinstance class_audioeffectspectrumanalyzerinstance + class_audiosample + class_audiosampleplayback class_audioserver class_audiostreamgeneratorplayback class_audiostreamplayback