Minor grammar fixes to documentation

This commit is contained in:
Ninni Pipping 2023-05-28 18:10:39 +02:00
parent 28cca66d2c
commit 17fb77223c
8 changed files with 12 additions and 12 deletions

View File

@ -829,7 +829,7 @@
Converts one or more arguments of any type to string in the best way possible and prints them to the console. Converts one or more arguments of any type to string in the best way possible and prints them to the console.
The following BBCode tags are supported: [code]b[/code], [code]i[/code], [code]u[/code], [code]s[/code], [code]indent[/code], [code]code[/code], [code]url[/code], [code]center[/code], [code]right[/code], [code]color[/code], [code]bgcolor[/code], [code]fgcolor[/code]. The following BBCode tags are supported: [code]b[/code], [code]i[/code], [code]u[/code], [code]s[/code], [code]indent[/code], [code]code[/code], [code]url[/code], [code]center[/code], [code]right[/code], [code]color[/code], [code]bgcolor[/code], [code]fgcolor[/code].
Color tags only support the following named colors: [code]black[/code], [code]red[/code], [code]green[/code], [code]yellow[/code], [code]blue[/code], [code]magenta[/code], [code]pink[/code], [code]purple[/code], [code]cyan[/code], [code]white[/code], [code]orange[/code], [code]gray[/code]. Hexadecimal color codes are not supported. Color tags only support the following named colors: [code]black[/code], [code]red[/code], [code]green[/code], [code]yellow[/code], [code]blue[/code], [code]magenta[/code], [code]pink[/code], [code]purple[/code], [code]cyan[/code], [code]white[/code], [code]orange[/code], [code]gray[/code]. Hexadecimal color codes are not supported.
URL tags only support URLs wrapped by an URL tag, not URLs with a different title. URL tags only support URLs wrapped by a URL tag, not URLs with a different title.
When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, [code]code[/code] is represented with faint text but without any font change. Unsupported tags are left as-is in standard output. When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, [code]code[/code] is represented with faint text but without any font change. Unsupported tags are left as-is in standard output.
[codeblocks] [codeblocks]
[gdscript] [gdscript]

View File

@ -24,7 +24,7 @@
<param index="3" name="pitch_scale" type="float" default="1.0" /> <param index="3" name="pitch_scale" type="float" default="1.0" />
<description> <description>
Play an [AudioStream] at a given offset, volume and pitch scale. Playback starts immediately. Play an [AudioStream] at a given offset, volume and pitch scale. Playback starts immediately.
The return value is an unique integer ID that is associated to this playback stream and which can be used to control it. The return value is a unique integer ID that is associated to this playback stream and which can be used to control it.
This ID becomes invalid when the stream ends (if it does not loop), when the [AudioStreamPlaybackPolyphonic] is stopped, or when [method stop_stream] is called. This ID becomes invalid when the stream ends (if it does not loop), when the [AudioStreamPlaybackPolyphonic] is stopped, or when [method stop_stream] is called.
This function returns [constant INVALID_ID] if the amount of streams currently playing equals [member AudioStreamPolyphonic.polyphony]. If you need a higher amount of maximum polyphony, raise this value. This function returns [constant INVALID_ID] if the amount of streams currently playing equals [member AudioStreamPolyphonic.polyphony]. If you need a higher amount of maximum polyphony, raise this value.
</description> </description>

View File

@ -1666,7 +1666,7 @@
I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as [LineEdit] or [TextEdit]. I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as [LineEdit] or [TextEdit].
</constant> </constant>
<constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape"> <constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape">
Pointing hand cursor shape. This is used by default when hovering a [LinkButton] or an URL tag in a [RichTextLabel]. Pointing hand cursor shape. This is used by default when hovering a [LinkButton] or a URL tag in a [RichTextLabel].
</constant> </constant>
<constant name="CURSOR_CROSS" value="3" enum="CursorShape"> <constant name="CURSOR_CROSS" value="3" enum="CursorShape">
Crosshair cursor. This is intended to be displayed when the user needs precise aim over an element, such as a rectangle selection tool or a color picker. Crosshair cursor. This is intended to be displayed when the user needs precise aim over an element, such as a rectangle selection tool or a color picker.

View File

@ -4030,10 +4030,10 @@
Array is a vertex color array. Array is a vertex color array.
</constant> </constant>
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Array is an UV coordinates array. Array is a UV coordinates array.
</constant> </constant>
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Array is an UV coordinates array for the second set of UV coordinates. Array is a UV coordinates array for the second set of UV coordinates.
</constant> </constant>
<constant name="ARRAY_CUSTOM0" value="6" enum="ArrayType"> <constant name="ARRAY_CUSTOM0" value="6" enum="ArrayType">
Array is a custom data array for the first set of custom data. Array is a custom data array for the first set of custom data.
@ -4102,10 +4102,10 @@
Flag used to mark a vertex color array. Flag used to mark a vertex color array.
</constant> </constant>
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat" is_bitfield="true"> <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat" is_bitfield="true">
Flag used to mark an UV coordinates array. Flag used to mark a UV coordinates array.
</constant> </constant>
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat" is_bitfield="true"> <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat" is_bitfield="true">
Flag used to mark an UV coordinates array for the second UV coordinates. Flag used to mark a UV coordinates array for the second UV coordinates.
</constant> </constant>
<constant name="ARRAY_FORMAT_CUSTOM0" value="64" enum="ArrayFormat" is_bitfield="true"> <constant name="ARRAY_FORMAT_CUSTOM0" value="64" enum="ArrayFormat" is_bitfield="true">
Flag used to mark an array of custom per-vertex data for the first set of custom data. Flag used to mark an array of custom per-vertex data for the first set of custom data.

View File

@ -91,7 +91,7 @@
An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor. An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor.
</member> </member>
<member name="resource_path" type="String" setter="set_path" getter="get_path" default="&quot;&quot;"> <member name="resource_path" type="String" setter="set_path" getter="get_path" default="&quot;&quot;">
The unique path to this resource. If it has been saved to disk, the value will be its filepath. If the resource is exclusively contained within a scene, the value will be the [PackedScene]'s filepath, followed by an unique identifier. The unique path to this resource. If it has been saved to disk, the value will be its filepath. If the resource is exclusively contained within a scene, the value will be the [PackedScene]'s filepath, followed by a unique identifier.
[b]Note:[/b] Setting this property manually may fail if a resource with the same path has already been previously loaded. If necessary, use [method take_over_path]. [b]Note:[/b] Setting this property manually may fail if a resource with the same path has already been previously loaded. If necessary, use [method take_over_path].
</member> </member>
</members> </members>

View File

@ -101,7 +101,7 @@
<return type="String" /> <return type="String" />
<param index="0" name="bytes" type="int" default="-1" /> <param index="0" name="bytes" type="int" default="-1" />
<description> <description>
Gets an UTF-8 string with byte-length [param bytes] from the stream (this decodes the string sent as UTF-8). If [param bytes] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. Gets a UTF-8 string with byte-length [param bytes] from the stream (this decodes the string sent as UTF-8). If [param bytes] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string].
</description> </description>
</method> </method>
<method name="get_var"> <method name="get_var">
@ -218,7 +218,7 @@
<param index="0" name="value" type="String" /> <param index="0" name="value" type="String" />
<description> <description>
Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size.
[b]Note:[/b] To put an UTF-8 string without prepending its size, you can use [method put_data]: [b]Note:[/b] To put a UTF-8 string without prepending its size, you can use [method put_data]:
[codeblocks] [codeblocks]
[gdscript] [gdscript]
put_data("Hello world".to_utf8_buffer()) put_data("Hello world".to_utf8_buffer())

View File

@ -242,7 +242,7 @@
<param index="0" name="index" type="int" /> <param index="0" name="index" type="int" />
<description> <description>
Specifies the smooth group to use for the [i]next[/i] vertex. If this is never called, all vertices will have the default smooth group of [code]0[/code] and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to [code]-1[/code]. Specifies the smooth group to use for the [i]next[/i] vertex. If this is never called, all vertices will have the default smooth group of [code]0[/code] and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to [code]-1[/code].
[b]Note:[/b] This function actually takes an [code]uint32_t[/code], so C# users should use [code]uint32.MaxValue[/code] instead of [code]-1[/code] to produce a mesh with flat normals. [b]Note:[/b] This function actually takes a [code]uint32_t[/code], so C# users should use [code]uint32.MaxValue[/code] instead of [code]-1[/code] to produce a mesh with flat normals.
</description> </description>
</method> </method>
<method name="set_tangent"> <method name="set_tangent">

View File

@ -20,7 +20,7 @@
var boo = "Boo is a string!"; var boo = "Boo is a string!";
var ref = new RefCounted(); // var is especially useful when used together with a constructor. var ref = new RefCounted(); // var is especially useful when used together with a constructor.
// Godot also provides a Variant type that works like an union of all the Variant-compatible types. // Godot also provides a Variant type that works like a union of all the Variant-compatible types.
Variant fooVar = 2; // fooVar is dynamically an integer (stored as a `long` in the Variant type). Variant fooVar = 2; // fooVar is dynamically an integer (stored as a `long` in the Variant type).
fooVar = "Now fooVar is a string!"; fooVar = "Now fooVar is a string!";
fooVar = new RefCounted(); // fooVar is a GodotObject. fooVar = new RefCounted(); // fooVar is a GodotObject.