seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix miscellaneous oddities around the class reference (part 6)

Browse Source
This commit is contained in:
Micky
2025-06-14 01:11:26 +02:00
committed by Micky
parent 9dd6c4dbac
commit be0c68845e
56 changed files with 117 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/Array.xml
View File

@ -443,7 +443,7 @@
<return type="Variant" />
<param index="0" name="index" type="int" />
<description>
Returns the element at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]null[/code].
Returns the element at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]null[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

10
doc/classes/BaseMaterial3D.xml
View File

@ -14,21 +14,21 @@
<return type="bool" />
<param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
<description>
Returns [code]true[/code], if the specified [enum Feature] is enabled.
Returns [code]true[/code] if the specified [param feature] is enabled.
</description>
</method>
<method name="get_flag" qualifiers="const">
<return type="bool" />
<param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
<description>
Returns [code]true[/code] if the specified flag is enabled.
Returns [code]true[/code] if the specified [param flag] is enabled.
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="Texture2D" />
<param index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
<description>
Returns the [Texture2D] associated with the specified [enum TextureParam].
Returns the [Texture2D] associated with the specified texture [param param].
</description>
</method>
<method name="set_feature">
@ -36,7 +36,7 @@
<param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
<param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code].
If [param enable] is [code]true[/code], enables the specified [param feature]. Many features that are available in [BaseMaterial3D] need to be enabled before use. This way, the cost for using the feature is only incurred when specified. Features can also be enabled by setting their corresponding property to [code]true[/code].
</description>
</method>
<method name="set_flag">
@ -44,7 +44,7 @@
<param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
<param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code].
If [param enable] is [code]true[/code], enables the specified [param flag]. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting their corresponding property to [code]true[/code].
</description>
</method>
<method name="set_texture">

2
doc/classes/Button.xml
View File

@ -66,7 +66,7 @@
Specifies if the icon should be aligned horizontally to the left, right, or center of a button. Uses the same [enum HorizontalAlignment] constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
The button's text that will be displayed inside the button's area.

4
doc/classes/Color.xml
View File

@ -366,14 +366,14 @@
<return type="Color" />
<description>
Returns a copy of the color that is encoded using the [url=https://en.wikipedia.org/wiki/SRGB]nonlinear sRGB transfer function[/url]. This method requires the original color to use linear encoding. See also [method srgb_to_linear] which performs the opposite operation.
[b]Note:[/b] The color's [member a]lpha channel is not affected. The alpha channel is always stored with linear encoding, regardless of the encoding of the other color channels.
[b]Note:[/b] The color's alpha channel ([member a]) is not affected. The alpha channel is always stored with linear encoding, regardless of the color space of the other color channels.
</description>
</method>
<method name="srgb_to_linear" qualifiers="const">
<return type="Color" />
<description>
Returns a copy of the color that uses linear encoding. This method requires the original color to be encoded using the [url=https://en.wikipedia.org/wiki/SRGB]nonlinear sRGB transfer function[/url]. See also [method linear_to_srgb] which performs the opposite operation.
[b]Note:[/b] The color's [member a]lpha channel is not affected. The alpha channel is always stored with linear encoding, regardless of the encoding of the other color channels.
[b]Note:[/b] The color's alpha channel ([member a]) is not affected. The alpha channel is always stored with linear encoding, regardless of the color space of the other color channels.
</description>
</method>
<method name="to_abgr32" qualifiers="const">

2
doc/classes/Control.xml
View File

@ -12,7 +12,7 @@
Input events are propagated through the [SceneTree] from the root node to all child nodes by calling [method Node._input]. For UI elements specifically, it makes more sense to override the virtual method [method _gui_input], which filters out unrelated input events, such as by checking z-order, [member mouse_filter], focus, or if the event was inside of the control's bounding box.
Call [method accept_event] so no other node receives the event. Once you accept an input, it becomes handled so [method Node._unhandled_input] will not process it.
Only one [Control] node can be in focus. Only the node in focus will receive events. To get the focus, call [method grab_focus]. [Control] nodes lose focus when another node grabs it, or if you hide the node in focus. Focus will not be represented visually if gained via mouse/touch input, only appearing with keyboard/gamepad input (for accessibility), or via [method grab_focus].
Sets [member mouse_filter] to [constant MOUSE_FILTER_IGNORE] to tell a [Control] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.
Set [member mouse_filter] to [constant MOUSE_FILTER_IGNORE] to tell a [Control] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.
[Theme] resources change the control's appearance. The [member theme] of a [Control] node affects all of its direct and indirect children (as long as a chain of controls is uninterrupted). To override some of the theme items, call one of the [code]add_theme_*_override[/code] methods, like [method add_theme_font_override]. You can also override theme items in the Inspector.
[b]Note:[/b] Theme items are [i]not[/i] [Object] properties. This means you can't access their values using [method Object.get] and [method Object.set]. Instead, use the [code]get_theme_*[/code] and [code]add_theme_*_override[/code] methods provided by this class.
</description>

6
doc/classes/DPITexture.xml
View File

@ -16,7 +16,7 @@
<param index="2" name="saturation" type="float" default="1.0" />
<param index="3" name="color_map" type="Dictionary" default="{}" />
<description>
Creates a new [DPITexture] and initializes it by allocating and setting the SVG data from string.
Creates a new [DPITexture] and initializes it by allocating and setting the SVG data to [param source].
</description>
</method>
<method name="get_scaled_rid" qualifiers="const">
@ -28,7 +28,7 @@
<method name="get_source" qualifiers="const">
<return type="String" />
<description>
Returns SVG source code.
Returns this SVG texture's source code.
</description>
</method>
<method name="set_size_override">
@ -42,7 +42,7 @@
<return type="void" />
<param index="0" name="source" type="String" />
<description>
Sets SVG source code.
Sets this SVG texture's source code.
</description>
</method>
</methods>

14
doc/classes/DisplayServer.xml
View File

@ -42,7 +42,7 @@
<return type="Variant" />
<param index="0" name="id" type="RID" />
<description>
Returns the metadata of the accessibility element.
Returns the metadata of the accessibility element [param id].
</description>
</method>
<method name="accessibility_element_set_meta">
@ -50,14 +50,14 @@
<param index="0" name="id" type="RID" />
<param index="1" name="meta" type="Variant" />
<description>
Sets the metadata of the accessibility element.
Sets the metadata of the accessibility element [param id] to [param meta].
</description>
</method>
<method name="accessibility_free_element">
<return type="void" />
<param index="0" name="id" type="RID" />
<description>
Frees an object created by [method accessibility_create_element], [method accessibility_create_sub_element], or [method accessibility_create_sub_text_edit_elements].
Frees the accessibility element [param id] created by [method accessibility_create_element], [method accessibility_create_sub_element], or [method accessibility_create_sub_text_edit_elements].
</description>
</method>
<method name="accessibility_get_window_root" qualifiers="const">
@ -870,7 +870,7 @@
<method name="get_primary_screen" qualifiers="const">
<return type="int" />
<description>
Returns index of the primary screen.
Returns the index of the primary screen.
[b]Note:[/b] This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns [code]0[/code].
</description>
</method>
@ -1752,9 +1752,9 @@
<return type="Color" />
<param index="0" name="position" type="Vector2i" />
<description>
Returns color of the display pixel at the [param position].
[b]Note:[/b] This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns [Color].
[b]Note:[/b] On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will only contain the desktop wallpaper, the current application's window, and other related UI elements.
Returns the color of the pixel at the given screen [param position]. On multi-monitor setups, the screen position is relative to the virtual desktop area.
[b]Note:[/b] This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns [code]Color(0, 0, 0, 1)[/code].
[b]Note:[/b] On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a color from a screenshot that will not include other application windows or OS elements not related to the application.
</description>
</method>
<method name="screen_get_position" qualifiers="const">

8
doc/classes/EditorExportPlatform.xml
View File

@ -138,27 +138,27 @@
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns message category, for the message with [param index].
Returns the message category for the message with the given [param index].
</description>
</method>
<method name="get_message_count" qualifiers="const">
<return type="int" />
<description>
Returns number of messages in the export log.
Returns the number of messages in the export log.
</description>
</method>
<method name="get_message_text" qualifiers="const">
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns message text, for the message with [param index].
Returns the text for the message with the given [param index].
</description>
</method>
<method name="get_message_type" qualifiers="const">
<return type="int" enum="EditorExportPlatform.ExportMessageType" />
<param index="0" name="index" type="int" />
<description>
Returns message type, for the message with [param index].
Returns the type for the message with the given [param index].
</description>
</method>
<method name="get_os_name" qualifiers="const">

2
doc/classes/EditorSettings.xml
View File

@ -1258,7 +1258,7 @@
All update modes will ignore builds with different major versions (e.g. Godot 4 -&gt; Godot 5).
</member>
<member name="network/connection/network_mode" type="int" setter="" getter="">
Determines whether online features are enabled in the editor, such as the Asset Library or update checks. Disabling these online features helps alleviate privacy concerns by preventing the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Library.
Determines whether online features, such as the Asset Library or update checks, are enabled in the editor. If this is a privacy concern, disabling these online features prevents the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Library.
Editor plugins and tool scripts are recommended to follow this setting. However, Godot can't prevent them from violating this rule.
</member>
<member name="network/debug/remote_host" type="String" setter="" getter="">

2
doc/classes/EditorToaster.xml
View File

@ -4,7 +4,7 @@
Manages toast notifications within the editor.
</brief_description>
<description>
This object manages the functionality and display of toast notifications within the editor, ensuring timely and informative alerts are presented to users.
This object manages the functionality and display of toast notifications within the editor, ensuring immediate and informative alerts are presented to the user.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_editor_toaster].
</description>
<tutorials>

4
doc/classes/FileAccess.xml
View File

@ -326,14 +326,14 @@
<return type="int" />
<param index="0" name="file" type="String" />
<description>
Returns file size in bytes, or [code]-1[/code] on error.
Returns the size of the file at the given path, in bytes, or [code]-1[/code] on error.
</description>
</method>
<method name="get_unix_permissions" qualifiers="static">
<return type="int" enum="FileAccess.UnixPermissionFlags" is_bitfield="true" />
<param index="0" name="file" type="String" />
<description>
Returns file UNIX permissions.
Returns the UNIX permissions of the file at the given path.
[b]Note:[/b] This method is implemented on iOS, Linux/BSD, and macOS.
</description>
</method>

2
doc/classes/FileDialog.xml
View File

@ -107,7 +107,7 @@
<method name="invalidate">
<return type="void" />
<description>
Invalidate and update the current dialog content list.
Invalidates and updates this dialog's content list.
[b]Note:[/b] This method does nothing on native file dialogs.
</description>
</method>

2
doc/classes/FoldableContainer.xml
View File

@ -50,7 +50,7 @@
If [code]true[/code], the container will becomes folded and will hide all its children.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for text shaping algorithms. If left empty, current locale is used instead.
Language code used for text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="0" />
<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">

2
doc/classes/GeometryInstance3D.xml
View File

@ -31,7 +31,7 @@
</methods>
<members>
<member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance3D.ShadowCastingSetting" default="1">
The selected shadow casting flag.
The mode used to cast shadows from this instance.
</member>
<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb" default="AABB(0, 0, 0, 0, 0, 0)">
Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive [AABB] recalculation that happens when a skeleton is used with a [MeshInstance3D] or to have precise control over the [MeshInstance3D]'s bounding box. To use the default AABB, set value to an [AABB] with all fields set to [code]0.0[/code]. To avoid frustum culling, set [member custom_aabb] to a very large AABB that covers your entire game world such as [code]AABB(-10000, -10000, -10000, 20000, 20000, 20000)[/code]. To disable all forms of culling (including occlusion culling), call [method RenderingServer.instance_set_ignore_culling] on the [GeometryInstance3D]'s [RID].

2
doc/classes/GraphEdit.xml
View File

@ -411,7 +411,7 @@
If [code]true[/code], enables snapping.
</member>
<member name="type_names" type="Dictionary" setter="set_type_names" getter="get_type_names" default="{}">
[Dictionary] of human readable port type names.
[Dictionary] of human-readable port type names.
</member>
<member name="zoom" type="float" setter="set_zoom" getter="get_zoom" default="1.0">
The current zoom value.

4
doc/classes/Image.xml
View File

@ -129,7 +129,7 @@
<param index="2" name="use_mipmaps" type="bool" />
<param index="3" name="format" type="int" enum="Image.Format" />
<description>
Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image. See the [method generate_mipmaps].
Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image (see [method generate_mipmaps]).
</description>
</method>
<method name="create_empty" qualifiers="static">
@ -139,7 +139,7 @@
<param index="2" name="use_mipmaps" type="bool" />
<param index="3" name="format" type="int" enum="Image.Format" />
<description>
Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image. See the [method generate_mipmaps].
Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image (see [method generate_mipmaps]).
</description>
</method>
<method name="create_from_data" qualifiers="static">

2
doc/classes/ItemList.xml
View File

@ -315,7 +315,7 @@
<param index="0" name="idx" type="int" />
<param index="1" name="language" type="String" />
<description>
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets the language code of the text for the item at the given index to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
</description>
</method>
<method name="set_item_metadata">

2
doc/classes/Label.xml
View File

@ -68,7 +68,7 @@
A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="lines_skipped" type="int" setter="set_lines_skipped" getter="get_lines_skipped" default="0">
The number of the lines ignored and not displayed from the start of the [member text] value.

2
doc/classes/Label3D.xml
View File

@ -79,7 +79,7 @@
Line fill alignment rules.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="line_spacing" type="float" setter="set_line_spacing" getter="get_line_spacing" default="0.0">
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

2
doc/classes/LineEdit.xml
View File

@ -317,7 +317,7 @@
If [code]true[/code], the [LineEdit] will not exit edit mode when text is submitted by pressing [code]ui_text_submit[/code] action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]).
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length" default="0">
Maximum number of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.

2
doc/classes/LinkButton.xml
View File

@ -15,7 +15,7 @@
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="3" />
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" overrides="Control" enum="Control.CursorShape" default="2" />
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0">

2
doc/classes/MenuBar.xml
View File

@ -102,7 +102,7 @@
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="3" />
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="prefer_global_menu" type="bool" setter="set_prefer_global_menu" getter="is_prefer_global_menu" default="true">
If [code]true[/code], [MenuBar] will use system global menu when supported.

2
doc/classes/Node.xml
View File

@ -764,7 +764,7 @@
<return type="void" />
<description>
Prints all orphan nodes (nodes outside the [SceneTree]). Useful for debugging.
[b]Note:[/b] This method only works in debug builds. Does nothing in a project exported in release mode.
[b]Note:[/b] This method only works in debug builds. It does nothing in a project exported in release mode.
</description>
</method>
<method name="print_tree">

2
doc/classes/Object.xml
View File

@ -530,7 +530,7 @@
A signal can only be connected once to the same [Callable]. If the signal is already connected, this method returns [constant ERR_INVALID_PARAMETER] and generates an error, unless the signal is connected with [constant CONNECT_REFERENCE_COUNTED]. To prevent this, use [method is_connected] first to check for existing connections.
[b]Note:[/b] If the [param callable]'s object is freed, the connection will be lost.
[b]Note:[/b] In GDScript, it is generally recommended to connect signals with [method Signal.connect] instead.
[b]Note:[/b] This operation (and all other signal related operations) is thread-safe.
[b]Note:[/b] This method, and all other signal-related methods, are thread-safe.
</description>
</method>
<method name="disconnect">

2
doc/classes/PackedByteArray.xml
View File

@ -342,7 +342,7 @@
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the byte at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0[/code].
Returns the byte at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedColorArray.xml
View File

@ -105,7 +105,7 @@
<return type="Color" />
<param index="0" name="index" type="int" />
<description>
Returns the [Color] at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]Color(0, 0, 0, 1)[/code].
Returns the [Color] at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]Color(0, 0, 0, 1)[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedFloat32Array.xml
View File

@ -105,7 +105,7 @@
<return type="float" />
<param index="0" name="index" type="int" />
<description>
Returns the 32-bit float at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0.0[/code].
Returns the 32-bit float at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]0.0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedFloat64Array.xml
View File

@ -106,7 +106,7 @@
<return type="float" />
<param index="0" name="index" type="int" />
<description>
Returns the 64-bit float at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0.0[/code].
Returns the 64-bit float at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]0.0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedInt32Array.xml
View File

@ -101,7 +101,7 @@
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the 32-bit integer at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0[/code].
Returns the 32-bit integer at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedInt64Array.xml
View File

@ -102,7 +102,7 @@
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the 64-bit integer at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0[/code].
Returns the 64-bit integer at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

4
doc/classes/PackedStringArray.xml
View File

@ -108,8 +108,8 @@
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns the [String] at the given [param index] in the array. Returns an empty string and prints an error if the access is out of bounds. Negative indices are not supported; they will always consider the value to be out of bounds and return an empty string.
This is similar to using the [code][][/code] operator ([code]array[index][/code]), except that operator supports negative indices and causes a debugger break if out-of-bounds access is performed.
Returns the [String] at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns an empty string.
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>
<method name="has" qualifiers="const">

2
doc/classes/PackedVector2Array.xml
View File

@ -110,7 +110,7 @@
<return type="Vector2" />
<param index="0" name="index" type="int" />
<description>
Returns the [Vector2] at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]Vector2(0, 0)[/code].
Returns the [Vector2] at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]Vector2(0, 0)[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedVector3Array.xml
View File

@ -109,7 +109,7 @@
<return type="Vector3" />
<param index="0" name="index" type="int" />
<description>
Returns the [Vector3] at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]Vector3(0, 0, 0)[/code].
Returns the [Vector3] at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]Vector3(0, 0, 0)[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PackedVector4Array.xml
View File

@ -109,7 +109,7 @@
<return type="Vector4" />
<param index="0" name="index" type="int" />
<description>
Returns the [Vector4] at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]Vector4(0, 0, 0, 0)[/code].
Returns the [Vector4] at the given [param index] in the array. If [param index] is out-of-bounds or negative, this method fails and returns [code]Vector4(0, 0, 0, 0)[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>

2
doc/classes/PopupMenu.xml
View File

@ -541,7 +541,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="language" type="String" />
<description>
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets the language code of the text for the item at the given index to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
</description>
</method>
<method name="set_item_metadata">

9
doc/classes/PortableCompressedTexture2D.xml
View File

@ -49,7 +49,7 @@
<param index="1" name="rdo_quality_loss" type="float" />
<description>
Sets the compressor parameters for Basis Universal compression. See also the settings in [ResourceImporterTexture].
[b]Note:[/b] This must be set before [method create_from_image] to take effect.
[b]Note:[/b] This method must be called before [method create_from_image] for this to work.
</description>
</method>
<method name="set_keep_all_compressed_buffers" qualifiers="static">
@ -62,13 +62,12 @@
</methods>
<members>
<member name="keep_compressed_buffer" type="bool" setter="set_keep_compressed_buffer" getter="is_keeping_compressed_buffer" default="false">
When running on the editor, this class will keep the source compressed data in memory. Otherwise, the source compressed data is lost after loading and the resource can't be re saved.
This flag allows to keep the compressed data in memory if you intend it to persist after loading.
[b]Note:[/b] This must be set before [method create_from_image] to take effect.
If [code]true[/code], when running in the editor, this texture will keep the source-compressed data in memory, allowing the data to persist after loading. Otherwise, the source-compressed data is lost after loading and the texture can't be re-saved.
[b]Note:[/b] This property must be set before [method create_from_image] for this to work.
</member>
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />
<member name="size_override" type="Vector2" setter="set_size_override" getter="get_size_override" default="Vector2(0, 0)">
Allow overriding the texture size (for 2D only).
Allows overriding the texture's size (for 2D only).
</member>
</members>
<constants>

12
doc/classes/ProjectSettings.xml
View File

@ -3309,15 +3309,15 @@
- [code]d3d12[/code], Direct3D 12 from native drivers. If [member rendering/rendering_device/fallback_to_d3d12] is enabled, this is used as a fallback if Vulkan is not supported.
</member>
<member name="rendering/rendering_device/fallback_to_d3d12" type="bool" setter="" getter="" default="true">
If [code]true[/code], the forward renderer will fall back to Direct3D 12 if Vulkan is not supported. The fallback is always attempted regardless of this setting if Vulkan driver support was disabled at compile time.
If [code]true[/code], the Forward+ renderer will fall back to Direct3D 12 if Vulkan is not supported. The fallback is always attempted regardless of this setting if Vulkan driver support was disabled at compile time.
[b]Note:[/b] This setting is implemented only on Windows.
</member>
<member name="rendering/rendering_device/fallback_to_opengl3" type="bool" setter="" getter="" default="true">
If [code]true[/code], the forward renderer will fall back to OpenGL 3 if Direct3D 12, Metal, and Vulkan are not supported.
If [code]true[/code], the Forward+ renderer will fall back to OpenGL 3 if Direct3D 12, Metal, and Vulkan are not supported.
[b]Note:[/b] This setting is implemented on Windows, Android, macOS, iOS, and Linux/X11.
</member>
<member name="rendering/rendering_device/fallback_to_vulkan" type="bool" setter="" getter="" default="true">
If [code]true[/code], the forward renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. The fallback is always attempted regardless of this setting if Direct3D 12 (Windows) or Metal (macOS) driver support was disabled at compile time.
If [code]true[/code], the Forward+ renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. The fallback is always attempted regardless of this setting if Direct3D 12 (Windows) or Metal (macOS) driver support was disabled at compile time.
[b]Note:[/b] This setting is implemented on Windows and macOS.
</member>
<member name="rendering/rendering_device/pipeline_cache/enable" type="bool" setter="" getter="" default="true">
@ -3443,7 +3443,7 @@
If [code]true[/code], the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP.
</member>
<member name="rendering/textures/vram_compression/cache_gpu_compressor" type="bool" setter="" getter="" default="true">
If [code]true[/code], the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), allowing for faster subsequent imports at a memory cost.
If [code]true[/code], the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), making subsequent imports faster at the cost of increased memory usage.
</member>
<member name="rendering/textures/vram_compression/compress_with_gpu" type="bool" setter="" getter="" default="true">
If [code]true[/code], the texture importer will utilize the GPU for compressing textures, improving the import time of large images.
@ -3498,7 +3498,7 @@
The ratio of [WorkerThreadPool]'s threads that will be reserved for low-priority tasks. For example, if 10 threads are available and this value is set to [code]0.3[/code], 3 of the worker threads will be reserved for low-priority tasks. The actual value won't exceed the number of CPU cores minus one, and if possible, at least one worker thread will be dedicated to low-priority tasks.
</member>
<member name="threading/worker_pool/max_threads" type="int" setter="" getter="" default="-1">
Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means [code]1[/code] on Web, or a number of [i]logical[/i] CPU cores available on other platforms (see [method OS.get_processor_count]).
Maximum number of threads to be used by [WorkerThreadPool]. On Web, a value of [code]-1[/code] means [code]1[/code]. On other platforms, it means all [i]logical[/i] CPU cores available (see [method OS.get_processor_count]).
</member>
<member name="xr/openxr/binding_modifiers/analog_threshold" type="bool" setter="" getter="" default="false">
If [code]true[/code], enables the analog threshold binding modifier if supported by the XR runtime.
@ -3592,7 +3592,7 @@
If [code]true[/code] and foveation is supported, will automatically adjust foveation level based on framerate up to the level set on [member xr/openxr/foveation_level].
</member>
<member name="xr/openxr/foveation_level" type="int" setter="" getter="" default="&quot;0&quot;">
Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high.
Applied foveation level if supported.
[b]Note:[/b] On platforms other than Android, if [member rendering/anti_aliasing/quality/msaa_3d] is enabled, this feature will be disabled.
</member>
<member name="xr/openxr/reference_space" type="int" setter="" getter="" default="&quot;1&quot;">

2
doc/classes/RenderingServer.xml
View File

@ -3793,7 +3793,7 @@
<param index="7" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" default="0" />
<description>
Creates a texture based on a native handle that was created outside of Godot's renderer.
[b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. It will give you much more control over the texture's format and usage.
[b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. This way, the texture's format and usage can be controlled more effectively.
</description>
</method>
<method name="texture_get_format" qualifiers="const">

8
doc/classes/RichTextLabel.xml
View File

@ -580,7 +580,7 @@
<return type="void" />
<param index="0" name="color" type="Color" default="Color(0, 0, 0, 0)" />
<description>
Adds a [code skip-lint][s][/code] tag to the tag stack. If [param color] alpha value is zero, current font color with alpha multiplied by [theme_item strikethrough_alpha] is used.
Adds a [code skip-lint][s][/code] tag to the tag stack. If [param color]'s alpha value is [code]0.0[/code], the current font's color with its alpha multiplied by [theme_item strikethrough_alpha] is used.
</description>
</method>
<method name="push_table">
@ -597,7 +597,7 @@
<return type="void" />
<param index="0" name="color" type="Color" default="Color(0, 0, 0, 0)" />
<description>
Adds a [code skip-lint][u][/code] tag to the tag stack. If [param color] alpha value is zero, current font color with alpha multiplied by [theme_item underline_alpha] is used.
Adds a [code skip-lint][u][/code] tag to the tag stack. If [param color]'s alpha value is [code]0.0[/code], the current font's color with its alpha multiplied by [theme_item underline_alpha] is used.
</description>
</method>
<method name="reload_effects">
@ -745,13 +745,13 @@
If [code]true[/code], the label underlines hint tags such as [code skip-lint][hint=description]{text}[/hint][/code].
</member>
<member name="horizontal_alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify.
Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify).
</member>
<member name="justification_flags" type="int" setter="set_justification_flags" getter="get_justification_flags" enum="TextServer.JustificationFlag" is_bitfield="true" default="163">
Line fill alignment rules.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined" default="true" keywords="url_underlined">
If [code]true[/code], the label underlines meta tags such as [code skip-lint][url]{text}[/url][/code]. These tags can call a function when clicked if [signal meta_clicked] is connected to a function.

6
doc/classes/RigidBody2D.xml
View File

@ -168,11 +168,11 @@
<member name="freeze" type="bool" setter="set_freeze_enabled" getter="is_freeze_enabled" default="false">
If [code]true[/code], the body is frozen. Gravity and forces are not applied anymore.
See [member freeze_mode] to set the body's behavior when frozen.
For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead.
[b]Note:[/b] For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead.
</member>
<member name="freeze_mode" type="int" setter="set_freeze_mode" getter="get_freeze_mode" enum="RigidBody2D.FreezeMode" default="0">
The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled.
For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead.
The body's freeze mode. Determines the body's behavior when [member freeze] is [code]true[/code].
[b]Note:[/b] For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead.
</member>
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0">
Multiplies the gravity applied to the body. The body's gravity is calculated from the [member ProjectSettings.physics/2d/default_gravity] project setting and/or any additional gravity vector applied by [Area2D]s.

6
doc/classes/RigidBody3D.xml
View File

@ -174,11 +174,11 @@
<member name="freeze" type="bool" setter="set_freeze_enabled" getter="is_freeze_enabled" default="false">
If [code]true[/code], the body is frozen. Gravity and forces are not applied anymore.
See [member freeze_mode] to set the body's behavior when frozen.
For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead.
[b]Note:[/b] For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead.
</member>
<member name="freeze_mode" type="int" setter="set_freeze_mode" getter="get_freeze_mode" enum="RigidBody3D.FreezeMode" default="0">
The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled.
For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead.
The body's freeze mode. Determines the body's behavior when [member freeze] is [code]true[/code].
[b]Note:[/b] For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead.
</member>
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0">
This is multiplied by [member ProjectSettings.physics/3d/default_gravity] to produce this body's gravity. For example, a value of [code]1.0[/code] will apply normal gravity, [code]2.0[/code] will apply double the gravity, and [code]0.5[/code] will apply half the gravity to this body.

2
doc/classes/Script.xml
View File

@ -87,7 +87,7 @@
<method name="get_script_signal_list">
<return type="Dictionary[]" />
<description>
Returns the list of user signals defined in this [Script].
Returns the list of signals defined in this [Script].
[b]Note:[/b] The dictionaries returned by this method are formatted identically to those returned by [method Object.get_signal_list].
</description>
</method>

3
doc/classes/Sprite2D.xml
View File

@ -44,8 +44,7 @@
<return type="bool" />
<param index="0" name="pos" type="Vector2" />
<description>
Returns [code]true[/code], if the pixel at the given position is opaque and [code]false[/code] in other case. The position is in local coordinates.
[b]Note:[/b] It also returns [code]false[/code], if the sprite's texture is [code]null[/code] or if the given position is invalid.
Returns [code]true[/code] if the pixel at the given position is opaque, [code]false[/code] otherwise. Also returns [code]false[/code] if the given position is out of bounds or this sprite's [member texture] is [code]null[/code]. [param pos] is in local coordinates.
</description>
</method>
</methods>

4
doc/classes/StreamPeer.xml
View File

@ -44,7 +44,7 @@
<return type="Array" />
<param index="0" name="bytes" type="int" />
<description>
Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the [param bytes] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum Error] code and a data array.
Returns a chunk data with the received bytes, as an [Array] containing two elements: an [enum Error] constant and a [PackedByteArray]. [param bytes] is the number of bytes to be received. If not enough bytes are available, the function will block until the desired amount is received.
</description>
</method>
<method name="get_double">
@ -69,7 +69,7 @@
<return type="Array" />
<param index="0" name="bytes" type="int" />
<description>
Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the [param bytes] argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values: an [enum Error] code and a data array.
Returns a chunk data with the received bytes, as an [Array] containing two elements: an [enum Error] constant and a [PackedByteArray]. [param bytes] is the number of bytes to be received. If not enough bytes are available, the function will return how many were actually received.
</description>
</method>
<method name="get_string">

16
doc/classes/TabBar.xml
View File

@ -204,7 +204,7 @@
<param index="0" name="tab_idx" type="int" />
<param index="1" name="language" type="String" />
<description>
Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets the language code of the title for the tab at index [param tab_idx] to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
</description>
</method>
<method name="set_tab_metadata">
@ -246,7 +246,7 @@
If [code]true[/code], tabs overflowing this node's width will be hidden, displaying two navigation buttons instead. Otherwise, this node's minimum size is updated so that all tabs are visible.
</member>
<member name="close_with_middle_mouse" type="bool" setter="set_close_with_middle_mouse" getter="get_close_with_middle_mouse" default="true">
If [code]true[/code], middle clicking on the mouse will fire the [signal tab_close_pressed] signal.
If [code]true[/code], middle-clicking on a tab will emit the [signal tab_close_pressed] signal.
</member>
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="-1">
The index of the current selected tab. A value of [code]-1[/code] means that no tab is selected and can only be set when [member deselect_enabled] is [code]true[/code] or if all tabs are hidden or disabled.
@ -274,7 +274,7 @@
If [code]true[/code], hovering over a tab while dragging something will switch to that tab. Does not have effect when hovering another tab to rearrange. The delay for when this happens is dictated by [theme_item hover_switch_wait_msec].
</member>
<member name="tab_alignment" type="int" setter="set_tab_alignment" getter="get_tab_alignment" enum="TabBar.AlignmentMode" default="0">
The position at which tabs will be placed.
The horizontal alignment of the tabs.
</member>
<member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="TabBar.CloseButtonDisplayPolicy" default="0">
When the close button will appear on the tabs.
@ -315,8 +315,8 @@
<signal name="tab_close_pressed">
<param index="0" name="tab" type="int" />
<description>
Emitted when a tab's close button is pressed or when middle-clicking on a tab, if [member close_with_middle_mouse] is enabled.
[b]Note:[/b] Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example:
Emitted when a tab's close button is pressed or, if [member close_with_middle_mouse] is [code]true[/code], when middle-clicking on a tab.
[b]Note:[/b] Tabs are not removed automatically; this behavior needs to be coded manually. For example:
[codeblocks]
[gdscript]
$TabBar.tab_close_pressed.connect($TabBar.remove_tab)
@ -348,13 +348,13 @@
</signals>
<constants>
<constant name="ALIGNMENT_LEFT" value="0" enum="AlignmentMode">
Places tabs to the left.
Aligns tabs to the left.
</constant>
<constant name="ALIGNMENT_CENTER" value="1" enum="AlignmentMode">
Places tabs in the middle.
Aligns tabs in the middle.
</constant>
<constant name="ALIGNMENT_RIGHT" value="2" enum="AlignmentMode">
Places tabs to the right.
Aligns tabs to the right.
</constant>
<constant name="ALIGNMENT_MAX" value="3" enum="AlignmentMode">
Represents the size of the [enum AlignmentMode] enum.

2
doc/classes/TabContainer.xml
View File

@ -233,7 +233,7 @@
The focus access mode for the internal [TabBar] node.
</member>
<member name="tabs_position" type="int" setter="set_tabs_position" getter="get_tabs_position" enum="TabContainer.TabPosition" default="0">
The position of the tab bar.
The horizontal alignment of the tabs.
</member>
<member name="tabs_rearrange_group" type="int" setter="set_tabs_rearrange_group" getter="get_tabs_rearrange_group" default="-1">
[TabContainer]s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with [member drag_to_rearrange_enabled].

2
doc/classes/TextEdit.xml
View File

@ -1350,7 +1350,7 @@
If [code]true[/code], all wrapped lines are indented to the same amount as the unwrapped line.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="middle_mouse_paste_enabled" type="bool" setter="set_middle_mouse_paste_enabled" getter="is_middle_mouse_paste_enabled" default="true">
If [code]false[/code], using middle mouse button to paste clipboard will be disabled.

4
doc/classes/TextMesh.xml
View File

@ -30,13 +30,13 @@
[b]Note:[/b] Changing this property will regenerate the mesh, which is a slow operation, especially with large font sizes and long texts. To change the text's size in real-time efficiently, change the node's [member Node3D.scale] instead.
</member>
<member name="horizontal_alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="1">
Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify.
Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify).
</member>
<member name="justification_flags" type="int" setter="set_justification_flags" getter="get_justification_flags" enum="TextServer.JustificationFlag" is_bitfield="true" default="163">
Line fill alignment rules.
</member>
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for text shaping algorithms, if left empty current locale is used instead.
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
</member>
<member name="line_spacing" type="float" setter="set_line_spacing" getter="get_line_spacing" default="0.0">
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

14
doc/classes/TextServer.xml
View File

@ -214,7 +214,7 @@
<method name="font_get_global_oversampling" qualifiers="const" deprecated="Use [Viewport] oversampling, or the [code skip-lint]oversampling[/code] argument of the [code skip-lint]draw_*[/code] methods instead.">
<return type="float" />
<description>
Deprecated. This method always returns [code]1.0[/code].
This method does nothing and always returns [code]1.0[/code].
</description>
</method>
<method name="font_get_glyph_advance" qualifiers="const">
@ -790,7 +790,7 @@
<return type="void" />
<param index="0" name="oversampling" type="float" />
<description>
Deprecated. This method does nothing.
This method does nothing.
</description>
</method>
<method name="font_set_glyph_advance">
@ -1194,7 +1194,7 @@
<return type="int" />
<param index="0" name="name" type="String" />
<description>
Converts readable feature, variation, script, or language name to OpenType tag.
Converts the given readable name of a feature, variation, script, or language to an OpenType tag.
</description>
</method>
<method name="parse_number" qualifiers="const" deprecated="Use [method TranslationServer.parse_number] instead.">
@ -1930,7 +1930,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
<description>
Returns the string converted to lowercase.
Returns the string converted to [code]lowercase[/code].
[b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] The result may be longer or shorter than the original.
</description>
@ -1940,7 +1940,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
<description>
Returns the string converted to title case.
Returns the string converted to [code]Title Case[/code].
[b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] The result may be longer or shorter than the original.
</description>
@ -1950,7 +1950,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
<description>
Returns the string converted to uppercase.
Returns the string converted to [code]UPPERCASE[/code].
[b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] The result may be longer or shorter than the original.
</description>
@ -1967,7 +1967,7 @@
<return type="String" />
<param index="0" name="tag" type="int" />
<description>
Converts OpenType tag to readable feature, variation, script, or language name.
Converts the given OpenType tag to the readable name of a feature, variation, script, or language.
</description>
</method>
</methods>

10
doc/classes/TextServerExtension.xml
View File

@ -1161,7 +1161,7 @@
<return type="int" />
<param index="0" name="name" type="String" />
<description>
Converts readable feature, variation, script, or language name to OpenType tag.
Converts the given readable name of a feature, variation, script, or language to an OpenType tag.
</description>
</method>
<method name="_parse_number" qualifiers="virtual const" deprecated="Use [method TranslationServer.parse_number] instead.">
@ -1886,7 +1886,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" />
<description>
Returns the string converted to lowercase.
Returns the string converted to [code]lowercase[/code].
</description>
</method>
<method name="_string_to_title" qualifiers="virtual const">
@ -1894,7 +1894,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" />
<description>
Returns the string converted to title case.
Returns the string converted to [code]Title Case[/code].
</description>
</method>
<method name="_string_to_upper" qualifiers="virtual const">
@ -1902,7 +1902,7 @@
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" />
<description>
Returns the string converted to uppercase.
Returns the string converted to [code]UPPERCASE[/code].
</description>
</method>
<method name="_strip_diacritics" qualifiers="virtual const">
@ -1916,7 +1916,7 @@
<return type="String" />
<param index="0" name="tag" type="int" />
<description>
Converts OpenType tag to readable feature, variation, script, or language name.
Converts the given OpenType tag to the readable name of a feature, variation, script, or language.
</description>
</method>
<method name="_unreference_oversampling_level" qualifiers="virtual">

2
doc/classes/Tree.xml
View File

@ -326,7 +326,7 @@
<param index="0" name="column" type="int" />
<param index="1" name="language" type="String" />
<description>
Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets the language code of the given [param column]'s title to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
</description>
</method>
<method name="set_column_title_tooltip_text">

2
doc/classes/TreeItem.xml
View File

@ -763,7 +763,7 @@
<param index="0" name="column" type="int" />
<param index="1" name="language" type="String" />
<description>
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets the language code of the given [param column]'s text to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
</description>
</method>
<method name="set_metadata">

8
doc/classes/Viewport.xml
View File

@ -169,7 +169,7 @@
<method name="gui_get_drag_description" qualifiers="const">
<return type="String" />
<description>
Returns the drag data human-readable description.
Returns the human-readable description of the drag data, used for assistive apps.
</description>
</method>
<method name="gui_get_focus_owner" qualifiers="const">
@ -208,7 +208,7 @@
<return type="void" />
<param index="0" name="description" type="String" />
<description>
Sets the drag data human-readable description.
Sets the human-readable description of the drag data to [param description], used for assistive apps.
</description>
</method>
<method name="is_input_handled" qualifiers="const">
@ -329,10 +329,10 @@
The rendering layers in which this [Viewport] renders [CanvasItem] nodes.
</member>
<member name="canvas_item_default_texture_filter" type="int" setter="set_default_canvas_item_texture_filter" getter="get_default_canvas_item_texture_filter" enum="Viewport.DefaultCanvasItemTextureFilter" default="1">
Sets the default filter mode used by [CanvasItem]s in this Viewport.
The default filter mode used by [CanvasItem] nodes in this viewport.
</member>
<member name="canvas_item_default_texture_repeat" type="int" setter="set_default_canvas_item_texture_repeat" getter="get_default_canvas_item_texture_repeat" enum="Viewport.DefaultCanvasItemTextureRepeat" default="0">
Sets the default repeat mode used by [CanvasItem]s in this Viewport.
The default repeat mode used by [CanvasItem] nodes in this viewport.
</member>
<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.

4
doc/classes/VoxelGI.xml
View File

@ -40,8 +40,8 @@
The [VoxelGIData] resource that holds the data for this [VoxelGI].
</member>
<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(20, 20, 20)">
The size of the area covered by the [VoxelGI]. If you make the size larger without increasing the subdivisions with [member subdiv], the size of each cell will increase and result in lower detailed lighting.
[b]Note:[/b] Size is clamped to 1.0 unit or more on each axis.
The size of the area covered by the [VoxelGI]. This must be [code]1.0[/code] or greater on each axis.
[b]Note:[/b] If you make the size larger without increasing the number of subdivisions with [member subdiv], the size of each cell will increase and result in less detailed lighting.
</member>
<member name="subdiv" type="int" setter="set_subdiv" getter="get_subdiv" enum="VoxelGI.Subdiv" default="1">
Number of times to subdivide the grid that the [VoxelGI] operates on. A higher number results in finer detail and thus higher visual quality, while lower numbers result in better performance.

2
doc/classes/Window.xml
View File

@ -362,7 +362,7 @@
<method name="move_to_center">
<return type="void" />
<description>
Centers a native window on the current screen and an embedded window on its embedder [Viewport].
Centers the window in the current screen. If the window is embedded, it is centered in the embedder [Viewport] instead.
</description>
</method>
<method name="move_to_foreground" deprecated="Use [method Window.grab_focus] instead.">