diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/BaseMaterial3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Bone2D.xml | 13 | ||||
| -rw-r--r-- | doc/classes/CodeEdit.xml | 4 | ||||
| -rw-r--r-- | doc/classes/CodeHighlighter.xml | 2 | ||||
| -rw-r--r-- | doc/classes/DisplayServer.xml | 3 | ||||
| -rw-r--r-- | doc/classes/EditorSettings.xml | 2 | ||||
| -rw-r--r-- | doc/classes/FileAccess.xml | 2 | ||||
| -rw-r--r-- | doc/classes/InputEvent.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Light2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/MenuBar.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PackedByteArray.xml | 4 | ||||
| -rw-r--r-- | doc/classes/StyleBoxFlat.xml | 2 | ||||
| -rw-r--r-- | doc/classes/StyleBoxTexture.xml | 2 | ||||
| -rw-r--r-- | doc/classes/TextServer.xml | 2 |
14 files changed, 16 insertions, 28 deletions
diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index e72aa373f7..6cd8c44269 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -121,7 +121,7 @@ Texture used to control the backlight effect per-pixel. Added to [member backlight]. </member> <member name="billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag" default="false"> - If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when [member billboard_mode] is [constant BILLBOARD_ENABLED]. + If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when [member billboard_mode] is not [constant BILLBOARD_DISABLED]. </member> <member name="billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="BaseMaterial3D.BillboardMode" default="0"> Controls how the object faces the camera. See [enum BillboardMode]. diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 81999cebab..c421fe1543 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -31,12 +31,6 @@ [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. </description> </method> - <method name="get_default_length" qualifiers="const"> - <return type="float" /> - <description> - Deprecated. Please use [method get_length] instead. - </description> - </method> <method name="get_index_in_skeleton" qualifiers="const"> <return type="int" /> <description> @@ -70,13 +64,6 @@ [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. </description> </method> - <method name="set_default_length"> - <return type="void" /> - <param index="0" name="default_length" type="float" /> - <description> - Deprecated. Please use [method set_length] instead. - </description> - </method> <method name="set_length"> <return type="void" /> <param index="0" name="length" type="float" /> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 1bc214aea7..65a6668f43 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -62,7 +62,7 @@ <description> Adds a comment delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. </description> </method> <method name="add_string_delimiter"> @@ -73,7 +73,7 @@ <description> Adds a string delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. </description> </method> <method name="can_fold_line" qualifiers="const"> diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index fd1f595fc6..eedd4c1769 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -18,7 +18,7 @@ <description> Adds a color region such as comments or strings. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. </description> </method> <method name="add_keyword_color"> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 122db7e668..5f25bd8925 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -991,6 +991,7 @@ - [code]name[/code] is voice name. - [code]id[/code] is voice identifier. - [code]language[/code] is language code in [code]lang_Variant[/code] format. [code]lang[/code] part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And [code]Variant[/code] part is an engine dependent string describing country, region or/and dialect. + Note that Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and MacOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech. [b]Note:[/b] This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows. </description> </method> @@ -1677,7 +1678,7 @@ Minimized window mode, i.e. [Window] is not visible and available on window manager's window list. Normally happens when the minimize button is pressed. </constant> <constant name="WINDOW_MODE_MAXIMIZED" value="2" enum="WindowMode"> - Maximized window mode, i.e. [Window] will occupy whole screen area except task bar and still display its borders. Normally happens when the minimize button is pressed. + Maximized window mode, i.e. [Window] will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed. </constant> <constant name="WINDOW_MODE_FULLSCREEN" value="3" enum="WindowMode"> Full screen mode with full multi-window support. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 1bf8cbf175..70ea69a336 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -196,7 +196,7 @@ The thumbnail size to use in the FileSystem dock (in pixels). See also [member filesystem/file_dialog/thumbnail_size]. </member> <member name="docks/property_editor/auto_refresh_interval" type="float" setter="" getter=""> - The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector more often, but take up more CPU time. + The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector refresh more often, but take up more CPU time. </member> <member name="docks/property_editor/subresource_hue_tint" type="float" setter="" getter=""> The tint intensity to use for the subresources background in the Inspector dock. The tint is used to distinguish between different subresources in the inspector. Higher values result in a more noticeable background color difference. diff --git a/doc/classes/FileAccess.xml b/doc/classes/FileAccess.xml index 526f7c22e6..c85bde681f 100644 --- a/doc/classes/FileAccess.xml +++ b/doc/classes/FileAccess.xml @@ -55,7 +55,7 @@ <method name="close"> <return type="void" /> <description> - Closes the currently opened file and prevents subsequent read/write operations. Use flush to persist the data to disk without closing the file. + Closes the currently opened file and prevents subsequent read/write operations. Use [method flush] to persist the data to disk without closing the file. [b]Note:[/b] [FileAccess] will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with [code]null[/code]. In C# the reference must be disposed after we are done using it, this can be done with the [code]using[/code] statement or calling the [code]Dispose[/code] method directly. </description> </method> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 043ccdca36..53fb334ede 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -74,7 +74,7 @@ <method name="is_echo" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]). + Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]). Any other event type returns [code]false[/code]. </description> </method> <method name="is_match" qualifiers="const"> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 9f1b1af60d..4481131f81 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -80,7 +80,7 @@ Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See [member shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF13" value="2" enum="ShadowFilter"> - Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtereing mode, and should be used sparingly. See [member shadow_filter]. + Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See [member shadow_filter]. </constant> <constant name="BLEND_MODE_ADD" value="0" enum="BlendMode"> Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light. diff --git a/doc/classes/MenuBar.xml b/doc/classes/MenuBar.xml index 79876e56a3..fac5eae98c 100644 --- a/doc/classes/MenuBar.xml +++ b/doc/classes/MenuBar.xml @@ -4,7 +4,7 @@ A horizontal menu bar, which displays [PopupMenu]s or system global menu. </brief_description> <description> - New items can be created by adding [PopupMenu] nodes to his node. + New items can be created by adding [PopupMenu] nodes to this node. </description> <tutorials> </tutorials> diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index ccf012f82c..c079a70ae5 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -229,7 +229,7 @@ <param index="0" name="byte_offset" type="int" /> <param index="1" name="value" type="int" /> <description> - Encodes a 32-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. + Encodes a 32-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset. </description> </method> <method name="encode_s64"> @@ -237,7 +237,7 @@ <param index="0" name="byte_offset" type="int" /> <param index="1" name="value" type="int" /> <description> - Encodes a 64-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. + Encodes a 64-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of space, starting at the offset. </description> </method> <method name="encode_s8"> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index d6900f935c..6bcc3c5ea6 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -94,7 +94,7 @@ <return type="void" /> <param index="0" name="size" type="float" /> <description> - Sets the expand margin to [param size] pixels for all margins. + Sets the expand margin to [param size] pixels for all sides. </description> </method> </methods> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index f2f6e59a9e..6a29bf38db 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -35,7 +35,7 @@ <return type="void" /> <param index="0" name="size" type="float" /> <description> - Sets the expand margin to [param size] pixels for all margins. + Sets the expand margin to [param size] pixels for all sides. </description> </method> <method name="set_texture_margin"> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 711fb89217..ad37cf5c86 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -12,7 +12,7 @@ <method name="create_font"> <return type="RID" /> <description> - Creates new, empty font cache entry resource. To free the resulting resourec, use [method free_rid] method. + Creates new, empty font cache entry resource. To free the resulting resource, use [method free_rid] method. </description> </method> <method name="create_shaped_text"> |