Skip to content

Commit 6df0ff0

Browse files
committed
Fix miscellaneous oddities around the class reference (part 6)
1 parent 019ab87 commit 6df0ff0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+123
-123
lines changed

doc/classes/Array.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@
435435
<return type="Variant" />
436436
<param index="0" name="index" type="int" />
437437
<description>
438-
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].
438+
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].
439439
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.
440440
</description>
441441
</method>

doc/classes/BaseMaterial3D.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,37 @@
1414
<return type="bool" />
1515
<param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
1616
<description>
17-
Returns [code]true[/code], if the specified [enum Feature] is enabled.
17+
Returns [code]true[/code] if the specified [param feature] is enabled.
1818
</description>
1919
</method>
2020
<method name="get_flag" qualifiers="const">
2121
<return type="bool" />
2222
<param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
2323
<description>
24-
Returns [code]true[/code] if the specified flag is enabled.
24+
Returns [code]true[/code] if the specified [param flag] is enabled.
2525
</description>
2626
</method>
2727
<method name="get_texture" qualifiers="const">
2828
<return type="Texture2D" />
2929
<param index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
3030
<description>
31-
Returns the [Texture2D] associated with the specified [enum TextureParam].
31+
Returns the [Texture2D] associated with the specified texture [param param].
3232
</description>
3333
</method>
3434
<method name="set_feature">
3535
<return type="void" />
3636
<param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
3737
<param index="1" name="enable" type="bool" />
3838
<description>
39-
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].
39+
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].
4040
</description>
4141
</method>
4242
<method name="set_flag">
4343
<return type="void" />
4444
<param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
4545
<param index="1" name="enable" type="bool" />
4646
<description>
47-
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].
47+
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].
4848
</description>
4949
</method>
5050
<method name="set_texture">

doc/classes/Button.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
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.
6767
</member>
6868
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
69-
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
69+
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
7070
</member>
7171
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
7272
The button's text that will be displayed inside the button's area.

doc/classes/Color.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -365,14 +365,14 @@
365365
<return type="Color" />
366366
<description>
367367
Returns the color converted to the [url=https://en.wikipedia.org/wiki/SRGB]sRGB[/url] color space. This method assumes the original color is in the linear color space. See also [method srgb_to_linear] which performs the opposite operation.
368-
[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 color space of the other color channels.
368+
[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.
369369
</description>
370370
</method>
371371
<method name="srgb_to_linear" qualifiers="const">
372372
<return type="Color" />
373373
<description>
374374
Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. See also [method linear_to_srgb] which performs the opposite operation.
375-
[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 color space of the other color channels.
375+
[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.
376376
</description>
377377
</method>
378378
<method name="to_abgr32" qualifiers="const">

doc/classes/Control.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
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.
1313
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.
1414
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.
15-
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.
15+
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.
1616
[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.
1717
[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.
1818
</description>

doc/classes/DisplayServer.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@
4242
<return type="Variant" />
4343
<param index="0" name="id" type="RID" />
4444
<description>
45-
Returns the metadata of the accessibility element.
45+
Returns the metadata of the accessibility element [param id].
4646
</description>
4747
</method>
4848
<method name="accessibility_element_set_meta">
4949
<return type="void" />
5050
<param index="0" name="id" type="RID" />
5151
<param index="1" name="meta" type="Variant" />
5252
<description>
53-
Sets the metadata of the accessibility element.
53+
Sets the metadata of the accessibility element [param id] to [param meta].
5454
</description>
5555
</method>
5656
<method name="accessibility_free_element">
5757
<return type="void" />
5858
<param index="0" name="id" type="RID" />
5959
<description>
60-
Frees an object created by [method accessibility_create_element], [method accessibility_create_sub_element], or [method accessibility_create_sub_text_edit_elements].
60+
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].
6161
</description>
6262
</method>
6363
<method name="accessibility_get_window_root" qualifiers="const">
@@ -870,7 +870,7 @@
870870
<method name="get_primary_screen" qualifiers="const">
871871
<return type="int" />
872872
<description>
873-
Returns index of the primary screen.
873+
Returns the index of the primary screen.
874874
[b]Note:[/b] This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns [code]0[/code].
875875
</description>
876876
</method>
@@ -1752,9 +1752,9 @@
17521752
<return type="Color" />
17531753
<param index="0" name="position" type="Vector2i" />
17541754
<description>
1755-
Returns color of the display pixel at the [param position].
1756-
[b]Note:[/b] This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns [Color].
1757-
[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.
1755+
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.
1756+
[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].
1757+
[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.
17581758
</description>
17591759
</method>
17601760
<method name="screen_get_position" qualifiers="const">

doc/classes/EditorExportPlatform.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,27 +138,27 @@
138138
<return type="String" />
139139
<param index="0" name="index" type="int" />
140140
<description>
141-
Returns message category, for the message with [param index].
141+
Returns the message category for the message with the given [param index].
142142
</description>
143143
</method>
144144
<method name="get_message_count" qualifiers="const">
145145
<return type="int" />
146146
<description>
147-
Returns number of messages in the export log.
147+
Returns the number of messages in the export log.
148148
</description>
149149
</method>
150150
<method name="get_message_text" qualifiers="const">
151151
<return type="String" />
152152
<param index="0" name="index" type="int" />
153153
<description>
154-
Returns message text, for the message with [param index].
154+
Returns the text for the message with the given [param index].
155155
</description>
156156
</method>
157157
<method name="get_message_type" qualifiers="const">
158158
<return type="int" enum="EditorExportPlatform.ExportMessageType" />
159159
<param index="0" name="index" type="int" />
160160
<description>
161-
Returns message type, for the message with [param index].
161+
Returns the type for the message with the given [param index].
162162
</description>
163163
</method>
164164
<method name="get_os_name" qualifiers="const">

doc/classes/EditorSettings.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1154,7 +1154,7 @@
11541154
All update modes will ignore builds with different major versions (e.g. Godot 4 -&gt; Godot 5).
11551155
</member>
11561156
<member name="network/connection/network_mode" type="int" setter="" getter="">
1157-
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.
1157+
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.
11581158
</member>
11591159
<member name="network/debug/remote_host" type="String" setter="" getter="">
11601160
The address to listen to when starting the remote debugger. This can be set to this device's local IP address to allow external clients to connect to the remote debugger (instead of restricting the remote debugger to connections from [code]localhost[/code]).

doc/classes/EditorToaster.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Manages toast notifications within the editor.
55
</brief_description>
66
<description>
7-
This object manages the functionality and display of toast notifications within the editor, ensuring timely and informative alerts are presented to users.
7+
This object manages the functionality and display of toast notifications within the editor, ensuring immediate and informative alerts are presented to the user.
88
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_editor_toaster].
99
</description>
1010
<tutorials>

doc/classes/FileAccess.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,14 +293,14 @@
293293
<return type="int" />
294294
<param index="0" name="file" type="String" />
295295
<description>
296-
Returns file size in bytes, or [code]-1[/code] on error.
296+
Returns the size of the file at the given path, in bytes, or [code]-1[/code] on error.
297297
</description>
298298
</method>
299299
<method name="get_unix_permissions" qualifiers="static">
300300
<return type="int" enum="FileAccess.UnixPermissionFlags" is_bitfield="true" />
301301
<param index="0" name="file" type="String" />
302302
<description>
303-
Returns file UNIX permissions.
303+
Returns the UNIX permissions of the file at the given path.
304304
[b]Note:[/b] This method is implemented on iOS, Linux/BSD, and macOS.
305305
</description>
306306
</method>

0 commit comments

Comments
 (0)