Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/classes/Array.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
10 changes: 5 additions & 5 deletions doc/classes/BaseMaterial3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,37 +14,37 @@
<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">
<return type="void" />
<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">
<return type="void" />
<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">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Button.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/Color.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Control.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/DPITexture.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand All @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/DisplayServer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@
<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">
<return type="void" />
<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">
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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">
Expand Down
8 changes: 4 additions & 4 deletions doc/classes/EditorExportPlatform.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/EditorSettings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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="">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/EditorToaster.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/FileAccess.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment on lines 327 to +329
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, file is actually a file path. Put a pin on this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it should be changed to path, renaming argument is not breaking change.

</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>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/FileDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/FoldableContainer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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;">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/GeometryInstance3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternative which I am genuinely not sure.

Suggested change
The mode used to cast shadows from this instance.
The way in which this instance casts shadows.

</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].
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/GraphEdit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/Image.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ItemList.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Label.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
Loading