diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 61c9fc2d816..3302e746dc4 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -348,7 +348,7 @@ - Duplicates this array, deeply, like [method duplicate][code](true)[/code], with extra control over how subresources are handled. + Duplicates this array, deeply, like [method duplicate] when passing [code]true[/code], with extra control over how subresources are handled. [param deep_subresources_mode] must be one of the values from [enum Resource.DeepDuplicateMode]. By default, only internal resources will be duplicated (recursively). diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index 9893e5c1a81..20cea106cdb 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -160,7 +160,7 @@ Determines when depth rendering takes place. See also [member transparency]. - Determines which comparison operator is used when testing depth. See [enum DepthTest]. + Determines which comparison operator is used when testing depth. [b]Note:[/b] Changing [member depth_test] to a non-default value only has a visible effect when used on a transparent material, or a material that has [member depth_draw_mode] set to [constant DEPTH_DRAW_DISABLED]. @@ -382,13 +382,13 @@ The primary color of the stencil effect. - The comparison operator to use for stencil masking operations. See [enum StencilCompare]. + The comparison operator to use for stencil masking operations. - The flags dictating how the stencil operation behaves. See [enum StencilFlags]. + The flags dictating how the stencil operation behaves. - The stencil effect mode. See [enum StencilMode]. + The stencil effect mode. The outline thickness for [constant STENCIL_MODE_OUTLINE]. @@ -862,7 +862,7 @@ Enables stencil operations without a preset. - The material will only be rendered where it passes a stencil comparison with existing stencil buffer values. See [enum StencilCompare]. + The material will only be rendered where it passes a stencil comparison with existing stencil buffer values. The material will write the reference value to the stencil buffer where it passes the depth test. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 1571e39da54..2f5cc227ffe 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -633,7 +633,7 @@ - If [code]true[/code], the node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] whenever global transform changes. + If [code]true[/code], the node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] whenever its global transform changes. [b]Note:[/b] Many canvas items such as [Camera2D] or [Light2D] automatically enable this in order to function correctly. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 6ffe96e2662..b8c077a2102 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -229,7 +229,7 @@ - Duplicates this dictionary, deeply, like [method duplicate][code](true)[/code], with extra control over how subresources are handled. + Duplicates this dictionary, deeply, like [method duplicate] when passing [code]true[/code], with extra control over how subresources are handled. [param deep_subresources_mode] must be one of the values from [enum Resource.DeepDuplicateMode]. By default, only internal resources will be duplicated (recursively). @@ -508,7 +508,7 @@ - Sets the value of the element at the given [param key] to the given [param value]. This is the same as using the [code][][/code] operator ([code]dict[key] = value[/code]). Returns [code]true[/code] if the value is set successfully. Fails and returns [code]false[/code] if the dictionary is read-only, or if [param key] and [param value] don't match the dictionary's types. + Sets the value of the element at the given [param key] to the given [param value]. Returns [code]true[/code] if the value is set successfully. Fails and returns [code]false[/code] if the dictionary is read-only, or if [param key] and [param value] don't match the dictionary's types. This is the same as using the [code][][/code] operator ([code]dict[key] = value[/code]). diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 2bece46fed3..e87e2a3b707 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -81,7 +81,7 @@ Returns [code]1[/code] if a screen reader, Braille display or other assistive app is active, [code]0[/code] otherwise. Returns [code]-1[/code] if status is unknown. [b]Note:[/b] This method is implemented on Linux, macOS, and Windows. - [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps and will not affect this value. To test your app with these tools, set [member ProjectSettings.accessibility/general/accessibility_support] to [code]1[/code]. + [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps and will not affect this value. To test your project with these tools, set [member ProjectSettings.accessibility/general/accessibility_support] to [code]1[/code]. @@ -1860,7 +1860,7 @@ - Sets the [param callable] that should be called when hardware keyboard is connected/disconnected. [param callable] should accept a single [bool] parameter indicating whether the keyboard is connected (true) or disconnected (false). + Sets the callback that should be called when a hardware keyboard is connected or disconnected. [param callable] should accept a single [bool] argument indicating whether the keyboard has been connected ([code]true[/code]) or disconnected ([code]false[/code]). [b]Note:[/b] This method is only implemented on Android. @@ -1884,7 +1884,7 @@ - Sets the [param callable] that should be called when system theme settings are changed. Callback method should have zero arguments. + Sets the callback that should be called when the system's theme settings are changed. [param callable] should accept zero arguments. [b]Note:[/b] This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland). @@ -2073,8 +2073,8 @@ - Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. - [b]Note:[/b] On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode. + Returns the on-screen keyboard's height in pixels. Returns [code]0[/code] if there is no keyboard or if it is currently hidden. + [b]Note:[/b] On Android 7 and 8, the keyboard height may return [code]0[/code] the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode. @@ -2251,14 +2251,14 @@ - Returns [code]true[/code], if double-click on a window title should maximize it. + Returns [code]true[/code] if double-clicking on a window's title should maximize it. [b]Note:[/b] This method is implemented only on macOS. - Returns [code]true[/code], if double-click on a window title should minimize it. + Returns [code]true[/code] if double-clicking on a window's title should minimize it. [b]Note:[/b] This method is implemented only on macOS. @@ -2789,7 +2789,7 @@ Element is hidden for accessibility tools. - Element is support multiple item selection. + Element supports multiple item selection. Element require user input. @@ -3161,7 +3161,7 @@ [b]Note:[/b] This flag is implemented on macOS and Windows. - Max value of the [enum WindowFlags]. + Represents the size of the [enum WindowFlags] enum. Sent when the mouse pointer enters the window. @@ -3191,7 +3191,7 @@ [b]Note:[/b] This flag is implemented only on macOS. - Sent when the window has been forcibly closed by the Display Server. The window shall immediately hide and clean any internal rendering references. + Sent when the window has been forcibly closed by the display server. The window will immediately hide and clean any internal rendering references. [b]Note:[/b] This flag is implemented only on Linux (Wayland). diff --git a/doc/classes/EditorExportPlatformExtension.xml b/doc/classes/EditorExportPlatformExtension.xml index 13c8fc072c8..33f67ce0e03 100644 --- a/doc/classes/EditorExportPlatformExtension.xml +++ b/doc/classes/EditorExportPlatformExtension.xml @@ -15,8 +15,8 @@ - Returns [code]true[/code], if specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details. - Usual implementation can call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if export is possible. + Returns [code]true[/code] if the specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details. + Usual implementations call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if exporting is possible. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 107d604075e..068dc9bcac0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -899,13 +899,14 @@ - [b]Auto[/b] ([code]0[/code]): Accessibility support is enabled, but updates to the accessibility information are processed only if an assistive app (such as a screen reader or a Braille display) is active (default). - [b]Always Active[/b] ([code]1[/code]): Accessibility support is enabled, and updates to the accessibility information are always processed, regardless of the status of assistive apps. - [b]Disabled[/b] ([code]2[/code]): Accessibility support is fully disabled. - [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD) do not count as assistive apps. To test your project with these tools, use [b]Always Active[/b]. + [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test the editor with these tools, use [b]Always Active[/b]. - How to position the Cancel and OK buttons in the editor's [AcceptDialog]s. Different platforms have different standard behaviors for this, which can be overridden using this setting. This is useful if you use Godot both on Windows and macOS/Linux and your Godot muscle memory is stronger than your OS specific one. - - [b]Auto[/b] follows the platform convention: OK first on Windows, KDE, and LXQt, Cancel first on macOS and other Linux desktop environments. - - [b]Cancel First[/b] forces the ordering Cancel/OK. - - [b]OK First[/b] forces the ordering OK/Cancel. + How to position the Cancel and OK buttons in the editor's [AcceptDialog] windows. Different platforms have different conventions for this, which can be overridden through this setting to avoid accidental clicks when using Godot on multiple platforms. + - [b]Auto[/b] follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments. + - [b]Cancel First[/b] forces the Cancel/OK ordering. + - [b]OK First[/b] forces the OK/Cancel ordering. + To check if these buttons are swapped at runtime, use [method DisplayServer.get_swap_cancel_ok]. If [code]true[/code], automatically opens screenshots with the default program associated to [code].png[/code] files after a screenshot is taken using the [b]Editor > Take Screenshot[/b] action. diff --git a/doc/classes/FileAccess.xml b/doc/classes/FileAccess.xml index b5b24a1368b..34ec73b4c20 100644 --- a/doc/classes/FileAccess.xml +++ b/doc/classes/FileAccess.xml @@ -238,7 +238,7 @@ - Returns [code]true[/code], if file [code]hidden[/code] attribute is set. + Returns [code]true[/code] if the [b]hidden[/b] attribute is set on the file at the given path. [b]Note:[/b] This method is implemented on iOS, BSD, macOS, and Windows. @@ -304,7 +304,7 @@ - Returns [code]true[/code], if file [code]read only[/code] attribute is set. + Returns [code]true[/code] if the [b]read only[/b] attribute is set on the file at the given path. [b]Note:[/b] This method is implemented on iOS, BSD, macOS, and Windows. @@ -417,15 +417,15 @@ - Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). This changes the value returned by [method get_position]. + Sets the file cursor to the specified position in bytes, from the beginning of the file. This changes the value returned by [method get_position]. - Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). This changes the value returned by [method get_position]. - [b]Note:[/b] This is an offset, so you should use negative numbers or the file cursor will be at the end of the file. + Sets the file cursor to the specified position in bytes, from the end of the file. This changes the value returned by [method get_position]. + [b]Note:[/b] This is an offset, so you should use negative numbers otherwise the file cursor will be at the end of the file. @@ -565,7 +565,7 @@ - Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. + Stores the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. Returns [code]true[/code] if the operation is successful. [b]Note:[/b] If an error occurs, the resulting value of the file position indicator is indeterminate. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 3c59a7aa789..f8b783b37fb 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -129,7 +129,7 @@ - Toggles the specified customization [param flag], allowing to customize features available in this [FileDialog]. See [enum Customization] for options. + Sets the specified customization [param flag], allowing to customize the features available in this [FileDialog]. diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 243410005ff..df06cde5a02 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -322,14 +322,14 @@ - Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). + Returns [code]true[/code] if the font supports the given language (as a [url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - Returns [code]true[/code], if font supports given script ([url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). + Returns [code]true[/code] if the font supports the given script (as a [url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index db1c3b6a285..e1baf9f543a 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -307,14 +307,14 @@ - Disallows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_left_disconnect_type]. + Disallows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. Use this to disable a disconnection previously allowed with [method add_valid_left_disconnect_type]. - Disallows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_right_disconnect_type]. + Disallows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. Use this to disable a disconnection previously allowed with [method add_valid_right_disconnect_type]. @@ -591,7 +591,7 @@ The outline color of the selection rectangle. - Widen the line of the connection when the mouse is hovering over it by a percentage factor. A value of [code]0[/code] disables the highlight. A value of [code]100[/code] doubles the line width. + Widens the line of a connection when the mouse is hovering over it by a percentage factor. A value of [code]0[/code] disables the highlight. A value of [code]100[/code] doubles the line width. The horizontal range within which a port can be grabbed (inner side). diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index b9975d406bf..d4efe213edb 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -75,8 +75,8 @@ Registers a callback for the given method name. - - [param name] The name that clients can use to access the callback. - - [param callback] The callback which will handle the specific method. + - [param name]: The name that clients can use to access the callback. + - [param callback]: The callback which will handle the specified method. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 40cb3d9f900..3c38a66236c 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -261,7 +261,7 @@ - Text alignment as defined in the [enum HorizontalAlignment] enum. + The text's horizontal alignment. If [code]true[/code] and [member caret_mid_grapheme] is [code]false[/code], backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character. diff --git a/doc/classes/MenuBar.xml b/doc/classes/MenuBar.xml index d504a5a26b5..044cbd445ac 100644 --- a/doc/classes/MenuBar.xml +++ b/doc/classes/MenuBar.xml @@ -40,20 +40,20 @@ - Returns [code]true[/code], if menu item is disabled. + Returns [code]true[/code] if the menu item is disabled. - Returns [code]true[/code], if menu item is hidden. + Returns [code]true[/code] if the menu item is hidden. - Returns [code]true[/code], if system global menu is supported and used by this [MenuBar]. + Returns [code]true[/code] if the current system's global menu is supported and used by this [MenuBar]. diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 9e08fa973a0..962c55cc775 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -6,7 +6,6 @@ A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can access a critical section at a time. This is a reentrant mutex, meaning that it can be locked multiple times by one thread, provided it also unlocks it as many times. - [b]Warning:[/b] Mutexes must be used carefully to avoid deadlocks. [b]Warning:[/b] To ensure proper cleanup without crashes or deadlocks, the following conditions must be met: - When a [Mutex]'s reference count reaches zero and it is therefore destroyed, no threads (including the one on which the destruction will happen) must have it locked. - When a [Thread]'s reference count reaches zero and it is therefore destroyed, it must not have any mutex locked. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 2310bac8fb8..cfc513ed987 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -207,10 +207,10 @@ - Convex partitioning that yields navigation mesh with convex polygons. + Convex partitioning that results in a navigation mesh with convex polygons. - Triangulation partitioning that yields navigation mesh with triangle polygons. + Triangulation partitioning that results in a navigation mesh with triangle polygons. Represents the size of the [enum SamplePartitionType] enum. diff --git a/doc/classes/Path3D.xml b/doc/classes/Path3D.xml index b650aee0a30..d2696526019 100644 --- a/doc/classes/Path3D.xml +++ b/doc/classes/Path3D.xml @@ -14,8 +14,7 @@ A [Curve3D] describing the path. - The custom color to use to draw the shape in the editor. - If set to [code]Color(0.0, 0.0, 0.0)[/code] (by default), the color set in EditorSettings is used. + The custom color used to draw the path in the editor. If set to [constant Color.BLACK] (as by default), the color set in [member ProjectSettings.debug/shapes/paths/geometry_color] is used. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index d9dd5b32b27..d204b435f15 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -203,7 +203,7 @@ Output latency of the [AudioServer]. Equivalent to calling [method AudioServer.get_output_latency], it is not recommended to call this every frame. - Number of active navigation maps in [NavigationServer2D] and [NavigationServer3D]. This also includes the two empty default navigation maps created by World2D and World3D. + Number of active navigation maps in [NavigationServer2D] and [NavigationServer3D]. This also includes the empty default navigation maps created by [World2D] and [World3D] instances. Number of active navigation regions in [NavigationServer2D] and [NavigationServer3D]. @@ -248,7 +248,7 @@ Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever. - Number of active navigation maps in the [NavigationServer2D]. This also includes the two empty default navigation maps created by World2D. + Number of active navigation maps in the [NavigationServer2D]. This also includes the empty default navigation maps created by [World2D] instances. Number of active navigation regions in the [NavigationServer2D]. @@ -278,7 +278,7 @@ Number of active navigation obstacles in the [NavigationServer2D]. - Number of active navigation maps in the [NavigationServer3D]. This also includes the two empty default navigation maps created by World3D. + Number of active navigation maps in the [NavigationServer3D]. This also includes the empty default navigation maps created by [World3D] instances. Number of active navigation regions in the [NavigationServer3D]. diff --git a/doc/classes/PortableCompressedTexture2D.xml b/doc/classes/PortableCompressedTexture2D.xml index 9010a1f69d2..37445bf4d93 100644 --- a/doc/classes/PortableCompressedTexture2D.xml +++ b/doc/classes/PortableCompressedTexture2D.xml @@ -40,7 +40,7 @@ - Return whether the flag is overridden for all textures of this type. + Returns [code]true[/code] if the flag is overridden for all textures of this type. @@ -56,7 +56,7 @@ - Overrides the flag globally for all textures of this type. This is used primarily by the editor. + If [param keep] is [code]true[/code], overrides the flag globally for all textures of this type. This is used primarily by the editor. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 5fc0b3b9b1e..ea1ad6a89de 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -277,7 +277,7 @@ - [b]Auto[/b] ([code]0[/code]): Accessibility support is enabled, but updates to the accessibility information are processed only if an assistive app (such as a screen reader or a Braille display) is active (default). - [b]Always Active[/b] ([code]1[/code]): Accessibility support is enabled, and updates to the accessibility information are always processed, regardless of the status of assistive apps. - [b]Disabled[/b] ([code]2[/code]): Accessibility support is fully disabled. - [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD) do not count as assistive apps. To test your project with these tools, use [b]Always Active[/b]. + [b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test your project with these tools, use [b]Always Active[/b]. The number of accessibility information updates per second. @@ -486,8 +486,8 @@ Sets the [url=https://developer.apple.com/documentation/avfaudio/avaudiosessioncategory]AVAudioSessionCategory[/url] on iOS. Use the [code]Playback[/code] category to get sound output, even if the phone is in silent mode. - If [code]true[/code], text-to-speech support is enabled on startup, otherwise it is enabled first time TTS method is used, see [method DisplayServer.tts_get_voices] and [method DisplayServer.tts_speak]. - [b]Note:[/b] Enabling TTS can cause addition idle CPU usage and interfere with the sleep mode, so consider disabling it if TTS is not used. + If [code]true[/code], text-to-speech support is enabled on startup, otherwise it is enabled the first time any TTS method is used. See also [method DisplayServer.tts_get_voices] and [method DisplayServer.tts_speak]. + [b]Note:[/b] Enabling TTS can cause additional idle CPU usage and interfere with the sleep mode, so consider disabling it if TTS is not used. Setting to hardcode audio delay when playing video. Best to leave this unchanged unless you know what you are doing. @@ -1231,10 +1231,11 @@ If [code]true[/code], snaps [Control] node vertices to the nearest pixel to ensure they remain crisp even when the camera moves or zooms. - How to position the Cancel and OK buttons in the project's [AcceptDialog]s. Different platforms have different standard behaviors for this, which can be overridden using this setting. - - [b]Auto[/b] ([code]0[/code]) follows the platform convention: OK first on Windows, KDE, and LXQt, Cancel first on macOS and other Linux desktop environments. [method DisplayServer.get_swap_cancel_ok] can be used to query whether buttons are swapped at run-time. - - [b]Cancel First[/b] ([code]1[/code]) forces the ordering Cancel/OK. - - [b]OK First[/b] ([code]2[/code]) forces the ordering OK/Cancel. + How to position the Cancel and OK buttons in the project's [AcceptDialog] windows. Different platforms have different conventions for this, which can be overridden through this setting. + - [b]Auto[/b] follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments. + - [b]Cancel First[/b] forces the Cancel/OK ordering. + - [b]OK First[/b] forces the OK/Cancel ordering. + To check if these buttons are swapped at runtime, use [method DisplayServer.get_swap_cancel_ok]. [b]Note:[/b] This doesn't affect native dialogs such as the ones spawned by [method DisplayServer.dialog_show]. diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 80265b2475f..4ee7d19cd06 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -64,7 +64,7 @@ - If greater than 0, [member value] will always be rounded to a multiple of this property's value above [member min_value]. For example, if [member min_value] is [code]0.1[/code] and step is 0.2, then [member value] is limited to [code]0.1[/code], [code]0.3[/code], [code]0.5[/code], and so on. If [member rounded] is also [code]true[/code], [member value] will first be rounded to a multiple of this property's value, then rounded to the nearest integer. + If greater than [code]0.0[/code], [member value] will always be rounded to a multiple of this property's value above [member min_value]. For example, if [member min_value] is [code]0.1[/code] and step is [code]0.2[/code], then [member value] is limited to [code]0.1[/code], [code]0.3[/code], [code]0.5[/code], and so on. If [member rounded] is also [code]true[/code], [member value] will first be rounded to a multiple of this property's value, then rounded to the nearest integer. Range's current value. Changing this property (even via code) will trigger [signal value_changed] signal. Use [method set_value_no_signal] if you want to avoid it. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 8d32ffcdc24..bbb960451b2 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -105,7 +105,7 @@ - Removes a collision exception so the ray can report collisions with the specified specified [param node]. + Removes a collision exception so the ray can report collisions with the specified [param node]. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 32965acc1ed..14c5ec9c4d3 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -66,8 +66,7 @@ - Duplicates this resource, deeply, like [method duplicate][code](true)[/code], with extra control over how subresources are handled. - [param deep_subresources_mode] must be one of the values from [enum DeepDuplicateMode]. + Duplicates this resource, deeply, like [method duplicate] when passing [code]true[/code], with extra control over how subresources are handled. diff --git a/doc/classes/ResourceUID.xml b/doc/classes/ResourceUID.xml index 250034225ff..0838fc1e353 100644 --- a/doc/classes/ResourceUID.xml +++ b/doc/classes/ResourceUID.xml @@ -37,7 +37,7 @@ - Returns a path, converting [param path_or_uid] if necessary. Prints an error if provided an invalid UID. + Returns a path, converting [param path_or_uid] if necessary. Fails and returns an empty string if an invalid UID is provided. diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index c8c5845de08..fecfc0a039e 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -112,7 +112,7 @@ - Returns the metadata for the bone at index [param bone_idx] with [param key]. + Returns the metadata with the given [param key] for the bone at index [param bone_idx]. @@ -199,7 +199,7 @@ - Returns [code]true[/code] if the bone at index [param bone_idx] has metadata with the key [param key]. + Returns [code]true[/code] if the bone at index [param bone_idx] has metadata with the given [param key]. @@ -300,7 +300,7 @@ - Sets the metadata for the bone at index [param bone_idx], setting the [param key] meta to [param value]. + Sets the metadata with the given [param key] to [param value] for the bone at index [param bone_idx]. diff --git a/doc/classes/SkeletonModifier3D.xml b/doc/classes/SkeletonModifier3D.xml index 621c59fcd83..6a31fd77afd 100644 --- a/doc/classes/SkeletonModifier3D.xml +++ b/doc/classes/SkeletonModifier3D.xml @@ -39,13 +39,13 @@ - Called when bone name and index need to be validated such as the timing of the entering tree or changing skeleton. + Called when bone names and indices need to be validated, such as when entering the scene tree or changing skeleton. - Get parent [Skeleton3D] node if found. + Returns the parent [Skeleton3D] node if it exists. Otherwise, returns [code]null[/code]. diff --git a/doc/classes/SpringArm3D.xml b/doc/classes/SpringArm3D.xml index 330317f352a..891e80b2d87 100644 --- a/doc/classes/SpringArm3D.xml +++ b/doc/classes/SpringArm3D.xml @@ -39,7 +39,7 @@ - The layers against which the collision check shall be done. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + The layers against which the collision check will be done. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. When the collision check is made, a candidate length for the SpringArm3D is given. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index acece048671..3a750203d7b 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -782,7 +782,7 @@ - Removes any occurrence of the characters in [param chars]. See also [method remove_char]. + Removes all occurrences of the characters in [param chars]. See also [method remove_char]. diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 98f48867ef7..a93d6dbc46e 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -683,7 +683,7 @@ - Removes any occurrence of the characters in [param chars]. See also [method remove_char]. + Removes all occurrences of the characters in [param chars]. See also [method remove_char]. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 65ba7e8b159..4192cfd4283 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -583,14 +583,14 @@ - Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). + Returns [code]true[/code] if the font supports the given language (as a [url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - Returns [code]true[/code], if color modulation is applied when drawing colored glyphs. + Returns [code]true[/code] if color modulation is applied when drawing the font's colored glyphs. @@ -605,7 +605,7 @@ - Returns [code]true[/code], if font supports given script (ISO 15924 code). + Returns [code]true[/code] if the font supports the given script (as a [url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index 3e4a1ea57b7..fe329ff6735 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -561,14 +561,14 @@ - Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). + Returns [code]true[/code] if the font supports the given language (as a [url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - Returns [code]true[/code], if color modulation is applied when drawing colored glyphs. + Returns [code]true[/code] if color modulation is applied when drawing the font's colored glyphs. @@ -583,7 +583,7 @@ - Returns [code]true[/code], if font supports given script (ISO 15924 code). + Returns [code]true[/code] if the font supports the given script (as a [url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index d9228e7b153..5004c420c78 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -5,8 +5,7 @@ A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex] or [Semaphore] is advised if working with shared objects. - [b]Warning:[/b] - To ensure proper cleanup without crashes or deadlocks, when a [Thread]'s reference count reaches zero and it is therefore destroyed, the following conditions must be met: + [b]Warning:[/b] To ensure proper cleanup without crashes or deadlocks, when a [Thread]'s reference count reaches zero and it is therefore destroyed, the following conditions must be met: - It must not have any [Mutex] objects locked. - It must not be waiting on any [Semaphore] objects. - [method wait_to_finish] should have been called on it. diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 8ac85503510..4e1e248e5fa 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -108,7 +108,7 @@ - Returns an [enum XRInterface.TrackingStatus] specifying the current status of our tracking. + Returns the current status of our tracking. diff --git a/modules/gltf/doc_classes/GLTFNode.xml b/modules/gltf/doc_classes/GLTFNode.xml index 7b09ae91256..b5f004cf671 100644 --- a/modules/gltf/doc_classes/GLTFNode.xml +++ b/modules/gltf/doc_classes/GLTFNode.xml @@ -84,7 +84,7 @@ If this glTF node has a skin, the index of the [GLTFSkin] in the [GLTFState] that describes the skin's properties. If -1, this node does not have a skin. - If [code]true[/code], the GLTF node is visible. If [code]false[/code], the GLTF node is not visible. This is translated to the [member Node3D.visible] property in the Godot scene, and is exported to [code]KHR_node_visibility[/code] when [code]false[/code]. + If [code]true[/code], the GLTF node is visible. If [code]false[/code], the GLTF node is not visible. This is converted to the [member Node3D.visible] property in the Godot scene, and is exported to [code]KHR_node_visibility[/code] when [code]false[/code]. The transform of the glTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred. diff --git a/modules/openxr/doc_classes/OpenXRInterface.xml b/modules/openxr/doc_classes/OpenXRInterface.xml index 5a490971be2..9c506de94d6 100644 --- a/modules/openxr/doc_classes/OpenXRInterface.xml +++ b/modules/openxr/doc_classes/OpenXRInterface.xml @@ -20,7 +20,7 @@ - Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. + Returns a list of display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. @@ -108,8 +108,8 @@ - Returns [code]true[/code] if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value. - [b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop. + Returns [code]true[/code] if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value. + [b]Note:[/b] When using the Vulkan rendering driver, [member Viewport.vrs_mode] must be set to [constant Viewport.VRS_XR] to support foveation. @@ -162,11 +162,11 @@ The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized. - Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and [member foveation_level]. + If [code]true[/code], enables dynamic foveation adjustment. The interface must be initialized before this is accessible. If enabled, foveation will automatically be adjusted between low and [member foveation_level]. [b]Note:[/b] Only works on the Compatibility renderer. - Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible. + The foveation level, from [code]0[/code] (off) to [code]3[/code] (high). The interface must be initialized before this is accessible. [b]Note:[/b] Only works on the Compatibility renderer. @@ -274,7 +274,7 @@ The session is about to be lost. [signal session_loss_pending] is emitted when we change to this state. - The OpenXR instance is about to be destroyed and we're existing. [signal instance_exiting] is emitted when we change to this state. + The OpenXR instance is about to be destroyed and we're exiting. [signal instance_exiting] is emitted when we change to this state. Left hand. diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 70efde01410..00d3c727fd3 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -12,6 +12,7 @@ After these steps, the connection should become connected. Keep on reading or look into the tutorial for more information. + $DOCS_URL/tutorials/networking/high_level_multiplayer.html diff --git a/platform/android/doc_classes/EditorExportPlatformAndroid.xml b/platform/android/doc_classes/EditorExportPlatformAndroid.xml index aa6ceef2bd7..f91f9b9a03f 100644 --- a/platform/android/doc_classes/EditorExportPlatformAndroid.xml +++ b/platform/android/doc_classes/EditorExportPlatformAndroid.xml @@ -12,7 +12,7 @@ - Array of random bytes that the licensing Policy uses to create an [url=https://developer.android.com/google/play/licensing/adding-licensing#impl-Obfuscator]Obfuscator[/url]. + Array of random bytes that the licensing policy uses to create an [url=https://developer.android.com/google/play/licensing/adding-licensing#impl-Obfuscator]Obfuscator[/url]. If [code]true[/code], project resources are stored in the separate APK expansion file, instead of the APK. @@ -607,7 +607,7 @@ Allows an application to write to the user dictionary. - The background color used for the root window. Default is [code]black[/code]. + The background color used for the root window. By default it's [constant Color.BLACK]. If [code]true[/code], this makes the navigation and status bars translucent and allows the application content to extend edge to edge. diff --git a/platform/web/doc_classes/EditorExportPlatformWeb.xml b/platform/web/doc_classes/EditorExportPlatformWeb.xml index 1cc2280f683..0d8c791ece1 100644 --- a/platform/web/doc_classes/EditorExportPlatformWeb.xml +++ b/platform/web/doc_classes/EditorExportPlatformWeb.xml @@ -84,8 +84,8 @@ [b]Note:[/b] Some browsers have a hard cap on the number of threads that can be allocated, so it is best to be cautious and keep this number low. - Override for the default size of the [WorkerThreadPool]. This setting is used when [member ProjectSettings.threading/worker_pool/max_threads] size is set to -1 (which it is by default). This size must be smaller than [member threads/emscripten_pool_size] otherwise deadlocks may occur. - When using threads this size needs to be large enough to accommodate features that rely on having a dedicated thread like [member ProjectSettings.physics/2d/run_on_separate_thread] or [member ProjectSettings.rendering/driver/threads/thread_model]. In general, it is best to ensure that this is at least 4 and is at least 2 or 3 less than [member threads/emscripten_pool_size]. + Override for the default size of the [WorkerThreadPool]. This setting is used when [member ProjectSettings.threading/worker_pool/max_threads] size is set to [code]-1[/code] (which it is by default). This size must be smaller than [member threads/emscripten_pool_size] otherwise deadlocks may occur. + When using threads, this size needs to be large enough to accommodate features that rely on having a dedicated thread like [member ProjectSettings.physics/2d/run_on_separate_thread] or [member ProjectSettings.rendering/driver/threads/thread_model]. In general, it is best to ensure that this is at least [code]4[/code] and is at least [code]2[/code] or [code]3[/code] less than [member threads/emscripten_pool_size]. If [code]true[/code] enables [GDExtension] support for this web build.