From c2651cd353749efb7a8d9009e6270de24f61f54b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 19 Jun 2022 14:01:39 +0200 Subject: [PATCH] classref: Sync with current 3.5 branch (5478afdb1) --- classes/class_@gdscript.rst | 2 +- classes/class_@globalscope.rst | 38 +- classes/class_astar2d.rst | 110 +- classes/class_audioeffectcapture.rst | 2 +- classes/class_curvetexture.rst | 4 +- classes/class_dictionary.rst | 56 +- classes/class_editorplugin.rst | 42 +- classes/class_gradienttexture.rst | 2 +- classes/class_gradienttexture2d.rst | 2 +- classes/class_gridmap.rst | 36 + classes/class_input.rst | 74 +- classes/class_inputeventjoypadbutton.rst | 2 +- classes/class_inputeventmousemotion.rst | 2 +- classes/class_meshinstance2d.rst | 2 +- classes/class_navigation.rst | 41 +- classes/class_navigation2d.rst | 18 + classes/class_navigation2dserver.rst | 257 +- classes/class_navigationagent.rst | 48 +- classes/class_navigationagent2d.rst | 46 +- classes/class_navigationmesh.rst | 250 +- classes/class_navigationmeshgenerator.rst | 2 +- classes/class_navigationmeshinstance.rst | 78 +- classes/class_navigationobstacle.rst | 2 + classes/class_navigationobstacle2d.rst | 2 + classes/class_navigationpolygon.rst | 10 + classes/class_navigationpolygoninstance.rst | 85 +- classes/class_navigationserver.rst | 269 +- classes/class_node2d.rst | 2 + classes/class_os.rst | 7 + classes/class_projectsettings.rst | 2738 +++++++++++++------ classes/class_proximitygroup.rst | 1 - classes/class_richtextlabel.rst | 162 +- classes/class_scenetreetimer.rst | 2 +- classes/class_spatial.rst | 2 + classes/class_tilemap.rst | 36 + classes/class_transform2d.rst | 2 + classes/class_visibilityenabler2d.rst | 4 +- classes/class_visibilitynotifier.rst | 26 +- classes/class_visualserver.rst | 26 +- classes/class_world.rst | 18 +- classes/class_world2d.rst | 16 +- 41 files changed, 3145 insertions(+), 1379 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 68815d086..04036dff3 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -495,7 +495,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. - :ref:`bool` **deep_equal** **(** :ref:`Variant` a, :ref:`Variant` b **)** -Compares two values by checking their actual contents, recursing into any `Array` or `Dictionary` up to its deepest level. +Compares two values by checking their actual contents, recursing into any :ref:`Array` or :ref:`Dictionary` up to its deepest level. This compares to ``==`` in a number of ways: diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index a4d0fe286..58b580411 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -1915,10 +1915,14 @@ Since :ref:`OK` has value 0, and all other failu .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_PHYSICS: +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_NAVIGATION: + .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_RENDER: .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_PHYSICS: +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_NAVIGATION: + .. _class_@GlobalScope_constant_PROPERTY_HINT_FILE: .. _class_@GlobalScope_constant_PROPERTY_HINT_DIR: @@ -1951,7 +1955,7 @@ enum **PropertyHint**: The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. For integer and float properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``. -- **PROPERTY_HINT_ENUM_SUGGESTION** = **37** --- Hints that a string property can be an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``. +- **PROPERTY_HINT_ENUM_SUGGESTION** = **39** --- Hints that a string property can be an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``. Unlike :ref:`PROPERTY_HINT_ENUM` a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values. @@ -1967,29 +1971,33 @@ Unlike :ref:`PROPERTY_HINT_ENUM` - **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10** --- Hints that an integer property is a bitmask using the optionally named 2D physics layers. -- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11** --- Hints that an integer property is a bitmask using the optionally named 3D render layers. +- **PROPERTY_HINT_LAYERS_2D_NAVIGATION** = **11** --- Hints that an integer property is a bitmask using the optionally named 2D navigation layers. -- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12** --- Hints that an integer property is a bitmask using the optionally named 3D physics layers. +- **PROPERTY_HINT_LAYERS_3D_RENDER** = **12** --- Hints that an integer property is a bitmask using the optionally named 3D render layers. -- **PROPERTY_HINT_FILE** = **13** --- Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. +- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **13** --- Hints that an integer property is a bitmask using the optionally named 3D physics layers. -- **PROPERTY_HINT_DIR** = **14** --- Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path. +- **PROPERTY_HINT_LAYERS_3D_NAVIGATION** = **14** --- Hints that an integer property is a bitmask using the optionally named 3D navigation layers. -- **PROPERTY_HINT_GLOBAL_FILE** = **15** --- Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. +- **PROPERTY_HINT_FILE** = **15** --- Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. -- **PROPERTY_HINT_GLOBAL_DIR** = **16** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path. +- **PROPERTY_HINT_DIR** = **16** --- Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path. -- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate. +- **PROPERTY_HINT_GLOBAL_FILE** = **17** --- Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. -- **PROPERTY_HINT_MULTILINE_TEXT** = **18** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed. +- **PROPERTY_HINT_GLOBAL_DIR** = **18** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path. -- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** --- Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use. +- **PROPERTY_HINT_RESOURCE_TYPE** = **19** --- Hints that a property is an instance of a :ref:`Resource`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate. -- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** --- Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited. +- **PROPERTY_HINT_MULTILINE_TEXT** = **20** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed. -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that an image is compressed using lossy compression. +- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **21** --- Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use. -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an image is compressed using lossless compression. +- **PROPERTY_HINT_COLOR_NO_ALPHA** = **22** --- Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited. + +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **23** --- Hints that an image is compressed using lossy compression. + +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **24** --- Hints that an image is compressed using lossless compression. ---- @@ -2075,6 +2083,8 @@ enum **PropertyUsageFlags**: .. _class_@GlobalScope_constant_METHOD_FLAG_FROM_SCRIPT: +.. _class_@GlobalScope_constant_METHOD_FLAG_VARARG: + .. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT: enum **MethodFlags**: @@ -2093,6 +2103,8 @@ enum **MethodFlags**: - **METHOD_FLAG_FROM_SCRIPT** = **64** --- Deprecated method flag, unused. +- **METHOD_FLAG_VARARG** = **128** + - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags. ---- diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index b6e48805e..3b7e2b05a 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -21,57 +21,57 @@ This is a wrapper for the :ref:`AStar` class which uses 2D vectors Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -115,9 +115,9 @@ If there already exists a point for the given ``id``, its position and weight sc .. _class_AStar2D_method_are_points_connected: -- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** |const| +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| -Returns whether there is a connection/segment between the given points. +Returns whether there is a connection/segment between the given points. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. ---- @@ -146,9 +146,9 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o .. _class_AStar2D_method_disconnect_points: -- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** +- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** -Deletes the segment between the given points. +Deletes the segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is prevented, and a unidirectional segment possibly remains. ---- diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 0385fd0eb..2544741d1 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -18,7 +18,7 @@ Description AudioEffectCapture is an AudioEffect which copies all audio frames from the attached audio effect bus into its internal ring buffer. -Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. +Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM. Properties ---------- diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 88ccab02a..8a510b76e 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -40,7 +40,7 @@ Property Descriptions | *Getter* | get_curve() | +----------+------------------+ -The ``curve`` rendered onto the texture. +The :ref:`Curve` that is rendered onto the texture. ---- @@ -56,7 +56,7 @@ The ``curve`` rendered onto the texture. | *Getter* | get_width() | +-----------+------------------+ -The width of the texture. +The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage. .. |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_dictionary.rst b/classes/class_dictionary.rst index df106b0b8..02fc5c923 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -124,29 +124,31 @@ Tutorials Methods ------- -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`keys` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`values` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`keys` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`merge` **(** :ref:`Dictionary` dictionary, :ref:`bool` overwrite=false **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`values` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -246,6 +248,14 @@ Returns the list of keys in the ``Dictionary``. ---- +.. _class_Dictionary_method_merge: + +- void **merge** **(** :ref:`Dictionary` dictionary, :ref:`bool` overwrite=false **)** + +Adds elements from ``dictionary`` to this ``Dictionary``. By default, duplicate keys will not be copied over, unless ``overwrite`` is ``true``. + +---- + .. _class_Dictionary_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index e6279d502..1faf666ac 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -628,7 +628,19 @@ Gets the Editor's dialog used for making scripts. - :ref:`Dictionary` **get_state** **(** **)** |virtual| -Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). +Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). This data is automatically saved for each scene in an ``editstate`` file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use :ref:`get_window_layout` instead. + +Use :ref:`set_state` to restore your saved state. + +\ **Note:** This method should not be used to save important settings that should persist with the project. + +\ **Note:** You must implement :ref:`get_plugin_name` for the state to be stored and restored correctly. + +:: + + func get_state(): + var state = {"zoom": zoom, "preferred_color": my_color} + return state ---- @@ -644,7 +656,15 @@ Gets the undo/redo object. Most actions in the editor can be undoable, so use th - void **get_window_layout** **(** :ref:`ConfigFile` layout **)** |virtual| -Gets the GUI layout of the plugin. This is used to save the project's editor layout when :ref:`queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). +Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when :ref:`queue_save_layout` is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the ``editor_layout.cfg`` file in the editor metadata directory. + +Use :ref:`set_window_layout` to restore your saved layout. + +:: + + func get_window_layout(configuration): + configuration.set_value("MyPlugin", "window_position", $Window.position) + configuration.set_value("MyPlugin", "icon_color", $Icon.modulate) ---- @@ -814,7 +834,15 @@ Use this method if you always want to receive inputs from 3D view screen inside - void **set_state** **(** :ref:`Dictionary` state **)** |virtual| -Restore the state saved by :ref:`get_state`. +Restore the state saved by :ref:`get_state`. This method is called when the current scene tab is changed in the editor. + +\ **Note:** Your plugin must implement :ref:`get_plugin_name`, otherwise it will not be recognized and this method will not be called. + +:: + + func set_state(data): + zoom = data.get("zoom", 1.0) + preferred_color = data.get("my_color", Color.white) ---- @@ -822,7 +850,13 @@ Restore the state saved by :ref:`get_state` - void **set_window_layout** **(** :ref:`ConfigFile` layout **)** |virtual| -Restore the plugin GUI layout saved by :ref:`get_window_layout`. +Restore the plugin GUI layout and data saved by :ref:`get_window_layout`. This method is called for every plugin on editor startup. Use the provided ``configuration`` file to read your saved data. + +:: + + func set_window_layout(configuration): + $Window.position = configuration.get_value("MyPlugin", "window_position", Vector2()) + $Icon.modulate = configuration.get_value("MyPlugin", "icon_color", Color.white) ---- diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 849ae2c1f..183432cff 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -16,7 +16,7 @@ Gradient-filled texture. Description ----------- -GradientTexture uses a :ref:`Gradient` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). +GradientTexture uses a :ref:`Gradient` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). See also :ref:`GradientTexture2D` and :ref:`CurveTexture`. Properties ---------- diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index 936377e77..45b729404 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -16,7 +16,7 @@ Gradient-filled 2D texture. Description ----------- -The texture uses a :ref:`Gradient` to fill the texture data in 2D space. The gradient is filled according to the specified :ref:`fill` and :ref:`repeat` types using colors obtained from the gradient. The texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width` and :ref:`height`). +The texture uses a :ref:`Gradient` to fill the texture data in 2D space. The gradient is filled according to the specified :ref:`fill` and :ref:`repeat` types using colors obtained from the gradient. The texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width` and :ref:`height`). See also :ref:`GradientTexture` and :ref:`CurveTexture`. Properties ---------- diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 52d2bbdd9..b1cc1ec89 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -38,6 +38,8 @@ Tutorials Properties ---------- ++-----------------------------------------------+----------------------------------------------------------------------+------------------------+ +| :ref:`bool` | :ref:`bake_navigation` | ``false`` | +-----------------------------------------------+----------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`cell_center_x` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------+------------------------+ @@ -57,6 +59,8 @@ Properties +-----------------------------------------------+----------------------------------------------------------------------+------------------------+ | :ref:`MeshLibrary` | :ref:`mesh_library` | | +-----------------------------------------------+----------------------------------------------------------------------+------------------------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------+------------------------+ | :ref:`PhysicsMaterial` | :ref:`physics_material` | | +-----------------------------------------------+----------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`use_in_baked_light` | ``false`` | @@ -124,6 +128,22 @@ Constants Property Descriptions --------------------- +.. _class_GridMap_property_bake_navigation: + +- :ref:`bool` **bake_navigation** + ++-----------+----------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------+ +| *Setter* | set_bake_navigation(value) | ++-----------+----------------------------+ +| *Getter* | is_baking_navigation() | ++-----------+----------------------------+ + +If ``true``, this GridMap uses cell navmesh resources to create navigation regions. + +---- + .. _class_GridMap_property_cell_center_x: - :ref:`bool` **cell_center_x** @@ -272,6 +292,22 @@ The assigned :ref:`MeshLibrary`. ---- +.. _class_GridMap_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +The navigation layers the GridMap generates its navigation regions in. + +---- + .. _class_GridMap_property_physics_material: - :ref:`PhysicsMaterial` **physics_material** diff --git a/classes/class_input.rst b/classes/class_input.rst index 5cb13da7d..a861741ea 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -27,6 +27,15 @@ Tutorials - `3D Voxel Demo `__ +Properties +---------- + ++----------------------------------------+--------------------------------------------------------------------------+ +| :ref:`MouseMode` | :ref:`mouse_mode` | ++----------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_accumulated_input` | ++----------------------------------------+--------------------------------------------------------------------------+ + Methods ------- @@ -79,8 +88,6 @@ Methods +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** |const| | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** |const| | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_vector` **(** :ref:`String` negative_x, :ref:`String` positive_x, :ref:`String` negative_y, :ref:`String` positive_y, :ref:`float` deadzone=-1.0 **)** |const| | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action, :ref:`bool` exact=false **)** |const| | @@ -117,10 +124,6 @@ Methods +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_magnetometer` **(** :ref:`Vector3` value **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | @@ -238,6 +241,37 @@ enum **CursorShape**: - **CURSOR_HELP** = **16** --- Help cursor. Usually a question mark. +Property Descriptions +--------------------- + +.. _class_Input_property_mouse_mode: + +- :ref:`MouseMode` **mouse_mode** + ++----------+-----------------------+ +| *Setter* | set_mouse_mode(value) | ++----------+-----------------------+ +| *Getter* | get_mouse_mode() | ++----------+-----------------------+ + +Controls the mouse mode. See :ref:`MouseMode` for more information. + +---- + +.. _class_Input_property_use_accumulated_input: + +- :ref:`bool` **use_accumulated_input** + ++----------+----------------------------------+ +| *Setter* | set_use_accumulated_input(value) | ++----------+----------------------------------+ +| *Getter* | is_using_accumulated_input() | ++----------+----------------------------------+ + +If ``true``, similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. + +Input accumulation can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input. + Method Descriptions ------------------- @@ -273,7 +307,7 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally up - void **flush_buffered_events** **(** **)** -Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input (:ref:`set_use_accumulated_input`) or agile input flushing (:ref:`ProjectSettings.input_devices/buffering/agile_event_flushing`). +Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input (:ref:`use_accumulated_input`) or agile input flushing (:ref:`ProjectSettings.input_devices/buffering/agile_event_flushing`). The engine will already do this itself at key execution points (at least once per frame). However, this can be useful in advanced cases where you want precise control over the timing of event handling. @@ -455,14 +489,6 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the ---- -.. _class_Input_method_get_mouse_mode: - -- :ref:`MouseMode` **get_mouse_mode** **(** **)** |const| - -Returns the mouse mode. See the constants for more information. - ----- - .. _class_Input_method_get_vector: - :ref:`Vector2` **get_vector** **(** :ref:`String` negative_x, :ref:`String` positive_x, :ref:`String` negative_y, :ref:`String` positive_y, :ref:`float` deadzone=-1.0 **)** |const| @@ -662,24 +688,6 @@ Sets the value of the magnetic field of the magnetometer sensor. Can be used for ---- -.. _class_Input_method_set_mouse_mode: - -- void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** - -Sets the mouse mode. See the constants for more information. - ----- - -.. _class_Input_method_set_use_accumulated_input: - -- void **set_use_accumulated_input** **(** :ref:`bool` enable **)** - -Enables or disables the accumulation of similar input events sent by the operating system. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. - -Input accumulation is enabled by default. It can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input. - ----- - .. _class_Input_method_start_joy_vibration: - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 315a0de87..4d5cfdafc 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -81,7 +81,7 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is | *Getter* | get_pressure() | +-----------+---------------------+ -Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. +Represents the pressure the user puts on the button with their finger, if the controller supports it. Ranges from ``0`` to ``1``. .. |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_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 4bc45539d..4daf7f67e 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -18,7 +18,7 @@ Description Contains mouse and pen motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. -\ **Note:** By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, call :ref:`Input.set_use_accumulated_input` with ``false`` to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing `Bresenham's line algorithm `__ as well to avoid visible gaps in lines if the user is moving the mouse quickly. +\ **Note:** By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, set :ref:`Input.use_accumulated_input` to ``false`` to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing `Bresenham's line algorithm `__ as well to avoid visible gaps in lines if the user is moving the mouse quickly. Tutorials --------- diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index d225bb6ed..6b8af7ed6 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -16,7 +16,7 @@ Node used for displaying a :ref:`Mesh` in 2D. Description ----------- -Node used for displaying a :ref:`Mesh` in 2D. Can be constructed from an existing :ref:`Sprite` via a tool in the editor toolbar. Select "Sprite" then "Convert to Mesh2D", select settings in popup and press "Create Mesh2D". +Node used for displaying a :ref:`Mesh` in 2D. A ``MeshInstance2D`` can be automatically created from an existing :ref:`Sprite` via a tool in the editor toolbar. Select the :ref:`Sprite` node, then choose **Sprite > Convert to MeshInstance2D** at the top of the 2D editor viewport. Tutorials --------- diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 2bbfa9ae8..6f77478cd 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -27,11 +27,13 @@ Properties ---------- +-------------------------------+---------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`cell_height` | ``0.2`` | +| :ref:`float` | :ref:`cell_height` | ``0.25`` | +-------------------------------+---------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`cell_size` | ``0.3`` | +| :ref:`float` | :ref:`cell_size` | ``0.25`` | +-------------------------------+---------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`edge_connection_margin` | ``5.0`` | +| :ref:`float` | :ref:`edge_connection_margin` | ``0.25`` | ++-------------------------------+---------------------------------------------------------------------------------+------------------------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | +-------------------------------+---------------------------------------------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`up_vector` | ``Vector3( 0, 1, 0 )`` | +-------------------------------+---------------------------------------------------------------------------------+------------------------+ @@ -53,6 +55,15 @@ Methods | :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Signals +------- + +.. _class_Navigation_signal_map_changed: + +- **map_changed** **(** :ref:`RID` map **)** + +Emitted when a navigation map is updated, when a region moves or is modified. + Property Descriptions --------------------- @@ -61,7 +72,7 @@ Property Descriptions - :ref:`float` **cell_height** +-----------+------------------------+ -| *Default* | ``0.2`` | +| *Default* | ``0.25`` | +-----------+------------------------+ | *Setter* | set_cell_height(value) | +-----------+------------------------+ @@ -77,7 +88,7 @@ The cell height to use for fields. - :ref:`float` **cell_size** +-----------+----------------------+ -| *Default* | ``0.3`` | +| *Default* | ``0.25`` | +-----------+----------------------+ | *Setter* | set_cell_size(value) | +-----------+----------------------+ @@ -93,7 +104,7 @@ The XZ plane cell size to use for fields. - :ref:`float` **edge_connection_margin** +-----------+-----------------------------------+ -| *Default* | ``5.0`` | +| *Default* | ``0.25`` | +-----------+-----------------------------------+ | *Setter* | set_edge_connection_margin(value) | +-----------+-----------------------------------+ @@ -104,6 +115,22 @@ This value is used to detect the near edges to connect compatible regions. ---- +.. _class_Navigation_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the navigation can use on a :ref:`get_simple_path` path query. + +---- + .. _class_Navigation_property_up_vector: - :ref:`Vector3` **up_vector** @@ -157,7 +184,7 @@ Returns the navigation point closest to the given line segment. When enabling `` - :ref:`RID` **get_rid** **(** **)** |const| -Returns the object's :ref:`RID`. +Returns the :ref:`RID` of the navigation map on the :ref:`NavigationServer`. ---- diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 964189747..a9733d9de 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -31,6 +31,8 @@ Properties +---------------------------+-----------------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`edge_connection_margin` | ``1.0`` | +---------------------------+-----------------------------------------------------------------------------------+---------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++---------------------------+-----------------------------------------------------------------------------------+---------+ Methods ------- @@ -78,6 +80,22 @@ The XY plane cell size to use for fields. This value is used to detect the near edges to connect compatible regions. +---- + +.. _class_Navigation2D_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the navigation can use on a :ref:`get_simple_path` path query. + Method Descriptions ------------------- diff --git a/classes/class_navigation2dserver.rst b/classes/class_navigation2dserver.rst index 0e14393a0..61951bf21 100644 --- a/classes/class_navigation2dserver.rst +++ b/classes/class_navigation2dserver.rst @@ -22,7 +22,9 @@ Maps are made up of regions, which are made of navigation polygons. Together, th \ **Note:** Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts. -For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than :ref:`Navigation.edge_connection_margin` to the respective other edge's vertex. +For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than navigation map ``edge_connection_margin`` to the respective other edge's vertex. + +You may assign navigation layers to regions with :ref:`region_set_navigation_layers`, which then can be checked upon when requesting a path with :ref:`map_get_path`. This allows allowing or forbidding some areas to 2D objects. To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity. @@ -38,69 +40,100 @@ Tutorials Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`agent_create` **(** **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector2` target_velocity **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`map_create` **(** **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`region_create` **(** **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_navpoly` **(** :ref:`RID` region, :ref:`NavigationPolygon` nav_poly **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** |const| | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_create` **(** **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector2` target_velocity **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_create` **(** **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_height` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_height` **(** :ref:`RID` map, :ref:`float` cell_height **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_create` **(** **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navpoly` **(** :ref:`RID` region, :ref:`NavigationPolygon` nav_poly **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** |const| | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_Navigation2DServer_signal_map_changed: + +- **map_changed** **(** :ref:`RID` map **)** + +Emitted when a navigation map is updated, when a region moves or is modified. Method Descriptions ------------------- @@ -133,7 +166,9 @@ Returns ``true`` if the map got changed the previous frame. - void **agent_set_callback** **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| -Callback called at the end of the RVO process. +Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated ``safe_velocity`` to the ``receiver`` object with a signal to the chosen ``method`` name. + +\ **Note:** Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use :ref:`agent_set_callback` again with a ``null`` object as the ``receiver``. ---- @@ -233,6 +268,14 @@ Returns all navigation agents :ref:`RID`\ s that are currently assign ---- +.. _class_Navigation2DServer_method_map_get_cell_height: + +- :ref:`float` **map_get_cell_height** **(** :ref:`RID` map **)** |const| + +Returns the map cell height. **Note:** Currently not implemented. + +---- + .. _class_Navigation2DServer_method_map_get_cell_size: - :ref:`float` **map_get_cell_size** **(** :ref:`RID` map **)** |const| @@ -267,9 +310,9 @@ Returns the edge connection margin of the map. The edge connection margin is a d .. _class_Navigation2DServer_method_map_get_path: -- :ref:`PoolVector2Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize **)** |const| +- :ref:`PoolVector2Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| -Returns the navigation path to reach the destination from the origin. +Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region layers that are allowed to be in the path. ---- @@ -297,6 +340,14 @@ Sets the map active. ---- +.. _class_Navigation2DServer_method_map_set_cell_height: + +- void **map_set_cell_height** **(** :ref:`RID` map, :ref:`float` cell_height **)** |const| + +Set the map cell height used to weld the navigation mesh polygons. **Note:** Currently not implemented. + +---- + .. _class_Navigation2DServer_method_map_set_cell_size: - void **map_set_cell_size** **(** :ref:`RID` map, :ref:`float` cell_size **)** |const| @@ -321,6 +372,38 @@ Creates a new region. ---- +.. _class_Navigation2DServer_method_region_get_connection_pathway_end: + +- :ref:`Vector2` **region_get_connection_pathway_end** **(** :ref:`RID` region, :ref:`int` connection **)** |const| + +Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. + +---- + +.. _class_Navigation2DServer_method_region_get_connection_pathway_start: + +- :ref:`Vector2` **region_get_connection_pathway_start** **(** :ref:`RID` region, :ref:`int` connection **)** |const| + +Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. + +---- + +.. _class_Navigation2DServer_method_region_get_connections_count: + +- :ref:`int` **region_get_connections_count** **(** :ref:`RID` region **)** |const| + +Returns how many connections this ``region`` has with other regions in the map. + +---- + +.. _class_Navigation2DServer_method_region_get_enter_cost: + +- :ref:`float` **region_get_enter_cost** **(** :ref:`RID` region **)** |const| + +Returns the ``enter_cost`` of this ``region``. + +---- + .. _class_Navigation2DServer_method_region_get_map: - :ref:`RID` **region_get_map** **(** :ref:`RID` region **)** |const| @@ -329,6 +412,30 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur ---- +.. _class_Navigation2DServer_method_region_get_navigation_layers: + +- :ref:`int` **region_get_navigation_layers** **(** :ref:`RID` region **)** |const| + +Returns the region's navigation layers. + +---- + +.. _class_Navigation2DServer_method_region_get_travel_cost: + +- :ref:`float` **region_get_travel_cost** **(** :ref:`RID` region **)** |const| + +Returns the ``travel_cost`` of this ``region``. + +---- + +.. _class_Navigation2DServer_method_region_set_enter_cost: + +- void **region_set_enter_cost** **(** :ref:`RID` region, :ref:`float` enter_cost **)** |const| + +Sets the ``enter_cost`` for this ``region``. + +---- + .. _class_Navigation2DServer_method_region_set_map: - void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** |const| @@ -337,6 +444,14 @@ Sets the map for the region. ---- +.. _class_Navigation2DServer_method_region_set_navigation_layers: + +- void **region_set_navigation_layers** **(** :ref:`RID` region, :ref:`int` navigation_layers **)** |const| + +Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). + +---- + .. _class_Navigation2DServer_method_region_set_navpoly: - void **region_set_navpoly** **(** :ref:`RID` region, :ref:`NavigationPolygon` nav_poly **)** |const| @@ -351,6 +466,14 @@ Sets the navigation mesh for the region. Sets the global transformation for the region. +---- + +.. _class_Navigation2DServer_method_region_set_travel_cost: + +- void **region_set_travel_cost** **(** :ref:`RID` region, :ref:`float` travel_cost **)** |const| + +Sets the ``travel_cost`` for this ``region``. + .. |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_navigationagent.rst b/classes/class_navigationagent.rst index f727eb585..cff12d7f9 100644 --- a/classes/class_navigationagent.rst +++ b/classes/class_navigationagent.rst @@ -16,7 +16,9 @@ NavigationAgent Description ----------- -3D agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO (Reciprocal Velocity Obstacles) collision avoidance. The agent needs navigation data to work correctly. This can be done by having the agent as a child of a :ref:`Navigation` node, or using :ref:`set_navigation`. ``NavigationAgent`` is physics safe. +3D agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO (Reciprocal Velocity Obstacles) collision avoidance. The agent needs navigation data to work correctly. By default this node will register to the default :ref:`World` navigation map. If this node is a child of a :ref:`Navigation` node it will register to the navigation map of the navigation node or the function :ref:`set_navigation` can be used to set the navigation node directly. ``NavigationAgent`` is physics safe. + +\ **Note:** After :ref:`set_target_location` is used it is required to use the :ref:`get_next_location` function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node. Properties ---------- @@ -32,6 +34,8 @@ Properties +---------------------------+----------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`max_speed` | ``10.0`` | +---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`neighbor_dist` | ``50.0`` | +---------------------------+----------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`path_max_distance` | ``3.0`` | @@ -57,6 +61,8 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_navigation` **(** **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_next_location` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | @@ -71,6 +77,8 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_location` **(** :ref:`Vector3` location **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_velocity` **(** :ref:`Vector3` velocity **)** | @@ -124,7 +132,7 @@ Property Descriptions | *Getter* | get_agent_height_offset() | +-----------+--------------------------------+ -The agent height offset to match the navigation mesh height. +The NavigationAgent height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents. ---- @@ -192,6 +200,22 @@ The maximum speed that an agent can move. ---- +.. _class_NavigationAgent_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the ``NavigationAgent`` belongs to. On path requests the agent will ignore navmeshes without at least one matching layer. + +---- + .. _class_NavigationAgent_property_neighbor_dist: - :ref:`float` **neighbor_dist** @@ -293,7 +317,7 @@ Returns the reachable final location in global coordinates. This can change if t - :ref:`PoolVector3Array` **get_nav_path** **(** **)** |const| -Returns the path from start to finish in global coordinates. +Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_location` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. ---- @@ -313,11 +337,19 @@ Returns the :ref:`Navigation` node that the agent is using for ---- +.. _class_NavigationAgent_method_get_navigation_map: + +- :ref:`RID` **get_navigation_map** **(** **)** |const| + +Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. + +---- + .. _class_NavigationAgent_method_get_next_location: - :ref:`Vector3` **get_next_location** **(** **)** -Returns a :ref:`Vector3` in global coordinates, that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the origin of the agent's parent. +Returns the next location in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. ---- @@ -369,6 +401,14 @@ Sets the :ref:`Navigation` node used by the agent. Useful when ---- +.. _class_NavigationAgent_method_set_navigation_map: + +- void **set_navigation_map** **(** :ref:`RID` navigation_map **)** + +Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. + +---- + .. _class_NavigationAgent_method_set_target_location: - void **set_target_location** **(** :ref:`Vector3` location **)** diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index eeb1c3d79..1f50ab4cb 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -16,7 +16,9 @@ NavigationAgent2D Description ----------- -2D agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO (Reciprocal Velocity Obstacles) collision avoidance. The agent needs navigation data to work correctly. This can be done by having the agent as a child of a :ref:`Navigation2D` node, or using :ref:`set_navigation`. ``NavigationAgent2D`` is physics safe. +2D agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO (Reciprocal Velocity Obstacles) collision avoidance. The agent needs navigation data to work correctly. By default this node will register to the default :ref:`World2D` navigation map. If this node is a child of a :ref:`Navigation2D` node it will register to the navigation map of the navigation node or the function :ref:`set_navigation` can be used to set the navigation node directly. ``NavigationAgent2D`` is physics safe. + +\ **Note:** After :ref:`set_target_location` is used it is required to use the :ref:`get_next_location` function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node. Properties ---------- @@ -28,6 +30,8 @@ Properties +---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`max_speed` | ``200.0`` | +---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`neighbor_dist` | ``500.0`` | +---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`path_max_distance` | ``3.0`` | @@ -53,6 +57,8 @@ Methods +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_navigation` **(** **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_next_location` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | @@ -67,6 +73,8 @@ Methods +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_location` **(** :ref:`Vector2` location **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_velocity` **(** :ref:`Vector2` velocity **)** | @@ -156,6 +164,22 @@ The maximum speed that an agent can move. ---- +.. _class_NavigationAgent2D_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the ``NavigationAgent2D`` belongs to. On path requests the agent will ignore navmeshes without at least one matching layer. + +---- + .. _class_NavigationAgent2D_property_neighbor_dist: - :ref:`float` **neighbor_dist** @@ -257,7 +281,7 @@ Returns the reachable final location in global coordinates. This can change if t - :ref:`PoolVector2Array` **get_nav_path** **(** **)** |const| -Returns the path from start to finish in global coordinates. +Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_location` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. ---- @@ -277,11 +301,19 @@ Returns the :ref:`Navigation2D` node that the agent is using ---- +.. _class_NavigationAgent2D_method_get_navigation_map: + +- :ref:`RID` **get_navigation_map** **(** **)** |const| + +Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. + +---- + .. _class_NavigationAgent2D_method_get_next_location: - :ref:`Vector2` **get_next_location** **(** **)** -Returns a :ref:`Vector2` in global coordinates, that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. +Returns the next location in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. ---- @@ -333,6 +365,14 @@ Sets the :ref:`Navigation2D` node used by the agent. Useful ---- +.. _class_NavigationAgent2D_method_set_navigation_map: + +- void **set_navigation_map** **(** :ref:`RID` navigation_map **)** + +Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. + +---- + .. _class_NavigationAgent2D_method_set_target_location: - void **set_target_location** **(** :ref:`Vector2` location **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 1fe87c953..4f445efbb 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -26,49 +26,49 @@ Tutorials Properties ---------- -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/height` | ``1.5`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/max_climb` | ``0.25`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/max_slope` | ``45.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/radius` | ``0.5`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`cell/height` | ``0.25`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`cell/size` | ``0.25`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`detail/sample_distance` | ``6.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`detail/sample_max_error` | ``5.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`edge/max_error` | ``1.3`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`edge/max_length` | ``12.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | ``false`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/ledge_spans` | ``false`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | ``false`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`geometry/collision_mask` | | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`ParsedGeometryType` | :ref:`geometry/parsed_geometry_type` | ``0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`SourceGeometryMode` | :ref:`geometry/source_geometry_mode` | ``0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`geometry/source_group_name` | | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`polygon/verts_per_poly` | ``6.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`region/merge_size` | ``20.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`region/min_size` | ``2.0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`SamplePartitionType` | :ref:`sample_partition_type/sample_partition_type` | ``0`` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`agent_height` | ``1.5`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`agent_max_climb` | ``0.25`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`agent_max_slope` | ``45.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`agent_radius` | ``0.5`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`cell_height` | ``0.25`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`cell_size` | ``0.25`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`detail_sample_distance` | ``6.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`detail_sample_max_error` | ``1.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`edge_max_error` | ``1.3`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`edge_max_length` | ``12.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`filter_ledge_spans` | ``false`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`filter_low_hanging_obstacles` | ``false`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`filter_walkable_low_height_spans` | ``false`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`int` | :ref:`geometry_collision_mask` | ``4294967295`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`ParsedGeometryType` | :ref:`geometry_parsed_geometry_type` | ``0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`SourceGeometryMode` | :ref:`geometry_source_geometry_mode` | ``0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`String` | :ref:`geometry_source_group_name` | ``"navmesh"`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`polygon_verts_per_poly` | ``6.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`region_merge_size` | ``20.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`region_min_size` | ``2.0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ +| :ref:`SamplePartitionType` | :ref:`sample_partition_type` | ``0`` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+----------------+ Methods ------- @@ -132,7 +132,7 @@ enum **ParsedGeometryType**: - **PARSED_GEOMETRY_MESH_INSTANCES** = **0** --- Parses mesh instances as geometry. This includes :ref:`MeshInstance`, :ref:`CSGShape`, and :ref:`GridMap` nodes. -- **PARSED_GEOMETRY_STATIC_COLLIDERS** = **1** --- Parses :ref:`StaticBody` colliders as geometry. The collider should be in any of the layers specified by :ref:`geometry/collision_mask`. +- **PARSED_GEOMETRY_STATIC_COLLIDERS** = **1** --- Parses :ref:`StaticBody` colliders as geometry. The collider should be in any of the layers specified by :ref:`geometry_collision_mask`. - **PARSED_GEOMETRY_BOTH** = **2** --- Both :ref:`PARSED_GEOMETRY_MESH_INSTANCES` and :ref:`PARSED_GEOMETRY_STATIC_COLLIDERS`. @@ -154,18 +154,18 @@ enum **SourceGeometryMode**: - **SOURCE_GEOMETRY_NAVMESH_CHILDREN** = **0** --- Scans the child nodes of :ref:`NavigationMeshInstance` recursively for geometry. -- **SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN** = **1** --- Scans nodes in a group and their child nodes recursively for geometry. The group is specified by :ref:`geometry/source_group_name`. +- **SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN** = **1** --- Scans nodes in a group and their child nodes recursively for geometry. The group is specified by :ref:`geometry_source_group_name`. -- **SOURCE_GEOMETRY_GROUPS_EXPLICIT** = **2** --- Uses nodes in a group for geometry. The group is specified by :ref:`geometry/source_group_name`. +- **SOURCE_GEOMETRY_GROUPS_EXPLICIT** = **2** --- Uses nodes in a group for geometry. The group is specified by :ref:`geometry_source_group_name`. - **SOURCE_GEOMETRY_MAX** = **3** --- Represents the size of the :ref:`SourceGeometryMode` enum. Property Descriptions --------------------- -.. _class_NavigationMesh_property_agent/height: +.. _class_NavigationMesh_property_agent_height: -- :ref:`float` **agent/height** +- :ref:`float` **agent_height** +-----------+-------------------------+ | *Default* | ``1.5`` | @@ -177,13 +177,13 @@ Property Descriptions The minimum floor to ceiling height that will still allow the floor area to be considered walkable. -\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell/height`. +\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell_height`. ---- -.. _class_NavigationMesh_property_agent/max_climb: +.. _class_NavigationMesh_property_agent_max_climb: -- :ref:`float` **agent/max_climb** +- :ref:`float` **agent_max_climb** +-----------+----------------------------+ | *Default* | ``0.25`` | @@ -195,13 +195,13 @@ The minimum floor to ceiling height that will still allow the floor area to be c The minimum ledge height that is considered to still be traversable. -\ **Note:** While baking, this value will be rounded down to the nearest multiple of :ref:`cell/height`. +\ **Note:** While baking, this value will be rounded down to the nearest multiple of :ref:`cell_height`. ---- -.. _class_NavigationMesh_property_agent/max_slope: +.. _class_NavigationMesh_property_agent_max_slope: -- :ref:`float` **agent/max_slope** +- :ref:`float` **agent_max_slope** +-----------+----------------------------+ | *Default* | ``45.0`` | @@ -215,9 +215,9 @@ The maximum slope that is considered walkable, in degrees. ---- -.. _class_NavigationMesh_property_agent/radius: +.. _class_NavigationMesh_property_agent_radius: -- :ref:`float` **agent/radius** +- :ref:`float` **agent_radius** +-----------+-------------------------+ | *Default* | ``0.5`` | @@ -229,13 +229,13 @@ The maximum slope that is considered walkable, in degrees. The distance to erode/shrink the walkable area of the heightfield away from obstructions. -\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell/size`. +\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell_size`. ---- -.. _class_NavigationMesh_property_cell/height: +.. _class_NavigationMesh_property_cell_height: -- :ref:`float` **cell/height** +- :ref:`float` **cell_height** +-----------+------------------------+ | *Default* | ``0.25`` | @@ -249,9 +249,9 @@ The Y axis cell size to use for fields. ---- -.. _class_NavigationMesh_property_cell/size: +.. _class_NavigationMesh_property_cell_size: -- :ref:`float` **cell/size** +- :ref:`float` **cell_size** +-----------+----------------------+ | *Default* | ``0.25`` | @@ -265,9 +265,9 @@ The XZ plane cell size to use for fields. ---- -.. _class_NavigationMesh_property_detail/sample_distance: +.. _class_NavigationMesh_property_detail_sample_distance: -- :ref:`float` **detail/sample_distance** +- :ref:`float` **detail_sample_distance** +-----------+-----------------------------------+ | *Default* | ``6.0`` | @@ -281,12 +281,12 @@ The sampling distance to use when generating the detail mesh, in cell unit. ---- -.. _class_NavigationMesh_property_detail/sample_max_error: +.. _class_NavigationMesh_property_detail_sample_max_error: -- :ref:`float` **detail/sample_max_error** +- :ref:`float` **detail_sample_max_error** +-----------+------------------------------------+ -| *Default* | ``5.0`` | +| *Default* | ``1.0`` | +-----------+------------------------------------+ | *Setter* | set_detail_sample_max_error(value) | +-----------+------------------------------------+ @@ -297,9 +297,9 @@ The maximum distance the detail mesh surface should deviate from heightfield, in ---- -.. _class_NavigationMesh_property_edge/max_error: +.. _class_NavigationMesh_property_edge_max_error: -- :ref:`float` **edge/max_error** +- :ref:`float` **edge_max_error** +-----------+---------------------------+ | *Default* | ``1.3`` | @@ -313,9 +313,9 @@ The maximum distance a simplfied contour's border edges should deviate the origi ---- -.. _class_NavigationMesh_property_edge/max_length: +.. _class_NavigationMesh_property_edge_max_length: -- :ref:`float` **edge/max_length** +- :ref:`float` **edge_max_length** +-----------+----------------------------+ | *Default* | ``12.0`` | @@ -327,29 +327,13 @@ The maximum distance a simplfied contour's border edges should deviate the origi The maximum allowed length for contour edges along the border of the mesh. -\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell/size`. +\ **Note:** While baking, this value will be rounded up to the nearest multiple of :ref:`cell_size`. ---- -.. _class_NavigationMesh_property_filter/filter_walkable_low_height_spans: +.. _class_NavigationMesh_property_filter_ledge_spans: -- :ref:`bool` **filter/filter_walkable_low_height_spans** - -+-----------+---------------------------------------------+ -| *Default* | ``false`` | -+-----------+---------------------------------------------+ -| *Setter* | set_filter_walkable_low_height_spans(value) | -+-----------+---------------------------------------------+ -| *Getter* | get_filter_walkable_low_height_spans() | -+-----------+---------------------------------------------+ - -If ``true``, marks walkable spans as not walkable if the clearance above the span is less than :ref:`agent/height`. - ----- - -.. _class_NavigationMesh_property_filter/ledge_spans: - -- :ref:`bool` **filter/ledge_spans** +- :ref:`bool` **filter_ledge_spans** +-----------+-------------------------------+ | *Default* | ``false`` | @@ -363,9 +347,9 @@ If ``true``, marks spans that are ledges as non-walkable. ---- -.. _class_NavigationMesh_property_filter/low_hanging_obstacles: +.. _class_NavigationMesh_property_filter_low_hanging_obstacles: -- :ref:`bool` **filter/low_hanging_obstacles** +- :ref:`bool` **filter_low_hanging_obstacles** +-----------+-----------------------------------------+ | *Default* | ``false`` | @@ -375,29 +359,47 @@ If ``true``, marks spans that are ledges as non-walkable. | *Getter* | get_filter_low_hanging_obstacles() | +-----------+-----------------------------------------+ -If ``true``, marks non-walkable spans as walkable if their maximum is within :ref:`agent/max_climb` of a walkable neighbor. +If ``true``, marks non-walkable spans as walkable if their maximum is within :ref:`agent_max_climb` of a walkable neighbor. ---- -.. _class_NavigationMesh_property_geometry/collision_mask: +.. _class_NavigationMesh_property_filter_walkable_low_height_spans: -- :ref:`int` **geometry/collision_mask** +- :ref:`bool` **filter_walkable_low_height_spans** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------------------+ +| *Setter* | set_filter_walkable_low_height_spans(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_filter_walkable_low_height_spans() | ++-----------+---------------------------------------------+ + +If ``true``, marks walkable spans as not walkable if the clearance above the span is less than :ref:`agent_height`. + +---- + +.. _class_NavigationMesh_property_geometry_collision_mask: + +- :ref:`int` **geometry_collision_mask** + ++-----------+---------------------------+ +| *Default* | ``4294967295`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ The physics layers to scan for static colliders. -Only used when :ref:`geometry/parsed_geometry_type` is :ref:`PARSED_GEOMETRY_STATIC_COLLIDERS` or :ref:`PARSED_GEOMETRY_BOTH`. +Only used when :ref:`geometry_parsed_geometry_type` is :ref:`PARSED_GEOMETRY_STATIC_COLLIDERS` or :ref:`PARSED_GEOMETRY_BOTH`. ---- -.. _class_NavigationMesh_property_geometry/parsed_geometry_type: +.. _class_NavigationMesh_property_geometry_parsed_geometry_type: -- :ref:`ParsedGeometryType` **geometry/parsed_geometry_type** +- :ref:`ParsedGeometryType` **geometry_parsed_geometry_type** +-----------+---------------------------------+ | *Default* | ``0`` | @@ -411,9 +413,9 @@ Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeome ---- -.. _class_NavigationMesh_property_geometry/source_geometry_mode: +.. _class_NavigationMesh_property_geometry_source_geometry_mode: -- :ref:`SourceGeometryMode` **geometry/source_geometry_mode** +- :ref:`SourceGeometryMode` **geometry_source_geometry_mode** +-----------+---------------------------------+ | *Default* | ``0`` | @@ -427,25 +429,27 @@ The source of the geometry used when baking. See :ref:`SourceGeometryMode` **geometry/source_group_name** +- :ref:`String` **geometry_source_group_name** -+----------+------------------------------+ -| *Setter* | set_source_group_name(value) | -+----------+------------------------------+ -| *Getter* | get_source_group_name() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | ``"navmesh"`` | ++-----------+------------------------------+ +| *Setter* | set_source_group_name(value) | ++-----------+------------------------------+ +| *Getter* | get_source_group_name() | ++-----------+------------------------------+ The name of the group to scan for geometry. -Only used when :ref:`geometry/source_geometry_mode` is :ref:`SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN` or :ref:`SOURCE_GEOMETRY_GROUPS_EXPLICIT`. +Only used when :ref:`geometry_source_geometry_mode` is :ref:`SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN` or :ref:`SOURCE_GEOMETRY_GROUPS_EXPLICIT`. ---- -.. _class_NavigationMesh_property_polygon/verts_per_poly: +.. _class_NavigationMesh_property_polygon_verts_per_poly: -- :ref:`float` **polygon/verts_per_poly** +- :ref:`float` **polygon_verts_per_poly** +-----------+---------------------------+ | *Default* | ``6.0`` | @@ -459,9 +463,9 @@ The maximum number of vertices allowed for polygons generated during the contour ---- -.. _class_NavigationMesh_property_region/merge_size: +.. _class_NavigationMesh_property_region_merge_size: -- :ref:`float` **region/merge_size** +- :ref:`float` **region_merge_size** +-----------+------------------------------+ | *Default* | ``20.0`` | @@ -477,9 +481,9 @@ Any regions with a size smaller than this will be merged with larger regions if ---- -.. _class_NavigationMesh_property_region/min_size: +.. _class_NavigationMesh_property_region_min_size: -- :ref:`float` **region/min_size** +- :ref:`float` **region_min_size** +-----------+----------------------------+ | *Default* | ``2.0`` | @@ -495,9 +499,9 @@ The minimum size of a region for it to be created. ---- -.. _class_NavigationMesh_property_sample_partition_type/sample_partition_type: +.. _class_NavigationMesh_property_sample_partition_type: -- :ref:`SamplePartitionType` **sample_partition_type/sample_partition_type** +- :ref:`SamplePartitionType` **sample_partition_type** +-----------+----------------------------------+ | *Default* | ``0`` | @@ -540,7 +544,7 @@ Initializes the navigation mesh by setting the vertices and indices according to - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| -Returns whether the specified ``bit`` of the :ref:`geometry/collision_mask` is set. +Returns whether the specified ``bit`` of the :ref:`geometry_collision_mask` is set. ---- @@ -572,9 +576,9 @@ Returns a :ref:`PoolVector3Array` containing all the ver - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -If ``value`` is ``true``, sets the specified ``bit`` in the :ref:`geometry/collision_mask`. +If ``value`` is ``true``, sets the specified ``bit`` in the :ref:`geometry_collision_mask`. -If ``value`` is ``false``, clears the specified ``bit`` in the :ref:`geometry/collision_mask`. +If ``value`` is ``false``, clears the specified ``bit`` in the :ref:`geometry_collision_mask`. ---- diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 3432dedb6..d05785151 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -40,7 +40,7 @@ Method Descriptions - void **bake** **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** -Bakes navigation data to the provided ``nav_mesh`` by parsing child nodes under the provided ``root_node`` or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the :ref:`NavigationMesh.geometry/parsed_geometry_type` and :ref:`NavigationMesh.geometry/source_geometry_mode` properties on the :ref:`NavigationMesh` resource. +Bakes navigation data to the provided ``nav_mesh`` by parsing child nodes under the provided ``root_node`` or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the :ref:`NavigationMesh.geometry_parsed_geometry_type` and :ref:`NavigationMesh.geometry_source_geometry_mode` properties on the :ref:`NavigationMesh` resource. ---- diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 388982536..3f013baef 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -16,16 +16,34 @@ An instance of a :ref:`NavigationMesh`. Description ----------- -An instance of a :ref:`NavigationMesh`. It tells the :ref:`Navigation` node what can be navigated and what cannot, based on the :ref:`NavigationMesh` resource. This should be a child of a :ref:`Navigation` node. +An instance of a :ref:`NavigationMesh`. It tells the :ref:`Navigation` node what can be navigated and what cannot, based on the :ref:`NavigationMesh` resource. + +By default this node will register to the default :ref:`World` navigation map. If this node is a child of a :ref:`Navigation` node it will register to the navigation map of the navigation node. + +Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using :ref:`NavigationServer.map_set_edge_connection_margin`. + +\ **Note:** Overlapping two regions' navmeshes is not enough for connecting two regions. They must share a similar edge. + +The cost of entering this region from another region can be controlled with the :ref:`enter_cost` value. + +\ **Note**: This value is not added to the path cost when the start position is already inside this region. + +The cost of traveling distances inside this region can be controlled with the :ref:`travel_cost` multiplier. Properties ---------- -+---------------------------------------------+---------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`enabled` | ``true`` | -+---------------------------------------------+---------------------------------------------------------------+----------+ -| :ref:`NavigationMesh` | :ref:`navmesh` | | -+---------------------------------------------+---------------------------------------------------------------+----------+ ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`enter_cost` | ``0.0`` | ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`NavigationMesh` | :ref:`navmesh` | | ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`travel_cost` | ``1.0`` | ++---------------------------------------------+-----------------------------------------------------------------------------------+----------+ Methods ------- @@ -72,6 +90,38 @@ Determines if the ``NavigationMeshInstance`` is enabled or disabled. ---- +.. _class_NavigationMeshInstance_property_enter_cost: + +- :ref:`float` **enter_cost** + ++-----------+-----------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------+ +| *Setter* | set_enter_cost(value) | ++-----------+-----------------------+ +| *Getter* | get_enter_cost() | ++-----------+-----------------------+ + +When pathfinding enters this region's navmesh from another regions navmesh the ``enter_cost`` value is added to the path distance for determining the shortest path. + +---- + +.. _class_NavigationMeshInstance_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the :ref:`NavigationMesh` belongs to. On path requests with :ref:`NavigationServer.map_get_path` navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers. + +---- + .. _class_NavigationMeshInstance_property_navmesh: - :ref:`NavigationMesh` **navmesh** @@ -84,6 +134,22 @@ Determines if the ``NavigationMeshInstance`` is enabled or disabled. The :ref:`NavigationMesh` resource to use. +---- + +.. _class_NavigationMeshInstance_property_travel_cost: + +- :ref:`float` **travel_cost** + ++-----------+------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------+ +| *Setter* | set_travel_cost(value) | ++-----------+------------------------+ +| *Getter* | get_travel_cost() | ++-----------+------------------------+ + +When pathfinding moves inside this region's navmesh the traveled distances are multiplied with ``travel_cost`` for determining the shortest path. + Method Descriptions ------------------- diff --git a/classes/class_navigationobstacle.rst b/classes/class_navigationobstacle.rst index d8471c9d8..8f5655f92 100644 --- a/classes/class_navigationobstacle.rst +++ b/classes/class_navigationobstacle.rst @@ -18,6 +18,8 @@ Description 3D obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a :ref:`Navigation` node, or using :ref:`set_navigation`. ``NavigationObstacle`` is physics safe. +\ **Note:** Obstacles are intended as a last resort option for constantly moving objects that cannot be (re)baked to a navigation mesh efficiently. + Properties ---------- diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index 55af446d5..daefd8382 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -18,6 +18,8 @@ Description 2D obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a :ref:`Navigation2D` node, or using :ref:`set_navigation`. ``NavigationObstacle2D`` is physics safe. +\ **Note:** Obstacles are intended as a last resort option for constantly moving objects that cannot be (re)baked to a navigation mesh efficiently. + Properties ---------- diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 97aa13f0b..553ea64ea 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -58,6 +58,8 @@ Methods +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_mesh` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_outline_count` **(** **)** |const| | @@ -120,6 +122,14 @@ Clears the array of polygons, but it doesn't clear the array of outlines and ver ---- +.. _class_NavigationPolygon_method_get_mesh: + +- :ref:`NavigationMesh` **get_mesh** **(** **)** + +Returns the :ref:`NavigationMesh` resulting from this navigation polygon. This navmesh can be used to update the navmesh of a region with the :ref:`NavigationServer.region_set_navmesh` API directly (as 2D uses the 3D server behind the scene). + +---- + .. _class_NavigationPolygon_method_get_outline: - :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** |const| diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 752f937a4..7c972bb0b 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -11,16 +11,39 @@ NavigationPolygonInstance **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +A region of the 2D navigation map. +Description +----------- + +A region of the navigation map. It tells the :ref:`Navigation2DServer` what can be navigated and what cannot, based on its :ref:`NavigationPolygon` resource. + +By default this node will register to the default :ref:`World2D` navigation map. If this node is a child of a :ref:`Navigation2D` node it will register to the navigation map of the navigation node. + +Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using :ref:`Navigation2DServer.map_set_edge_connection_margin`. + +\ **Note:** Overlapping two regions' polygons is not enough for connecting two regions. They must share a similar edge. + +The pathfinding cost of entering this region from another region can be controlled with the :ref:`enter_cost` value. + +\ **Note**: This value is not added to the path cost when the start position is already inside this region. + +The pathfinding cost of traveling distances inside this region can be controlled with the :ref:`travel_cost` multiplier. Properties ---------- -+---------------------------------------------------+------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`enabled` | ``true`` | -+---------------------------------------------------+------------------------------------------------------------------+----------+ -| :ref:`NavigationPolygon` | :ref:`navpoly` | | -+---------------------------------------------------+------------------------------------------------------------------+----------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`enter_cost` | ``0.0`` | ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ +| :ref:`NavigationPolygon` | :ref:`navpoly` | | ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`travel_cost` | ``1.0`` | ++---------------------------------------------------+--------------------------------------------------------------------------------------+----------+ Methods ------- @@ -44,6 +67,40 @@ Property Descriptions | *Getter* | is_enabled() | +-----------+--------------------+ +Determines if the ``NavigationPolygonInstance`` is enabled or disabled. + +---- + +.. _class_NavigationPolygonInstance_property_enter_cost: + +- :ref:`float` **enter_cost** + ++-----------+-----------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------+ +| *Setter* | set_enter_cost(value) | ++-----------+-----------------------+ +| *Getter* | get_enter_cost() | ++-----------+-----------------------+ + +When pathfinding enters this region's navmesh from another regions navmesh the ``enter_cost`` value is added to the path distance for determining the shortest path. + +---- + +.. _class_NavigationPolygonInstance_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation map layers the :ref:`NavigationPolygon` belongs to. On path requests with :ref:`Navigation2DServer.map_get_path` navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers. + ---- .. _class_NavigationPolygonInstance_property_navpoly: @@ -56,6 +113,24 @@ Property Descriptions | *Getter* | get_navigation_polygon() | +----------+-------------------------------+ +The :ref:`NavigationPolygon` resource to use. + +---- + +.. _class_NavigationPolygonInstance_property_travel_cost: + +- :ref:`float` **travel_cost** + ++-----------+------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------+ +| *Setter* | set_travel_cost(value) | ++-----------+------------------------+ +| *Getter* | get_travel_cost() | ++-----------+------------------------+ + +When pathfinding moves inside this region's navmesh the traveled distances are multiplied with ``travel_cost`` for determining the shortest path. + Method Descriptions ------------------- diff --git a/classes/class_navigationserver.rst b/classes/class_navigationserver.rst index 0afcbb908..9f55afaf6 100644 --- a/classes/class_navigationserver.rst +++ b/classes/class_navigationserver.rst @@ -38,87 +38,114 @@ Tutorials Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`agent_create` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector3` position **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector3` target_velocity **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`map_create` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`map_get_cell_height` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_get_closest_point_normal` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_get_closest_point_to_segment` **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_get_up` **(** :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_cell_height` **(** :ref:`RID` map, :ref:`float` cell_height **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`map_set_up` **(** :ref:`RID` map, :ref:`Vector3` up **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process` **(** :ref:`float` delta_time **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_bake_navmesh` **(** :ref:`NavigationMesh` mesh, :ref:`Node` node **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`region_create` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_navmesh` **(** :ref:`RID` region, :ref:`NavigationMesh` nav_mesh **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform` transform **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_create` **(** **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector3` position **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector3` target_velocity **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_create` **(** **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_height` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point_normal` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point_to_segment` **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_up` **(** :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_height` **(** :ref:`RID` map, :ref:`float` cell_height **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_up` **(** :ref:`RID` map, :ref:`Vector3` up **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` delta_time **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_bake_navmesh` **(** :ref:`NavigationMesh` mesh, :ref:`Node` node **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_create` **(** **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navmesh` **(** :ref:`RID` region, :ref:`NavigationMesh` nav_mesh **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform` transform **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** |const| | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_NavigationServer_signal_map_changed: + +- **map_changed** **(** :ref:`RID` map **)** + +Emitted when a navigation map is updated, when a region moves or is modified. Method Descriptions ------------------- @@ -151,7 +178,9 @@ Returns ``true`` if the map got changed the previous frame. - void **agent_set_callback** **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** |const| -Callback called at the end of the RVO process. +Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated ``safe_velocity`` to the ``receiver`` object with a signal to the chosen ``method`` name. + +\ **Note:** Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use :ref:`agent_set_callback` again with a ``null`` object as the ``receiver``. ---- @@ -309,9 +338,9 @@ Returns the edge connection margin of the map. This distance is the minimum vert .. _class_NavigationServer_method_map_get_path: -- :ref:`PoolVector3Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize **)** |const| +- :ref:`PoolVector3Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| -Returns the navigation path to reach the destination from the origin. +Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region layers that are allowed to be in the path. ---- @@ -407,6 +436,38 @@ Creates a new region. ---- +.. _class_NavigationServer_method_region_get_connection_pathway_end: + +- :ref:`Vector3` **region_get_connection_pathway_end** **(** :ref:`RID` region, :ref:`int` connection **)** |const| + +Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. + +---- + +.. _class_NavigationServer_method_region_get_connection_pathway_start: + +- :ref:`Vector3` **region_get_connection_pathway_start** **(** :ref:`RID` region, :ref:`int` connection **)** |const| + +Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. + +---- + +.. _class_NavigationServer_method_region_get_connections_count: + +- :ref:`int` **region_get_connections_count** **(** :ref:`RID` region **)** |const| + +Returns how many connections this ``region`` has with other regions in the map. + +---- + +.. _class_NavigationServer_method_region_get_enter_cost: + +- :ref:`float` **region_get_enter_cost** **(** :ref:`RID` region **)** |const| + +Returns the ``enter_cost`` of this ``region``. + +---- + .. _class_NavigationServer_method_region_get_map: - :ref:`RID` **region_get_map** **(** :ref:`RID` region **)** |const| @@ -415,6 +476,30 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur ---- +.. _class_NavigationServer_method_region_get_navigation_layers: + +- :ref:`int` **region_get_navigation_layers** **(** :ref:`RID` region **)** |const| + +Returns the region's navigation layers. + +---- + +.. _class_NavigationServer_method_region_get_travel_cost: + +- :ref:`float` **region_get_travel_cost** **(** :ref:`RID` region **)** |const| + +Returns the ``travel_cost`` of this ``region``. + +---- + +.. _class_NavigationServer_method_region_set_enter_cost: + +- void **region_set_enter_cost** **(** :ref:`RID` region, :ref:`float` enter_cost **)** |const| + +Sets the ``enter_cost`` for this ``region``. + +---- + .. _class_NavigationServer_method_region_set_map: - void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** |const| @@ -423,6 +508,14 @@ Sets the map for the region. ---- +.. _class_NavigationServer_method_region_set_navigation_layers: + +- void **region_set_navigation_layers** **(** :ref:`RID` region, :ref:`int` navigation_layers **)** |const| + +Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). + +---- + .. _class_NavigationServer_method_region_set_navmesh: - void **region_set_navmesh** **(** :ref:`RID` region, :ref:`NavigationMesh` nav_mesh **)** |const| @@ -439,6 +532,14 @@ Sets the global transformation for the region. ---- +.. _class_NavigationServer_method_region_set_travel_cost: + +- void **region_set_travel_cost** **(** :ref:`RID` region, :ref:`float` travel_cost **)** |const| + +Sets the ``travel_cost`` for this ``region``. + +---- + .. _class_NavigationServer_method_set_active: - void **set_active** **(** :ref:`bool` active **)** |const| diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index f28755c3e..361e3d02e 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -218,6 +218,8 @@ Rotation in degrees, relative to the node's parent. The node's scale. Unscaled value: ``(1, 1)``. +\ **Note:** Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. + ---- .. _class_Node2D_property_transform: diff --git a/classes/class_os.rst b/classes/class_os.rst index a3e4e9a7b..1f648ef2f 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1970,8 +1970,15 @@ Kill (terminate) the process identified by the given process ID (``pid``), e.g. Moves the file or directory to the system's recycle bin. See also :ref:`Directory.remove`. +The method takes only global paths, so you may need to use :ref:`ProjectSettings.globalize_path`. Do not use it for files in ``res://`` as it will not work in exported project. + \ **Note:** If the user has disabled the recycle bin on their system, the file will be permanently deleted instead. +:: + + var file_to_remove = "user://slot1.sav" + OS.move_to_trash(ProjectSettings.globalize_path(file_to_remove)) + ---- .. _class_OS_method_move_window_to_foreground: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 293dda1f9..c6f53112f 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -36,851 +36,997 @@ Tutorials Properties ---------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`android/modules` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color( 0.14, 0.14, 0.14, 1 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/description` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/icon` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/name` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/delta_smoothing` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/delta_sync_after_draw` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/run/main_scene` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | ``-60.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_time` | ``2.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/default_bus_layout` | ``"res://default_bus_layout.tres"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/driver` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/mix_rate.web` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/output_latency` | ``15`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/output_latency.web` | ``50`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/export_hint_type_mistmatch` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug on https://github.com/godotengine/godot/issues"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/physics_interpolation/enable_warnings` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color( 1, 0.2, 0.1, 0.8 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.42 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/disabled_geometry_color` | ``Color( 1, 0.7, 0.1, 0.4 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_color` | ``Color( 0.1, 1, 0.7, 0.4 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2( 0, 0 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2( 10, 10 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/window/handheld/orientation` | ``"landscape"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/height` | ``600`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_height` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_width` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/width` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/window/tablet_driver` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/main_run_args` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | ``PoolStringArray( "gd", "gdshader", "shader" )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor/version_control/autoload_on_startup` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/version_control/plugin_name` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/drop_mouse_on_gui_input_disabled` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/theme/use_hidpi` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_accept` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_cancel` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_down` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_end` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_next` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_home` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_left` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_down` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_up` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_right` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_select` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_up` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`input_devices/pointing/ios/touch_delay` | ``0.15`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/fallback` | ``"en"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/test` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging.pc` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/godot.log"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``5`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/command_queue/multithreading_queue_size_kb` | ``256`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/debugger_agent/port` | ``23685`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | ``3000`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`mono/profiler/args` | ``"log:calls,alloc,sample,output=output.mlpd"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mono/profiler/enabled` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/runtime/unhandled_exception_policy` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | ``2048`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_second` | ``100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | ``10`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_warnings_per_second` | ``100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`network/ssl/certificates` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_casing` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_num_separator` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/bp_hash_table_size` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/bvh_collision_margin` | ``1.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/cell_size` | ``128`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/default_gravity` | ``98`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2( 0, 1 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/large_object_surface_threshold_in_cells` | ``512`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/thread_model` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/2d/use_bvh` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/active_soft_world` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3( 0, -1, 0 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/godot_physics/bvh_collision_margin` | ``0.1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/godot_physics/use_bvh` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/smooth_trimesh_collision` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/common/enable_pause_aware_picking` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/common/physics_interpolation` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/opengl/batching_send_null` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/opengl/batching_stream` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/opengl/legacy_orphan_buffers` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/opengl/legacy_stream` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/options/ninepatch_mode` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/2d/options/use_nvidia_rect_flicker_workaround` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/2d/options/use_software_skinning` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/2d/snapping/use_gpu_pixel_snap` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/debug/diagnose_frame` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/debug/flash_batching` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/batching/lights/max_join_items` | ``32`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/batching/lights/scissor_area_threshold` | ``1.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/options/single_rect_fallback` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/options/use_batching` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/options/use_batching_in_editor` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/batching/parameters/batch_buffer_size` | ``16384`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/batching/parameters/colored_vertex_format_threshold` | ``0.25`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/batching/parameters/item_reordering_lookahead` | ``4`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/batching/parameters/max_join_item_commands` | ``16`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/batching/precision/uv_contract` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/batching/precision/uv_contract_amount` | ``100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/high_quality_ray_count` | ``512`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/low_quality_ray_count` | ``64`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/medium_quality_ray_count` | ``256`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/ultra_quality_ray_count` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float.iOS` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/gles2/compatibility/enable_high_float.Android` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/gles3/shaders/log_active_async_compiles_count` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles` | ``2`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.mobile` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb` | ``512`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.mobile` | ``128`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.mobile` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | ``128`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | ``128`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | ``2048`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_lights_per_object` | ``32`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ``65536`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_lights` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_reflections` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/misc/lossless_compression/force_png` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/misc/lossless_compression/webp_compression_level` | ``2`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/misc/mesh_storage/split_stream` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_polygons` | ``8`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_spheres` | ``8`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/advanced/flip_imported_portals` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/debug/logging` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/gameplay/use_signals` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/optimize/remove_danglers` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/pvs/pvs_logging` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/portals/pvs/use_simple_pvs` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth/hdr` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth/hdr.mobile` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth/use_32_bpc_depth` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | ``2048`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | ``"GLES3"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | ``4`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/filters/msaa` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/quality/filters/sharpen_intensity` | ``0.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/filters/use_debanding` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/filters/use_fxaa` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ``2`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ``3`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling.mobile` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/reflections/atlas_size` | ``2048`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/reflections/atlas_subdiv` | ``8`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/reflections/irradiance_max_size` | ``128`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/use_physical_light_attenuation` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/cubemap_size` | ``512`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | ``2`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | ``3`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | ``4`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | ``4096`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | ``2048`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/skinning/force_software_skinning` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/skinning/software_skinning_fallback` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/quality/spatial_partitioning/bvh_collision_margin` | ``0.1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/quality/spatial_partitioning/render_tree_balance` | ``0.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/spatial_partitioning/use_bvh` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | ``1.0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/threads/thread_model` | ``1`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/threads/thread_safe_bvh` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`world/2d/cell_size` | ``100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`android/modules` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color( 0.14, 0.14, 0.14, 1 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/description` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/icon` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/name` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/delta_smoothing` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/delta_sync_after_draw` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/run/main_scene` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | ``-60.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_time` | ``2.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/default_bus_layout` | ``"res://default_bus_layout.tres"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/driver` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/mix_rate.web` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/output_latency` | ``15`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/output_latency.web` | ``50`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/export_hint_type_mistmatch` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug to the project developer."`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/physics_interpolation/enable_warnings` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color( 1, 0.2, 0.1, 0.8 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.42 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/disabled_geometry_color` | ``Color( 1, 0.7, 0.1, 0.4 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_color` | ``Color( 0.1, 1, 0.7, 0.4 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2( 0, 0 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2( 10, 10 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/window/handheld/orientation` | ``"landscape"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/height` | ``600`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_height` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_width` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/width` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/window/tablet_driver` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/main_run_args` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/scene_naming` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | ``PoolStringArray( "gd", "gdshader", "shader" )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor/version_control_autoload_on_startup` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/version_control_plugin_name` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/drop_mouse_on_gui_input_disabled` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/theme/use_hidpi` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_accept` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_cancel` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_down` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_end` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_next` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_home` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_left` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_down` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_up` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_right` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_select` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_up` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`input_devices/pointing/ios/touch_delay` | ``0.15`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_21` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_22` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_23` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_24` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_25` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_26` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_27` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_28` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_29` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_30` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_31` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_32` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_21` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_22` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_23` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_24` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_25` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_26` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_27` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_28` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_29` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_30` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_31` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_32` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/fallback` | ``"en"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/test` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging.pc` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/godot.log"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``5`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/command_queue/multithreading_queue_size_kb` | ``256`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mono/debugger_agent/port` | ``23685`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | ``3000`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`mono/profiler/args` | ``"log:calls,alloc,sample,output=output.mlpd"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`mono/profiler/enabled` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mono/runtime/unhandled_exception_policy` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/2d/default_cell_height` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/2d/default_cell_size` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/2d/default_edge_connection_margin` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_cell_height` | ``0.25`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_edge_connection_margin` | ``0.25`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`navigation/3d/default_map_up` | ``Vector3( 0, 1, 0 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | ``2048`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_second` | ``100`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | ``10`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_warnings_per_second` | ``100`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`network/ssl/certificates` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_casing` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_num_separator` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/bp_hash_table_size` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/bvh_collision_margin` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/cell_size` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/default_gravity` | ``98`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2( 0, 1 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/large_object_surface_threshold_in_cells` | ``512`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/thread_model` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/2d/use_bvh` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/active_soft_world` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3( 0, -1, 0 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/godot_physics/bvh_collision_margin` | ``0.1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/godot_physics/use_bvh` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/smooth_trimesh_collision` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/common/enable_pause_aware_picking` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/common/physics_interpolation` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/batching_send_null` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/batching_stream` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/legacy_orphan_buffers` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/legacy_stream` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/options/ninepatch_mode` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/options/use_nvidia_rect_flicker_workaround` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/options/use_software_skinning` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/snapping/use_gpu_pixel_snap` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/debug/diagnose_frame` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/debug/flash_batching` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/lights/max_join_items` | ``32`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/batching/lights/scissor_area_threshold` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/single_rect_fallback` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/use_batching` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/use_batching_in_editor` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/batch_buffer_size` | ``16384`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/batching/parameters/colored_vertex_format_threshold` | ``0.25`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/item_reordering_lookahead` | ``4`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/max_join_item_commands` | ``16`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/precision/uv_contract` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/precision/uv_contract_amount` | ``100`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/high_quality_ray_count` | ``512`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/low_quality_ray_count` | ``64`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/medium_quality_ray_count` | ``256`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/ultra_quality_ray_count` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float.iOS` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles2/compatibility/enable_high_float.Android` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles3/shaders/log_active_async_compiles_count` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles` | ``2`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.mobile` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb` | ``512`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.mobile` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode` | ``2`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.mobile` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | ``2048`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_lights_per_object` | ``32`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ``65536`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_lights` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_reflections` | ``1024`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/misc/lossless_compression/force_png` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/misc/lossless_compression/webp_compression_level` | ``2`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/misc/mesh_storage/split_stream` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_polygons` | ``8`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_spheres` | ``8`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/advanced/flip_imported_portals` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/debug/logging` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/gameplay/use_signals` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/optimize/remove_danglers` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/pvs/pvs_logging` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/portals/pvs/use_simple_pvs` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth/hdr` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth/hdr.mobile` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth/use_32_bpc_depth` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | ``2048`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | ``"GLES3"`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | ``4`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/msaa` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/quality/filters/sharpen_intensity` | ``0.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_debanding` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_fxaa` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ``2`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ``3`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling.mobile` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/atlas_size` | ``2048`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/atlas_subdiv` | ``8`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/irradiance_max_size` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/use_physical_light_attenuation` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/cubemap_size` | ``512`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | ``2`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | ``3`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | ``4`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | ``4096`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | ``2048`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | ``0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/skinning/force_software_skinning` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/skinning/software_skinning_fallback` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/quality/spatial_partitioning/bvh_collision_margin` | ``0.1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/quality/spatial_partitioning/render_tree_balance` | ``0.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/spatial_partitioning/use_bvh` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | ``1.0`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/threads/thread_model` | ``1`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/threads/thread_safe_bvh` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | ``false`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | ``true`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`world/2d/cell_size` | ``100`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ Methods ------- @@ -1829,11 +1975,23 @@ If ``true``, enables warnings when assigning the result of a function that retur - :ref:`String` **debug/settings/crash_handler/message** -+-----------+-------------------------------------------------------------------------------------------------+ -| *Default* | ``"Please include this when reporting the bug on https://github.com/godotengine/godot/issues"`` | -+-----------+-------------------------------------------------------------------------------------------------+ ++-----------+----------------------------------------------------------------------------+ +| *Default* | ``"Please include this when reporting the bug to the project developer."`` | ++-----------+----------------------------------------------------------------------------+ -Message to be displayed before the backtrace when the engine crashes. +Message to be displayed before the backtrace when the engine crashes. By default, this message is only used in exported projects due to the editor-only override applied to this setting. + +---- + +.. _class_ProjectSettings_property_debug/settings/crash_handler/message.editor: + +- :ref:`String` **debug/settings/crash_handler/message.editor** + ++-----------+--------------------------------------------------------------------------------------------------+ +| *Default* | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | ++-----------+--------------------------------------------------------------------------------------------------+ + +Editor-only override for :ref:`debug/settings/crash_handler/message`. Does not affect exported projects in debug or release mode. ---- @@ -2279,6 +2437,24 @@ For example, this can be used to force the project to run on the dedicated GPU i ---- +.. _class_ProjectSettings_property_editor/scene_naming: + +- :ref:`int` **editor/scene_naming** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +Default naming style for scene files to infer from their root nodes. Possible options are: + +- ``0`` (Auto): Uses the scene root name as is without changing its casing. + +- ``1`` (PascalCase): Converts the scene root name to PascalCase casing. + +- ``2`` (snake_case): Converts the scene root name to snake_case casing. + +---- + .. _class_ProjectSettings_property_editor/script_templates_search_path: - :ref:`String` **editor/script_templates_search_path** @@ -2303,9 +2479,9 @@ Text-based file extensions to include in the script editor's "Find in Files" fea ---- -.. _class_ProjectSettings_property_editor/version_control/autoload_on_startup: +.. _class_ProjectSettings_property_editor/version_control_autoload_on_startup: -- :ref:`bool` **editor/version_control/autoload_on_startup** +- :ref:`bool` **editor/version_control_autoload_on_startup** +-----------+-----------+ | *Default* | ``false`` | @@ -2315,9 +2491,9 @@ Load the previously opened VCS plugin when the editor starts up. This is set to ---- -.. _class_ProjectSettings_property_editor/version_control/plugin_name: +.. _class_ProjectSettings_property_editor/version_control_plugin_name: -- :ref:`String` **editor/version_control/plugin_name** +- :ref:`String` **editor/version_control_plugin_name** +-----------+--------+ | *Default* | ``""`` | @@ -2631,6 +2807,390 @@ Default delay for touch events. This only affects iOS devices. ---- +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_1: + +- :ref:`String` **layer_names/2d_navigation/layer_1** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 1. If left empty, the layer will display as "Layer 1". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_10: + +- :ref:`String` **layer_names/2d_navigation/layer_10** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 10. If left empty, the layer will display as "Layer 10". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_11: + +- :ref:`String` **layer_names/2d_navigation/layer_11** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 11. If left empty, the layer will display as "Layer 11". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_12: + +- :ref:`String` **layer_names/2d_navigation/layer_12** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 12. If left empty, the layer will display as "Layer 12". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_13: + +- :ref:`String` **layer_names/2d_navigation/layer_13** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 13. If left empty, the layer will display as "Layer 13". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_14: + +- :ref:`String` **layer_names/2d_navigation/layer_14** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 14. If left empty, the layer will display as "Layer 14". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_15: + +- :ref:`String` **layer_names/2d_navigation/layer_15** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 15. If left empty, the layer will display as "Layer 15". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_16: + +- :ref:`String` **layer_names/2d_navigation/layer_16** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 16. If left empty, the layer will display as "Layer 16". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_17: + +- :ref:`String` **layer_names/2d_navigation/layer_17** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 17. If left empty, the layer will display as "Layer 17". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_18: + +- :ref:`String` **layer_names/2d_navigation/layer_18** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 18. If left empty, the layer will display as "Layer 18". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_19: + +- :ref:`String` **layer_names/2d_navigation/layer_19** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 19. If left empty, the layer will display as "Layer 19". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_2: + +- :ref:`String` **layer_names/2d_navigation/layer_2** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 2. If left empty, the layer will display as "Layer 2". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_20: + +- :ref:`String` **layer_names/2d_navigation/layer_20** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 20. If left empty, the layer will display as "Layer 20". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_21: + +- :ref:`String` **layer_names/2d_navigation/layer_21** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 21. If left empty, the layer will display as "Layer 21". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_22: + +- :ref:`String` **layer_names/2d_navigation/layer_22** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 22. If left empty, the layer will display as "Layer 22". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_23: + +- :ref:`String` **layer_names/2d_navigation/layer_23** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 23. If left empty, the layer will display as "Layer 23". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_24: + +- :ref:`String` **layer_names/2d_navigation/layer_24** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 24. If left empty, the layer will display as "Layer 24". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_25: + +- :ref:`String` **layer_names/2d_navigation/layer_25** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 25. If left empty, the layer will display as "Layer 25". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_26: + +- :ref:`String` **layer_names/2d_navigation/layer_26** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 26. If left empty, the layer will display as "Layer 26". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_27: + +- :ref:`String` **layer_names/2d_navigation/layer_27** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 27. If left empty, the layer will display as "Layer 27". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_28: + +- :ref:`String` **layer_names/2d_navigation/layer_28** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 28. If left empty, the layer will display as "Layer 28". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_29: + +- :ref:`String` **layer_names/2d_navigation/layer_29** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 29. If left empty, the layer will display as "Layer 29". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_3: + +- :ref:`String` **layer_names/2d_navigation/layer_3** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 3. If left empty, the layer will display as "Layer 3". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_30: + +- :ref:`String` **layer_names/2d_navigation/layer_30** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 30. If left empty, the layer will display as "Layer 30". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_31: + +- :ref:`String` **layer_names/2d_navigation/layer_31** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 31. If left empty, the layer will display as "Layer 31". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_32: + +- :ref:`String` **layer_names/2d_navigation/layer_32** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 32. If left empty, the layer will display as "Layer 32". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_4: + +- :ref:`String` **layer_names/2d_navigation/layer_4** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 4. If left empty, the layer will display as "Layer 4". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_5: + +- :ref:`String` **layer_names/2d_navigation/layer_5** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 5. If left empty, the layer will display as "Layer 5". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_6: + +- :ref:`String` **layer_names/2d_navigation/layer_6** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 6. If left empty, the layer will display as "Layer 6". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_7: + +- :ref:`String` **layer_names/2d_navigation/layer_7** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 7. If left empty, the layer will display as "Layer 7". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_8: + +- :ref:`String` **layer_names/2d_navigation/layer_8** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 8. If left empty, the layer will display as "Layer 8". + +---- + +.. _class_ProjectSettings_property_layer_names/2d_navigation/layer_9: + +- :ref:`String` **layer_names/2d_navigation/layer_9** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 2D navigation layer 9. If left empty, the layer will display as "Layer 9". + +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_1: - :ref:`String` **layer_names/2d_physics/layer_1** @@ -3255,6 +3815,390 @@ Optional name for the 2D render layer 9. ---- +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_1: + +- :ref:`String` **layer_names/3d_navigation/layer_1** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 1. If left empty, the layer will display as "Layer 1". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_10: + +- :ref:`String` **layer_names/3d_navigation/layer_10** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 10. If left empty, the layer will display as "Layer 10". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_11: + +- :ref:`String` **layer_names/3d_navigation/layer_11** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 11. If left empty, the layer will display as "Layer 11". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_12: + +- :ref:`String` **layer_names/3d_navigation/layer_12** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 12. If left empty, the layer will display as "Layer 12". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_13: + +- :ref:`String` **layer_names/3d_navigation/layer_13** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 13. If left empty, the layer will display as "Layer 13". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_14: + +- :ref:`String` **layer_names/3d_navigation/layer_14** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 14. If left empty, the layer will display as "Layer 14". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_15: + +- :ref:`String` **layer_names/3d_navigation/layer_15** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 15. If left empty, the layer will display as "Layer 15". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_16: + +- :ref:`String` **layer_names/3d_navigation/layer_16** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 16. If left empty, the layer will display as "Layer 16". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_17: + +- :ref:`String` **layer_names/3d_navigation/layer_17** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 17. If left empty, the layer will display as "Layer 17". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_18: + +- :ref:`String` **layer_names/3d_navigation/layer_18** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 18. If left empty, the layer will display as "Layer 18". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_19: + +- :ref:`String` **layer_names/3d_navigation/layer_19** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 19. If left empty, the layer will display as "Layer 19". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_2: + +- :ref:`String` **layer_names/3d_navigation/layer_2** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 2. If left empty, the layer will display as "Layer 2". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_20: + +- :ref:`String` **layer_names/3d_navigation/layer_20** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 20. If left empty, the layer will display as "Layer 20". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_21: + +- :ref:`String` **layer_names/3d_navigation/layer_21** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 21. If left empty, the layer will display as "Layer 21". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_22: + +- :ref:`String` **layer_names/3d_navigation/layer_22** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 22. If left empty, the layer will display as "Layer 22". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_23: + +- :ref:`String` **layer_names/3d_navigation/layer_23** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 23. If left empty, the layer will display as "Layer 23". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_24: + +- :ref:`String` **layer_names/3d_navigation/layer_24** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 24. If left empty, the layer will display as "Layer 24". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_25: + +- :ref:`String` **layer_names/3d_navigation/layer_25** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 25. If left empty, the layer will display as "Layer 25". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_26: + +- :ref:`String` **layer_names/3d_navigation/layer_26** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 26. If left empty, the layer will display as "Layer 26". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_27: + +- :ref:`String` **layer_names/3d_navigation/layer_27** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 27. If left empty, the layer will display as "Layer 27". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_28: + +- :ref:`String` **layer_names/3d_navigation/layer_28** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 28. If left empty, the layer will display as "Layer 28". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_29: + +- :ref:`String` **layer_names/3d_navigation/layer_29** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 29. If left empty, the layer will display as "Layer 29". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_3: + +- :ref:`String` **layer_names/3d_navigation/layer_3** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 3. If left empty, the layer will display as "Layer 3". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_30: + +- :ref:`String` **layer_names/3d_navigation/layer_30** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 30. If left empty, the layer will display as "Layer 30". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_31: + +- :ref:`String` **layer_names/3d_navigation/layer_31** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 31. If left empty, the layer will display as "Layer 31". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_32: + +- :ref:`String` **layer_names/3d_navigation/layer_32** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 32. If left empty, the layer will display as "Layer 32". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_4: + +- :ref:`String` **layer_names/3d_navigation/layer_4** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 4. If left empty, the layer will display as "Layer 4". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_5: + +- :ref:`String` **layer_names/3d_navigation/layer_5** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 5. If left empty, the layer will display as "Layer 5". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_6: + +- :ref:`String` **layer_names/3d_navigation/layer_6** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 6. If left empty, the layer will display as "Layer 6". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_7: + +- :ref:`String` **layer_names/3d_navigation/layer_7** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 7. If left empty, the layer will display as "Layer 7". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_8: + +- :ref:`String` **layer_names/3d_navigation/layer_8** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 8. If left empty, the layer will display as "Layer 8". + +---- + +.. _class_ProjectSettings_property_layer_names/3d_navigation/layer_9: + +- :ref:`String` **layer_names/3d_navigation/layer_9** + ++-----------+--------+ +| *Default* | ``""`` | ++-----------+--------+ + +Optional name for the 3D navigation layer 9. If left empty, the layer will display as "Layer 9". + +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_1: - :ref:`String` **layer_names/3d_physics/layer_1** @@ -4049,6 +4993,92 @@ The policy to use for unhandled Mono (C#) exceptions. The default "Terminate App ---- +.. _class_ProjectSettings_property_navigation/2d/default_cell_height: + +- :ref:`float` **navigation/2d/default_cell_height** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +Default cell height for 2D navigation maps. See :ref:`Navigation2DServer.map_set_cell_height`. + +\ **Note:** Currently not implemented. + +---- + +.. _class_ProjectSettings_property_navigation/2d/default_cell_size: + +- :ref:`float` **navigation/2d/default_cell_size** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +Default cell size for 2D navigation maps. See :ref:`Navigation2DServer.map_set_cell_size`. + +---- + +.. _class_ProjectSettings_property_navigation/2d/default_edge_connection_margin: + +- :ref:`float` **navigation/2d/default_edge_connection_margin** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +Default edge connection margin for 2D navigation maps. See :ref:`Navigation2DServer.map_set_edge_connection_margin`. + +---- + +.. _class_ProjectSettings_property_navigation/3d/default_cell_height: + +- :ref:`float` **navigation/3d/default_cell_height** + ++-----------+----------+ +| *Default* | ``0.25`` | ++-----------+----------+ + +Default cell height for 3D navigation maps. See :ref:`NavigationServer.map_set_cell_height`. + +---- + +.. _class_ProjectSettings_property_navigation/3d/default_cell_size: + +- :ref:`float` **navigation/3d/default_cell_size** + ++-----------+----------+ +| *Default* | ``0.25`` | ++-----------+----------+ + +Default cell size for 3D navigation maps. See :ref:`NavigationServer.map_set_cell_size`. + +---- + +.. _class_ProjectSettings_property_navigation/3d/default_edge_connection_margin: + +- :ref:`float` **navigation/3d/default_edge_connection_margin** + ++-----------+----------+ +| *Default* | ``0.25`` | ++-----------+----------+ + +Default edge connection margin for 3D navigation maps. See :ref:`NavigationServer.map_set_edge_connection_margin`. + +---- + +.. _class_ProjectSettings_property_navigation/3d/default_map_up: + +- :ref:`Vector3` **navigation/3d/default_map_up** + ++-----------+------------------------+ +| *Default* | ``Vector3( 0, 1, 0 )`` | ++-----------+------------------------+ + +Default map up vector for 3D navigation maps. See :ref:`NavigationServer.map_set_up`. + +---- + .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** @@ -5176,7 +6206,7 @@ An override for ``rendering/gles3/shaders/ubershader_cache_size_mb``, so a small - :ref:`int` **rendering/gles3/shaders/shader_compilation_mode** +-----------+-------+ -| *Default* | ``0`` | +| *Default* | ``2`` | +-----------+-------+ If set to ``Asynchronous`` and available on the target device, asynchronous compilation of shaders is enabled (in contrast to ``Asynchronous``). diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 600ab87ba..ed42d5bab 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -49,7 +49,6 @@ There are 3 caveats to keep in mind when using ``ProximityGroup``: - If your :ref:`grid_radius` is smaller than ``Vector3(1, 1, 1)``, it will be rounded up to ``Vector3(1, 1, 1)``. Therefore, small grid radius values may lead to unwanted groupings. - \ **Note:** ``ProximityGroup`` will be removed in Godot 4.0 in favor of more effective and faster :ref:`VisibilityNotifier` functionality. For most use cases, :ref:`Vector3.distance_to` or :ref:`Vector3.distance_squared_to` are fast enough too, especially if you call them less often using a :ref:`Timer` node. Properties diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 17b2a898d..d148ab934 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -75,75 +75,75 @@ Properties Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0 **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_content_height` **(** **)** |const| | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selected_text` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`newline` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PoolStringArray` expressions **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_align` **(** :ref:`Align` align **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_bold` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_bold_italics` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_cell` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_color` **(** :ref:`Color` color **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font` **(** :ref:`Font` font **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_indent` **(** :ref:`int` level **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_italics` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`ListType` type **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_mono` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_normal` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_strikethrough` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_table` **(** :ref:`int` columns **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_underline` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_image` **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`InlineAlign` align=2 **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_text` **(** :ref:`String` text **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_content_height` **(** **)** |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selected_text` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`newline` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PoolStringArray` expressions **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_align` **(** :ref:`Align` align **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_bold` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_bold_italics` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_cell` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_color` **(** :ref:`Color` color **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font` **(** :ref:`Font` font **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_indent` **(** :ref:`int` level **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_italics` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_list` **(** :ref:`ListType` type **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_mono` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_normal` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_strikethrough` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_table` **(** :ref:`int` columns **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_underline` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -234,6 +234,28 @@ enum **Align**: ---- +.. _enum_RichTextLabel_InlineAlign: + +.. _class_RichTextLabel_constant_INLINE_ALIGN_TOP: + +.. _class_RichTextLabel_constant_INLINE_ALIGN_CENTER: + +.. _class_RichTextLabel_constant_INLINE_ALIGN_BASELINE: + +.. _class_RichTextLabel_constant_INLINE_ALIGN_BOTTOM: + +enum **InlineAlign**: + +- **INLINE_ALIGN_TOP** = **0** --- Aligns top of the inline image to the top of the text. + +- **INLINE_ALIGN_CENTER** = **1** --- Aligns center of the inline image to the center of the text. + +- **INLINE_ALIGN_BASELINE** = **2** --- Aligns bottom of the inline image to the baseline of the text. + +- **INLINE_ALIGN_BOTTOM** = **3** --- Aligns bottom of the inline image to the bottom of the text. + +---- + .. _enum_RichTextLabel_ListType: .. _class_RichTextLabel_constant_LIST_NUMBERS: @@ -576,7 +598,7 @@ Method Descriptions .. _class_RichTextLabel_method_add_image: -- void **add_image** **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0 **)** +- void **add_image** **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`InlineAlign` align=2 **)** Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image. diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index ee2cdb4d7..7e88ea5fe 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -27,7 +27,7 @@ As opposed to :ref:`Timer`, it does not require the instantiation o yield(get_tree().create_timer(1.0), "timeout") print("Timer ended.") -The timer will be automatically freed after its time elapses, so be aware that any reference you might have kept to it will become invalid. +The timer will be dereferenced after its time elapses. To preserve the timer, you can keep a reference to it. See :ref:`Reference`. Properties ---------- diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index b601cb3ba..d26fc3472 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -256,6 +256,8 @@ Rotation part of the local transformation in degrees, specified in terms of YXZ- Scale part of the local transformation. +\ **Note:** Mixed negative scales in 3D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, the scale values will either be all positive or all negative. + ---- .. _class_Spatial_property_transform: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index a740423b7..5cd837f4f 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -40,6 +40,8 @@ Tutorials Properties ---------- ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ +| :ref:`bool` | :ref:`bake_navigation` | ``false`` | +--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | :ref:`cell_clip_uv` | ``false`` | +--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ @@ -73,6 +75,8 @@ Properties +--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ | :ref:`Mode` | :ref:`mode` | ``0`` | +--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ | :ref:`int` | :ref:`occluder_light_mask` | ``1`` | +--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | :ref:`show_collision` | ``false`` | @@ -211,6 +215,22 @@ Constants Property Descriptions --------------------- +.. _class_TileMap_property_bake_navigation: + +- :ref:`bool` **bake_navigation** + ++-----------+----------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------+ +| *Setter* | set_bake_navigation(value) | ++-----------+----------------------------+ +| *Getter* | is_baking_navigation() | ++-----------+----------------------------+ + +If ``true``, this TileMap bakes a navigation region. + +---- + .. _class_TileMap_property_cell_clip_uv: - :ref:`bool` **cell_clip_uv** @@ -473,6 +493,22 @@ The TileMap orientation mode. See :ref:`Mode` for possible va ---- +.. _class_TileMap_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +The navigation layers the TileMap generates its navigation regions in. + +---- + .. _class_TileMap_property_occluder_light_mask: - :ref:`int` **occluder_light_mask** diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 135bb904f..1c829952f 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -254,6 +254,8 @@ Returns a copy of the transform rotated by the given ``angle`` (in radians), usi Returns a copy of the transform scaled by the given ``scale`` factor, using matrix multiplication. +\ **Note:** Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. + ---- .. _class_Transform2D_method_translated: diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 29ecb5dc6..2fd12af9b 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -77,9 +77,9 @@ enum **Enabler**: - **ENABLER_PAUSE_PARTICLES** = **2** --- This enabler will stop :ref:`Particles2D` nodes. -- **ENABLER_PARENT_PROCESS** = **3** --- This enabler will stop the parent's _process function. +- **ENABLER_PARENT_PROCESS** = **3** --- This enabler will stop the parent's :ref:`Node._process` function. -- **ENABLER_PARENT_PHYSICS_PROCESS** = **4** --- This enabler will stop the parent's _physics_process function. +- **ENABLER_PARENT_PHYSICS_PROCESS** = **4** --- This enabler will stop the parent's :ref:`Node._physics_process` function. - **ENABLER_PAUSE_ANIMATED_SPRITES** = **5** --- This enabler will stop :ref:`AnimatedSprite` nodes animations. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index d6ee7352a..8d4b75722 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -27,9 +27,11 @@ If you want nodes to be disabled automatically when they exit the screen, use :r Properties ---------- -+-------------------------+-----------------------------------------------------+---------------------------------+ -| :ref:`AABB` | :ref:`aabb` | ``AABB( -1, -1, -1, 2, 2, 2 )`` | -+-------------------------+-----------------------------------------------------+---------------------------------+ ++---------------------------+---------------------------------------------------------------------+---------------------------------+ +| :ref:`AABB` | :ref:`aabb` | ``AABB( -1, -1, -1, 2, 2, 2 )`` | ++---------------------------+---------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`max_distance` | ``0.0`` | ++---------------------------+---------------------------------------------------------------------+---------------------------------+ Methods ------- @@ -88,6 +90,24 @@ Property Descriptions The VisibilityNotifier's bounding box. +---- + +.. _class_VisibilityNotifier_property_max_distance: + +- :ref:`float` **max_distance** + ++-----------+-------------------------+ +| *Default* | ``0.0`` | ++-----------+-------------------------+ +| *Setter* | set_max_distance(value) | ++-----------+-------------------------+ +| *Getter* | get_max_distance() | ++-----------+-------------------------+ + +In addition to checking whether a node is on screen or within a :ref:`Camera`'s view, VisibilityNotifier can also optionally check whether a node is within a specified maximum distance when using a :ref:`Camera` with perspective projection. This is useful for throttling the performance requirements of nodes that are far away. + +\ **Note:** This feature will be disabled if set to 0.0. + Method Descriptions ------------------- diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index a426d7524..03559d0d1 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -1669,6 +1669,8 @@ enum **CanvasOccluderPolygonCullMode**: .. _class_VisualServer_constant_INFO_SHADER_CHANGES_IN_FRAME: +.. _class_VisualServer_constant_INFO_SHADER_COMPILES_IN_FRAME: + .. _class_VisualServer_constant_INFO_SURFACE_CHANGES_IN_FRAME: .. _class_VisualServer_constant_INFO_DRAW_CALLS_IN_FRAME: @@ -1695,21 +1697,29 @@ enum **RenderInfo**: - **INFO_SHADER_CHANGES_IN_FRAME** = **3** --- The amount of shader rebinds in the frame. -- **INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- The amount of surface changes in the frame. +- **INFO_SHADER_COMPILES_IN_FRAME** = **4** --- The peak amount of shaders that have been under compilation in the frame. -- **INFO_DRAW_CALLS_IN_FRAME** = **5** --- The amount of draw calls in frame. +This is useful to know when asynchronous shader compilation has finished for the current shaders on screen. -- **INFO_2D_ITEMS_IN_FRAME** = **6** --- The amount of 2d items in the frame. +\ **Note:** For complete certainty, only assume there are no outstanding compilations when this value is zero for at least two frames in a row. -- **INFO_2D_DRAW_CALLS_IN_FRAME** = **7** --- The amount of 2d draw calls in frame. +Unimplemented in the GLES2 rendering backend, always returns 0. -- **INFO_USAGE_VIDEO_MEM_TOTAL** = **8** --- Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. +- **INFO_SURFACE_CHANGES_IN_FRAME** = **5** --- The amount of surface changes in the frame. -- **INFO_VIDEO_MEM_USED** = **9** --- The amount of video memory used, i.e. texture and vertex memory combined. +- **INFO_DRAW_CALLS_IN_FRAME** = **6** --- The amount of draw calls in frame. -- **INFO_TEXTURE_MEM_USED** = **10** --- The amount of texture memory used. +- **INFO_2D_ITEMS_IN_FRAME** = **7** --- The amount of 2d items in the frame. -- **INFO_VERTEX_MEM_USED** = **11** --- The amount of vertex memory used. +- **INFO_2D_DRAW_CALLS_IN_FRAME** = **8** --- The amount of 2d draw calls in frame. + +- **INFO_USAGE_VIDEO_MEM_TOTAL** = **9** --- Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. + +- **INFO_VIDEO_MEM_USED** = **10** --- The amount of video memory used, i.e. texture and vertex memory combined. + +- **INFO_TEXTURE_MEM_USED** = **11** --- The amount of texture memory used. + +- **INFO_VERTEX_MEM_USED** = **12** --- The amount of vertex memory used. ---- diff --git a/classes/class_world.rst b/classes/class_world.rst index 59958b719..052367e07 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -16,7 +16,7 @@ Class that has everything pertaining to a world. Description ----------- -Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. +Class that has everything pertaining to a world. A physics space, a visual scenario, a navigation map and a sound space. Spatial nodes register their resources into the current world. Tutorials --------- @@ -33,6 +33,8 @@ Properties +---------------------------------------------------------------+------------------------------------------------------------------------+ | :ref:`Environment` | :ref:`fallback_environment` | +---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`navigation_map` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ | :ref:`RID` | :ref:`scenario` | +---------------------------------------------------------------+------------------------------------------------------------------------+ | :ref:`RID` | :ref:`space` | @@ -77,7 +79,19 @@ The World's :ref:`Environment`. | *Getter* | get_fallback_environment() | +----------+---------------------------------+ -The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. +The World's fallback environment will be used if :ref:`environment` fails or is missing. + +---- + +.. _class_World_property_navigation_map: + +- :ref:`RID` **navigation_map** + ++----------+----------------------+ +| *Getter* | get_navigation_map() | ++----------+----------------------+ + +The :ref:`RID` of this world's navigation map. Used by the :ref:`NavigationServer`. ---- diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 383dbc032..3e2a30858 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -16,7 +16,7 @@ Class that has everything pertaining to a 2D world. Description ----------- -Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. +Class that has everything pertaining to a 2D world. A physics space, a visual scenario, a navigation map and a sound space. 2D nodes register their resources into the current 2D world. Tutorials --------- @@ -31,6 +31,8 @@ Properties +-------------------------------------------------------------------+----------------------------------------------------------------------+ | :ref:`Physics2DDirectSpaceState` | :ref:`direct_space_state` | +-------------------------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`RID` | :ref:`navigation_map` | ++-------------------------------------------------------------------+----------------------------------------------------------------------+ | :ref:`RID` | :ref:`space` | +-------------------------------------------------------------------+----------------------------------------------------------------------+ @@ -61,6 +63,18 @@ Direct access to the world's physics 2D space state. Used for querying current a ---- +.. _class_World2D_property_navigation_map: + +- :ref:`RID` **navigation_map** + ++----------+----------------------+ +| *Getter* | get_navigation_map() | ++----------+----------------------+ + +The :ref:`RID` of this world's navigation map. Used by the :ref:`Navigation2DServer`. + +---- + .. _class_World2D_property_space: - :ref:`RID` **space**