diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index bb13ffabb02..466daa3bb80 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -103,9 +103,7 @@ Returns the number of frames that can be pushed to the audio sample data buffer :ref:`int` **get_skips** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the number of times the playback skipped due to a buffer underrun in the audio sample data. This value is reset at the start of the playback. .. rst-class:: classref-item-separator diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index e79165e2760..83b4a241d7c 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -21,7 +21,7 @@ Description A 2D polyline shape, intended for use in physics. Used internally in :ref:`CollisionPolygon2D` when it's in :ref:`CollisionPolygon2D.BUILD_SEGMENTS` mode. -Being just a collection of interconnected line segments, **ConcavePolygonShape2D** is the most freely configurable single 2D shape. It can be used to form polygons of any nature, or even shapes that don't enclose an area. However, :ref:`ConvexPolygonShape2D` is *hollow* even if the interconnected line segments do enclose an area, which often makes it unsuitable for physics or detection. +Being just a collection of interconnected line segments, **ConcavePolygonShape2D** is the most freely configurable single 2D shape. It can be used to form polygons of any nature, or even shapes that don't enclose an area. However, **ConcavePolygonShape2D** is *hollow* even if the interconnected line segments do enclose an area, which often makes it unsuitable for physics or detection. \ **Note:** When used for collision, **ConcavePolygonShape2D** is intended to work with static :ref:`CollisionShape2D` nodes like :ref:`StaticBody2D` and will likely not behave well for :ref:`CharacterBody2D`\ s or :ref:`RigidBody2D`\ s in a mode other than Static. diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 042970feefb..268074f54fa 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -21,7 +21,7 @@ Description A 3D trimesh shape, intended for use in physics. Usually used to provide a shape for a :ref:`CollisionShape3D`. -Being just a collection of interconnected triangles, **ConcavePolygonShape3D** is the most freely configurable single 3D shape. It can be used to form polyhedra of any nature, or even shapes that don't enclose a volume. However, :ref:`ConvexPolygonShape3D` is *hollow* even if the interconnected triangles do enclose a volume, which often makes it unsuitable for physics or detection. +Being just a collection of interconnected triangles, **ConcavePolygonShape3D** is the most freely configurable single 3D shape. It can be used to form polyhedra of any nature, or even shapes that don't enclose a volume. However, **ConcavePolygonShape3D** is *hollow* even if the interconnected triangles do enclose a volume, which often makes it unsuitable for physics or detection. \ **Note:** When used for collision, **ConcavePolygonShape3D** is intended to work with static :ref:`CollisionShape3D` nodes like :ref:`StaticBody3D` and will likely not behave well for :ref:`CharacterBody3D`\ s or :ref:`RigidBody3D`\ s in a mode other than Static. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 44bf53e12d1..0664ca4713f 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -532,6 +532,48 @@ void **merge** **(** :ref:`Dictionary` dictionary, :ref:`bool< Adds entries from ``dictionary`` to this dictionary. By default, duplicate keys are not copied over, unless ``overwrite`` is ``true``. + +.. tabs:: + + .. code-tab:: gdscript + + var dict = { "item": "sword", "quantity": 2 } + var other_dict = { "quantity": 15, "color": "silver" } + + # Overwriting of existing keys is disabled by default. + dict.merge(other_dict) + print(dict) # { "item": "sword", "quantity": 2, "color": "silver" } + + # With overwriting of existing keys enabled. + dict.merge(other_dict, true) + print(dict) # { "item": "sword", "quantity": 15, "color": "silver" } + + .. code-tab:: csharp + + var dict = new Godot.Collections.Dictionary + { + ["item"] = "sword", + ["quantity"] = 2, + }; + + var otherDict = new Godot.Collections.Dictionary + { + ["quantity"] = 15, + ["color"] = "silver", + }; + + // Overwriting of existing keys is disabled by default. + dict.Merge(otherDict); + GD.Print(dict); // { "item": "sword", "quantity": 2, "color": "silver" } + + // With overwriting of existing keys enabled. + dict.Merge(otherDict, true); + GD.Print(dict); // { "item": "sword", "quantity": 15, "color": "silver" } + + + +\ **Note:** :ref:`merge` is *not* recursive. Nested dictionaries are considered as keys that can be overwritten or not depending on the value of ``overwrite``, but they will never be merged together. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index d98849d78de..ce2af27c363 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -384,7 +384,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic Causes all the particles in this node to interpolate towards the end of their lifetime. -\ **Note**: This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. +\ **Note:** This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. .. rst-class:: classref-item-separator diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 65d382ab2fb..2079c7ed48b 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -567,7 +567,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic Causes all the particles in this node to interpolate towards the end of their lifetime. -\ **Note**: This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. +\ **Note:** This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. .. rst-class:: classref-item-separator diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 637190c926a..712bbeede5a 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -255,7 +255,7 @@ If not yet cached and ``base_mesh`` is provided, ``base_mesh`` will be used and :ref:`Array` **get_surface_arrays** **(** :ref:`int` surface_idx **)** |const| -Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface. See :ref:`add_surface`. +Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See :ref:`add_surface`. .. rst-class:: classref-item-separator diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index fc6ff45b1e8..abdcf86c4b5 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -589,6 +589,14 @@ Flag used to mark that the mesh contains up to 8 bone influences per vertex. Thi Flag used to mark that the mesh intentionally contains no vertex array. +.. _class_Mesh_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES: + +.. rst-class:: classref-enumeration-constant + +:ref:`ArrayFormat` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912`` + +Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_multiplayerapiextension.rst b/classes/class_multiplayerapiextension.rst index b06a29e93e6..44d7c945d01 100644 --- a/classes/class_multiplayerapiextension.rst +++ b/classes/class_multiplayerapiextension.rst @@ -35,7 +35,7 @@ The following example augment the default implementation (:ref:`SceneMultiplayer var base_multiplayer = SceneMultiplayer.new() func _init(): - # Just passthourgh base signals (copied to var to avoid cyclic reference) + # Just passthrough base signals (copied to var to avoid cyclic reference) var cts = connected_to_server var cf = connection_failed var pc = peer_connected @@ -45,13 +45,16 @@ The following example augment the default implementation (:ref:`SceneMultiplayer base_multiplayer.peer_connected.connect(func(id): pc.emit(id)) base_multiplayer.peer_disconnected.connect(func(id): pd.emit(id)) + func _poll(): + return base_multiplayer.poll() + # Log RPC being made and forward it to the default multiplayer. - func _rpc(peer: int, object: Object, method: StringName, args: Array) -> int: # Error + func _rpc(peer: int, object: Object, method: StringName, args: Array) -> Error: print("Got RPC for %d: %s::%s(%s)" % [peer, object, method, args]) return base_multiplayer.rpc(peer, object, method, args) # Log configuration add. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom. - func _object_configuration_add(object, config: Variant) -> int: # Error + func _object_configuration_add(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: print("Adding synchronization configuration for %s. Synchronizer: %s" % [object, config]) elif config is MultiplayerSpawner: @@ -59,7 +62,7 @@ The following example augment the default implementation (:ref:`SceneMultiplayer return base_multiplayer.object_configuration_add(object, config) # Log configuration remove. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom. - func _object_configuration_remove(object, config: Variant) -> int: # Error + func _object_configuration_remove(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: print("Removing synchronization configuration for %s. Synchronizer: %s" % [object, config]) elif config is MultiplayerSpawner: diff --git a/classes/class_node.rst b/classes/class_node.rst index 9f5141d5698..fa27fc6b558 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -769,7 +769,7 @@ Notification received every frame when the internal physics process flag is set **NOTIFICATION_POST_ENTER_TREE** = ``27`` -Notification received when the node is ready, just before :ref:`NOTIFICATION_READY` is received. Unlike the latter, it's sent every time the node enters tree, instead of only once. +Notification received when the node is ready, just before :ref:`NOTIFICATION_READY` is received. Unlike the latter, it's sent every time the node enters the tree, instead of only once. .. _class_Node_constant_NOTIFICATION_DISABLED: diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index a1e88dc5963..388999bff1c 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -2295,9 +2295,7 @@ A :ref:`CurveTexture` that defines the maximum velocity of a - void **set_velocity_pivot** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_velocity_pivot** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +A pivot point used to calculate radial and orbital velocity of particles. .. rst-class:: classref-section-separator diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index e0aaf7c36c3..ae8b6dfcd23 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -668,7 +668,7 @@ If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** -Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. The ``submenu`` argument is the name of the child **PopupMenu** node that will be shown when the item is clicked. +Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. The ``submenu`` argument must be the name of an existing **PopupMenu** that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ``ui_select`` or ``ui_right`` input actions. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index e9cc630da67..f3fa39d0247 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1309,22 +1309,24 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_size` | ``64`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.android` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.android` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.ios` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.ios` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.linuxbsd` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.linuxbsd` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.macos` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.macos` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.web` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.web` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/gl_compatibility/driver.windows` | ``"opengl3"`` | + | :ref:`String` | :ref:`rendering/gl_compatibility/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/gl_compatibility/fallback_to_angle` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/gl_compatibility/fallback_to_native` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`rendering/gl_compatibility/force_angle_on_devices` | ``[]`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/gl_compatibility/item_buffer_size` | ``16384`` | @@ -1449,17 +1451,17 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method.web` | ``"gl_compatibility"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver.android` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver.android` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver.ios` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver.ios` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver.linuxbsd` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver.linuxbsd` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver.macos` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver.macos` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/rendering_device/driver.windows` | ``"vulkan"`` | + | :ref:`String` | :ref:`rendering/rendering_device/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/rendering_device/pipeline_cache/save_chunk_size_mb` | ``3.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -2886,6 +2888,8 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable or parameter has no static type, or if a function has no static return type. +\ **Note:** This warning is recommended together with :ref:`EditorSettings.text_editor/completion/add_type_hints` to help achieve type safety. + .. rst-class:: classref-item-separator ---- @@ -3896,7 +3900,7 @@ On desktop platforms, overrides the game's initial window height. See also :ref: On desktop platforms, overrides the game's initial window width. See also :ref:`display/window/size/window_height_override`, :ref:`display/window/size/viewport_width` and :ref:`display/window/size/viewport_height`. -\ **Note:** By default, or when set to ``0``, the initial window width is the viewport :ref:`display/window/size/viewport_width`. This setting is ignored on iOS, Android, and Web. +\ **Note:** By default, or when set to ``0``, the initial window width is the :ref:`display/window/size/viewport_width`. This setting is ignored on iOS, Android, and Web. .. rst-class:: classref-item-separator @@ -3954,6 +3958,12 @@ The scale factor multiplier to use for 2D elements. This multiplies the final sc The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`display/window/stretch/scale` is applied, in addition to the automatic scale factor determined by :ref:`display/window/stretch/mode`. +\ **"fractional"**: The scale factor will not be modified. + +\ **"integer"**: The scale factor will be floored to an integer value, which means that the screen size will always be an integer multiple of the base viewport size. This provides a crisp pixel art appearance. + +\ **Note:** When using integer scaling with a stretch mode, resizing the window to be smaller than the base viewport size will clip the contents. Consider preventing that by setting :ref:`Window.min_size` to the same value as the base viewport size defined in :ref:`display/window/size/viewport_width` and :ref:`display/window/size/viewport_height`. + .. rst-class:: classref-item-separator ---- @@ -9672,7 +9682,7 @@ Base size used to determine size of froxel buffer in the camera X-axis and Y-axi .. rst-class:: classref-property -:ref:`String` **rendering/gl_compatibility/driver** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver** Sets the driver to be used by the renderer when using the Compatibility renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides. @@ -9684,7 +9694,7 @@ Sets the driver to be used by the renderer when using the Compatibility renderer .. rst-class:: classref-property -:ref:`String` **rendering/gl_compatibility/driver.android** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.android** Android override for :ref:`rendering/gl_compatibility/driver`. @@ -9696,7 +9706,7 @@ Android override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.ios** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.ios** iOS override for :ref:`rendering/gl_compatibility/driver`. @@ -9708,7 +9718,7 @@ iOS override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.linuxbsd** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.linuxbsd** LinuxBSD override for :ref:`rendering/gl_compatibility/driver`. @@ -9720,7 +9730,7 @@ LinuxBSD override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.macos** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.macos** macOS override for :ref:`rendering/gl_compatibility/driver`. @@ -9732,7 +9742,7 @@ macOS override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.web** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.web** Web override for :ref:`rendering/gl_compatibility/driver`. @@ -9744,7 +9754,7 @@ Web override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.windows** = ``"opengl3"`` +:ref:`String` **rendering/gl_compatibility/driver.windows** Windows override for :ref:`rendering/gl_compatibility/driver`. @@ -9760,6 +9770,22 @@ Windows override for :ref:`rendering/gl_compatibility/driver`. +\ **Note:** This setting is implemented only on Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/gl_compatibility/fallback_to_native: + +.. rst-class:: classref-property + +:ref:`bool` **rendering/gl_compatibility/fallback_to_native** = ``true`` + +If ``true``, the compatibility renderer will fall back to native OpenGL if ANGLE over Metal is not supported. + +\ **Note:** This setting is implemented only on macOS. + .. rst-class:: classref-item-separator ---- @@ -9774,6 +9800,8 @@ An :ref:`Array` of devices which should always use the ANGLE render Each entry is a :ref:`Dictionary` with the following keys: ``vendor`` and ``name``. ``name`` can be set to ``*`` to add all devices with the specified ``vendor``. +\ **Note:** This setting is implemented only on Windows. + .. rst-class:: classref-item-separator ---- @@ -10586,7 +10614,7 @@ Override for :ref:`rendering/renderer/rendering_method` **rendering/rendering_device/driver** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver** Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the clustered renderer or the mobile renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides. @@ -10598,7 +10626,7 @@ Sets the driver to be used by the renderer when using a RenderingDevice-based re .. rst-class:: classref-property -:ref:`String` **rendering/rendering_device/driver.android** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver.android** Android override for :ref:`rendering/rendering_device/driver`. @@ -10610,7 +10638,7 @@ Android override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.ios** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver.ios** iOS override for :ref:`rendering/rendering_device/driver`. @@ -10622,7 +10650,7 @@ iOS override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.linuxbsd** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver.linuxbsd** LinuxBSD override for :ref:`rendering/rendering_device/driver`. @@ -10634,7 +10662,7 @@ LinuxBSD override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.macos** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver.macos** macOS override for :ref:`rendering/rendering_device/driver`. @@ -10646,7 +10674,7 @@ macOS override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.windows** = ``"vulkan"`` +:ref:`String` **rendering/rendering_device/driver.windows** Windows override for :ref:`rendering/rendering_device/driver`. diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index b68edd4d749..ee5a5c9be94 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -213,7 +213,7 @@ Returns a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclu void **randomize** **(** **)** -Setups a time-based seed to for this **RandomNumberGenerator** instance. Unlike the :ref:`@GlobalScope` random number generation functions, different **RandomNumberGenerator** instances can use different seeds. +Sets up a time-based seed for this **RandomNumberGenerator** instance. Unlike the :ref:`@GlobalScope` random number generation functions, different **RandomNumberGenerator** instances can use different seeds. .. |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_renderingserver.rst b/classes/class_renderingserver.rst index 40d83e29c5c..54fec469c18 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -1612,7 +1612,7 @@ Flag used to mark that the mesh does not have a vertex array and instead will in :ref:`ArrayFormat` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912`` -Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, uvs). When this form of compression is enabled, vertex positions will be packed into into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into a RG16UNORM representing an axis, and an 16 bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32 bit signed floats. When using this compression mode you must either use vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can. +Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE: diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 8703ce8ac57..b6bac257742 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -152,6 +152,8 @@ If ``true``, the resource is duplicated for each instance of all scenes using it An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor. +\ **Note:** Some resource formats do not support resource names. You can still set the name in the editor or via code, but it will be lost when the resource is reloaded. For example, only built-in scripts can have a resource name, while scripts stored in separate files cannot. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index a568037b105..62c8b0cb537 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -2054,7 +2054,7 @@ The vertical separation of elements in a table. :ref:`int` **text_highlight_h_padding** = ``3`` -The horizontal padding around a highlighting and background color box. +The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. .. rst-class:: classref-item-separator @@ -2066,7 +2066,7 @@ The horizontal padding around a highlighting and background color box. :ref:`int` **text_highlight_v_padding** = ``3`` -The vertical padding around a highlighting and background color box. +The vertical padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. .. rst-class:: classref-item-separator diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index ca8caa872f2..ea03bfa8993 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -297,7 +297,7 @@ Emitted when a tab is right-clicked. :ref:`select_with_rmb` tab **)** -Emitted when a tab is selected via click or script, even if it is the current tab. +Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. .. rst-class:: classref-section-separator diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 67f810acefd..7265cd9fe47 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -263,7 +263,7 @@ Emitted when a tab is hovered by the mouse. **tab_selected** **(** :ref:`int` tab **)** -Emitted when a tab is selected via click or script, even if it is the current tab. +Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. .. rst-class:: classref-section-separator diff --git a/classes/class_time.rst b/classes/class_time.rst index 377ead4f322..e9717ca618b 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -507,7 +507,11 @@ Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). :ref:`Dictionary` **get_time_zone_from_system** **(** **)** |const| -Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. The ``bias`` value is the offset from UTC in minutes, since not all time zones are multiples of an hour from UTC. +Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. + +- ``bias`` is the offset from UTC in minutes, since not all time zones are multiples of an hour from UTC. + +- ``name`` is the localized name of the time zone, according to the OS locale settings of the current user. .. rst-class:: classref-item-separator diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index ed482a8e63e..00d5f59346b 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -75,8 +75,6 @@ Properties +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`DebugDraw` | :ref:`debug_draw` | ``0`` | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ - | :ref:`bool` | :ref:`disable_2d` | ``false`` | - +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`bool` | :ref:`disable_3d` | ``false`` | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`fsr_sharpness` | ``0.2`` | @@ -1108,23 +1106,6 @@ The overlay mode for test rendered geometry in debug purposes. ---- -.. _class_Viewport_property_disable_2d: - -.. rst-class:: classref-property - -:ref:`bool` **disable_2d** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_disable_2d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_2d_disabled** **(** **)** - -If ``true``, disables 2D rendering while keeping 3D rendering. See also :ref:`disable_3d`. - -.. rst-class:: classref-item-separator - ----- - .. _class_Viewport_property_disable_3d: .. rst-class:: classref-property @@ -1136,7 +1117,7 @@ If ``true``, disables 2D rendering while keeping 3D rendering. See also :ref:`di - void **set_disable_3d** **(** :ref:`bool` value **)** - :ref:`bool` **is_3d_disabled** **(** **)** -If ``true``, disables 3D rendering while keeping 2D rendering. See also :ref:`disable_2d`. +Disable 3D rendering (but keep 2D rendering). .. rst-class:: classref-item-separator