diff options
Diffstat (limited to 'doc/classes')
89 files changed, 1373 insertions, 141 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index f222cbc969..55d00b6cf9 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -856,7 +856,7 @@ GD.Print("a", "b", a); // Prints ab[1, 2, 3] [/csharp] [/codeblocks] - [b]Note:[/b] Consider using [method push_error] and [method push_warning] to print error and warning messages instead of [method print] or [method print_rich]. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. + [b]Note:[/b] Consider using [method push_error] and [method push_warning] to print error and warning messages instead of [method print] or [method print_rich]. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. See also [member Engine.print_to_stdout] and [member ProjectSettings.application/run/disable_stdout]. </description> </method> <method name="print_rich" qualifiers="vararg"> @@ -1209,7 +1209,7 @@ <return type="int" /> <param index="0" name="x" type="int" /> <description> - Returns [code]-1[/code] if [param x] is negative, [code]1[/code] if [param x] is positive, and [code]0[/code] if if [param x] is zero. + Returns [code]-1[/code] if [param x] is negative, [code]1[/code] if [param x] is positive, and [code]0[/code] if [param x] is zero. [codeblock] signi(-6) # Returns -1 signi(0) # Returns 0 @@ -2933,7 +2933,15 @@ <constant name="PROPERTY_HINT_PASSWORD" value="36" enum="PropertyHint"> Hints that a string property is a password, and every character is replaced with the secret character. </constant> - <constant name="PROPERTY_HINT_MAX" value="39" enum="PropertyHint"> + <constant name="PROPERTY_HINT_TOOL_BUTTON" value="39" enum="PropertyHint"> + Hints that a [Callable] property should be displayed as a clickable button. When the button is pressed, the callable is called. The hint string specifies the button text and optionally an icon from the [code]"EditorIcons"[/code] theme type. + [codeblock lang=text] + "Click me!" - A button with the text "Click me!" and the default "Callable" icon. + "Click me!,ColorRect" - A button with the text "Click me!" and the "ColorRect" icon. + [/codeblock] + [b]Note:[/b] A [Callable] cannot be properly serialized and stored in a file, so it is recommended to use [constant PROPERTY_USAGE_EDITOR] instead of [constant PROPERTY_USAGE_DEFAULT]. + </constant> + <constant name="PROPERTY_HINT_MAX" value="40" enum="PropertyHint"> Represents the size of the [enum PropertyHint] enum. </constant> <constant name="PROPERTY_USAGE_NONE" value="0" enum="PropertyUsageFlags" is_bitfield="true"> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index f3a1f6b985..a41da4c318 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -143,6 +143,7 @@ <description> Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. + [b]Note:[/b] When [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish. [codeblocks] [gdscript] var astar = AStar2D.new() @@ -235,6 +236,7 @@ Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty array and will print an error message. + Additionally, when [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish. </description> </method> <method name="get_point_position" qualifiers="const"> diff --git a/doc/classes/AStar3D.xml b/doc/classes/AStar3D.xml index dad77cc7a8..2e8ae37a20 100644 --- a/doc/classes/AStar3D.xml +++ b/doc/classes/AStar3D.xml @@ -172,6 +172,7 @@ <description> Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. + [b]Note:[/b] When [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish. [codeblocks] [gdscript] var astar = AStar3D.new() @@ -262,6 +263,7 @@ Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty array and will print an error message. + Additionally, when [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish. </description> </method> <method name="get_point_position" qualifiers="const"> diff --git a/doc/classes/AStarGrid2D.xml b/doc/classes/AStarGrid2D.xml index 2ee61bd939..8e1972af11 100644 --- a/doc/classes/AStarGrid2D.xml +++ b/doc/classes/AStarGrid2D.xml @@ -79,6 +79,7 @@ <description> Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. + [b]Note:[/b] When [param allow_partial_path] is [code]true[/code] and [param to_id] is solid the search may take an unusually long time to finish. </description> </method> <method name="get_point_data_in_region" qualifiers="const"> @@ -97,6 +98,7 @@ Returns an array with the points that are in the path found by [AStarGrid2D] between the given points. The array is ordered from the starting point to the ending point of the path. If there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty array and will print an error message. + Additionally, when [param allow_partial_path] is [code]true[/code] and [param to_id] is solid the search may take an unusually long time to finish. </description> </method> <method name="get_point_position" qualifiers="const"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 942299cc7e..609d7eff39 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -34,6 +34,14 @@ <link title="Animation documentation index">$DOCS_URL/tutorials/animation/index.html</link> </tutorials> <methods> + <method name="add_marker"> + <return type="void" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="time" type="float" /> + <description> + Adds a marker to this Animation. + </description> + </method> <method name="add_track"> <return type="int" /> <param index="0" name="type" type="int" enum="Animation.TrackType" /> @@ -271,12 +279,60 @@ Returns the index of the specified track. If the track is not found, return -1. </description> </method> + <method name="get_marker_at_time" qualifiers="const"> + <return type="StringName" /> + <param index="0" name="time" type="float" /> + <description> + Returns the name of the marker located at the given time. + </description> + </method> + <method name="get_marker_color" qualifiers="const"> + <return type="Color" /> + <param index="0" name="name" type="StringName" /> + <description> + Returns the given marker's color. + </description> + </method> + <method name="get_marker_names" qualifiers="const"> + <return type="PackedStringArray" /> + <description> + Returns every marker in this Animation, sorted ascending by time. + </description> + </method> + <method name="get_marker_time" qualifiers="const"> + <return type="float" /> + <param index="0" name="name" type="StringName" /> + <description> + Returns the given marker's time. + </description> + </method> + <method name="get_next_marker" qualifiers="const"> + <return type="StringName" /> + <param index="0" name="time" type="float" /> + <description> + Returns the closest marker that comes after the given time. If no such marker exists, an empty string is returned. + </description> + </method> + <method name="get_prev_marker" qualifiers="const"> + <return type="StringName" /> + <param index="0" name="time" type="float" /> + <description> + Returns the closest marker that comes before the given time. If no such marker exists, an empty string is returned. + </description> + </method> <method name="get_track_count" qualifiers="const"> <return type="int" /> <description> Returns the amount of tracks in the animation. </description> </method> + <method name="has_marker" qualifiers="const"> + <return type="bool" /> + <param index="0" name="name" type="StringName" /> + <description> + Returns [code]true[/code] if this Animation contains a marker with the given name. + </description> + </method> <method name="method_track_get_name" qualifiers="const"> <return type="StringName" /> <param index="0" name="track_idx" type="int" /> @@ -293,6 +349,15 @@ Returns the arguments values to be called on a method track for a given key in a given track. </description> </method> + <method name="optimize"> + <return type="void" /> + <param index="0" name="allowed_velocity_err" type="float" default="0.01" /> + <param index="1" name="allowed_angular_err" type="float" default="0.01" /> + <param index="2" name="precision" type="int" default="3" /> + <description> + Optimize the animation and all its tracks in-place. This will preserve only as many keys as are necessary to keep the animation within the specified bounds. + </description> + </method> <method name="position_track_insert_key"> <return type="int" /> <param index="0" name="track_idx" type="int" /> @@ -311,6 +376,13 @@ Returns the interpolated position value at the given time (in seconds). The [param track_idx] must be the index of a 3D position track. </description> </method> + <method name="remove_marker"> + <return type="void" /> + <param index="0" name="name" type="StringName" /> + <description> + Removes the marker with the given name from this Animation. + </description> + </method> <method name="remove_track"> <return type="void" /> <param index="0" name="track_idx" type="int" /> @@ -354,6 +426,14 @@ Returns the interpolated scale value at the given time (in seconds). The [param track_idx] must be the index of a 3D scale track. </description> </method> + <method name="set_marker_color"> + <return type="void" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="color" type="Color" /> + <description> + Sets the given marker's color. + </description> + </method> <method name="track_find_key" qualifiers="const"> <return type="int" /> <param index="0" name="track_idx" type="int" /> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 1ca8ac2fa5..9aeb4b7162 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -75,6 +75,24 @@ Returns the node which node path references will travel from. </description> </method> + <method name="get_section_end_time" qualifiers="const"> + <return type="float" /> + <description> + Returns the end time of the section currently being played. + </description> + </method> + <method name="get_section_start_time" qualifiers="const"> + <return type="float" /> + <description> + Returns the start time of the section currently being played. + </description> + </method> + <method name="has_section" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if an animation is currently playing with section. + </description> + </method> <method name="is_playing" qualifiers="const"> <return type="bool" /> <description> @@ -110,6 +128,54 @@ This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. </description> </method> + <method name="play_section"> + <return type="void" /> + <param index="0" name="name" type="StringName" default="&""" /> + <param index="1" name="start_time" type="float" default="-1" /> + <param index="2" name="end_time" type="float" default="-1" /> + <param index="3" name="custom_blend" type="float" default="-1" /> + <param index="4" name="custom_speed" type="float" default="1.0" /> + <param index="5" name="from_end" type="bool" default="false" /> + <description> + Plays the animation with key [param name] and the section starting from [param start_time] and ending on [param end_time]. See also [method play]. + Setting [param start_time] to a value outside the range of the animation means the start of the animation will be used instead, and setting [param end_time] to a value outside the range of the animation means the end of the animation will be used instead. [param start_time] cannot be equal to [param end_time]. + </description> + </method> + <method name="play_section_backwards"> + <return type="void" /> + <param index="0" name="name" type="StringName" default="&""" /> + <param index="1" name="start_time" type="float" default="-1" /> + <param index="2" name="end_time" type="float" default="-1" /> + <param index="3" name="custom_blend" type="float" default="-1" /> + <description> + Plays the animation with key [param name] and the section starting from [param start_time] and ending on [param end_time] in reverse. + This method is a shorthand for [method play_section] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], see its description for more information. + </description> + </method> + <method name="play_section_with_markers"> + <return type="void" /> + <param index="0" name="name" type="StringName" default="&""" /> + <param index="1" name="start_marker" type="StringName" default="&""" /> + <param index="2" name="end_marker" type="StringName" default="&""" /> + <param index="3" name="custom_blend" type="float" default="-1" /> + <param index="4" name="custom_speed" type="float" default="1.0" /> + <param index="5" name="from_end" type="bool" default="false" /> + <description> + Plays the animation with key [param name] and the section starting from [param start_marker] and ending on [param end_marker]. + If the start marker is empty, the section starts from the beginning of the animation. If the end marker is empty, the section ends on the end of the animation. See also [method play]. + </description> + </method> + <method name="play_section_with_markers_backwards"> + <return type="void" /> + <param index="0" name="name" type="StringName" default="&""" /> + <param index="1" name="start_marker" type="StringName" default="&""" /> + <param index="2" name="end_marker" type="StringName" default="&""" /> + <param index="3" name="custom_blend" type="float" default="-1" /> + <description> + Plays the animation with key [param name] and the section starting from [param start_marker] and ending on [param end_marker] in reverse. + This method is a shorthand for [method play_section_with_markers] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], see its description for more information. + </description> + </method> <method name="play_with_capture"> <return type="void" /> <param index="0" name="name" type="StringName" default="&""" /> @@ -139,6 +205,12 @@ [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. </description> </method> + <method name="reset_section"> + <return type="void" /> + <description> + Resets the current section if section is set. + </description> + </method> <method name="seek"> <return type="void" /> <param index="0" name="seconds" type="float" /> @@ -180,6 +252,23 @@ Sets the node which node path references will travel from. </description> </method> + <method name="set_section"> + <return type="void" /> + <param index="0" name="start_time" type="float" default="-1" /> + <param index="1" name="end_time" type="float" default="-1" /> + <description> + Changes the start and end times of the section being played. The current playback position will be clamped within the new section. See also [method play_section]. + </description> + </method> + <method name="set_section_with_markers"> + <return type="void" /> + <param index="0" name="start_marker" type="StringName" default="&""" /> + <param index="1" name="end_marker" type="StringName" default="&""" /> + <description> + Changes the start and end markers of the section being played. The current playback position will be clamped within the new section. See also [method play_section_with_markers]. + If the argument is empty, the section uses the beginning or end of the animation. If both are empty, it means that the section is not set. + </description> + </method> <method name="stop"> <return type="void" /> <param index="0" name="keep_state" type="bool" default="false" /> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index f4dcc9bf68..1b7dbf7c41 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -324,6 +324,7 @@ <param index="0" name="value" type="Variant" /> <description> Returns the number of times an element is in the array. + To count how many elements in an array satisfy a condition, see [method reduce]. </description> </method> <method name="duplicate" qualifiers="const"> @@ -395,6 +396,25 @@ [b]Note:[/b] For performance reasons, the search is affected by [param what]'s [enum Variant.Type]. For example, [code]7[/code] ([int]) and [code]7.0[/code] ([float]) are not considered equal for this method. </description> </method> + <method name="find_custom" qualifiers="const"> + <return type="int" /> + <param index="0" name="method" type="Callable" /> + <param index="1" name="from" type="int" default="0" /> + <description> + Returns the index of the [b]first[/b] element in the array that causes [param method] to return [code]true[/code], or [code]-1[/code] if there are none. The search's start can be specified with [param from], continuing to the end of the array. + [param method] is a callable that takes an element of the array, and returns a [bool]. + [b]Note:[/b] If you just want to know whether the array contains [i]anything[/i] that satisfies [param method], use [method any]. + [codeblocks] + [gdscript] + func is_even(number): + return number % 2 == 0 + + func _ready(): + print([1, 3, 4, 7].find_custom(is_even.bind())) # prints 2 + [/gdscript] + [/codeblocks] + </description> + </method> <method name="front" qualifiers="const"> <return type="Variant" /> <description> @@ -402,6 +422,13 @@ [b]Note:[/b] Unlike with the [code][][/code] operator ([code]array[0][/code]), an error is generated without stopping project execution. </description> </method> + <method name="get" qualifiers="const"> + <return type="Variant" /> + <param index="0" name="index" type="int" /> + <description> + Returns the element at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="get_typed_builtin" qualifiers="const"> <return type="int" /> <description> @@ -618,6 +645,17 @@ func is_length_greater(a, b): return a.length() > b.length() [/codeblock] + This method can also be used to count how many elements in an array satisfy a certain condition, similar to [method count]: + [codeblock] + func is_even(number): + return number % 2 == 0 + + func _ready(): + var arr = [1, 2, 3, 4, 5] + # Increment count if it's even, else leaves count the same. + var even_count = arr.reduce(func(count, next): return count + 1 if is_even(next) else count, 0) + print(even_count) # Prints 2 + [/codeblock] See also [method map], [method filter], [method any] and [method all]. </description> </method> @@ -654,6 +692,22 @@ Returns the index of the [b]last[/b] occurrence of [param what] in this array, or [code]-1[/code] if there are none. The search's start can be specified with [param from], continuing to the beginning of the array. This method is the reverse of [method find]. </description> </method> + <method name="rfind_custom" qualifiers="const"> + <return type="int" /> + <param index="0" name="method" type="Callable" /> + <param index="1" name="from" type="int" default="-1" /> + <description> + Returns the index of the [b]last[/b] element of the array that causes [param method] to return [code]true[/code], or [code]-1[/code] if there are none. The search's start can be specified with [param from], continuing to the beginning of the array. This method is the reverse of [method find_custom]. + </description> + </method> + <method name="set"> + <return type="void" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="Variant" /> + <description> + Sets the value of the element at the given [param index] to the given [param value]. This will not change the size of the array, it only changes the value at an index already in the array. This is the same as using the [code][][/code] operator ([code]array[index] = value[/code]). + </description> + </method> <method name="shuffle"> <return type="void" /> <description> @@ -714,7 +768,7 @@ <param index="0" name="func" type="Callable" /> <description> Sorts the array using a custom [Callable]. - [param func] is called as many times as necessary, receiving two array elements as arguments. The function should return [code]true[/code] if the first element should be moved [i]behind[/i] the second one, otherwise it should return [code]false[/code]. + [param func] is called as many times as necessary, receiving two array elements as arguments. The function should return [code]true[/code] if the first element should be moved [i]before[/i] the second one, otherwise it should return [code]false[/code]. [codeblock] func sort_ascending(a, b): if a[1] < b[1]: diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 764f4a65b5..13b23d70b7 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -57,7 +57,7 @@ </member> <member name="button_pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code]. - [b]Note:[/b] Setting [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal]. + [b]Note:[/b] Changing the value of [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal]. </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled"> If [code]true[/code], the button is in disabled state and can't be clicked or toggled. @@ -75,6 +75,7 @@ </member> <member name="shortcut_in_tooltip" type="bool" setter="set_shortcut_in_tooltip" getter="is_shortcut_in_tooltip_enabled" default="true"> If [code]true[/code], the button will add information about its shortcut in the tooltip. + [b]Note:[/b] This property does nothing when the tooltip control is customized using [method Control._make_custom_tooltip]. </member> <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" default="false"> If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. diff --git a/doc/classes/CameraAttributesPhysical.xml b/doc/classes/CameraAttributesPhysical.xml index faedfee712..e2036162c7 100644 --- a/doc/classes/CameraAttributesPhysical.xml +++ b/doc/classes/CameraAttributesPhysical.xml @@ -25,7 +25,7 @@ The maximum luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright. </member> <member name="auto_exposure_min_exposure_value" type="float" setter="set_auto_exposure_min_exposure_value" getter="get_auto_exposure_min_exposure_value" default="-8.0"> - The minimum luminance luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. + The minimum luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. </member> <member name="exposure_aperture" type="float" setter="set_aperture" getter="get_aperture" default="16.0"> Size of the aperture of the camera, measured in f-stops. An f-stop is a unitless ratio between the focal length of the camera and the diameter of the aperture. A high aperture setting will result in a smaller aperture which leads to a dimmer image and sharper focus. A low aperture results in a wide aperture which lets in more light resulting in a brighter, less-focused image. Default is appropriate for outdoors at daytime (i.e. for use with a default [DirectionalLight3D]), for indoor lighting, a value between 2 and 4 is more appropriate. diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 974f6d4a33..2b6db13906 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -34,6 +34,45 @@ Returns the position of camera on the device. </description> </method> + <method name="set_format"> + <return type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="parameters" type="Dictionary" /> + <description> + Sets the feed format parameters for the given index in the [member formats] array. Returns [code]true[/code] on success. By default YUYV encoded stream is transformed to FEED_RGB. YUYV encoded stream output format can be changed with [param parameters].output value: + [code]separate[/code] will result in FEED_YCBCR_SEP + [code]grayscale[/code] will result in desaturated FEED_RGB + [code]copy[/code] will result in FEED_YCBCR + </description> + </method> + <method name="set_name"> + <return type="void" /> + <param index="0" name="name" type="String" /> + <description> + Sets the camera's name. + </description> + </method> + <method name="set_position"> + <return type="void" /> + <param index="0" name="position" type="int" enum="CameraFeed.FeedPosition" /> + <description> + Sets the position of this camera. + </description> + </method> + <method name="set_rgb_image"> + <return type="void" /> + <param index="0" name="rgb_image" type="Image" /> + <description> + Sets RGB image for this feed. + </description> + </method> + <method name="set_ycbcr_image"> + <return type="void" /> + <param index="0" name="ycbcr_image" type="Image" /> + <description> + Sets YCbCr image for this feed. + </description> + </method> </methods> <members> <member name="feed_is_active" type="bool" setter="set_active" getter="is_active" default="false"> @@ -42,7 +81,22 @@ <member name="feed_transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D(1, 0, 0, -1, 0, 1)"> The transform applied to the camera's image. </member> + <member name="formats" type="Array" setter="" getter="get_formats" default="[]"> + Formats supported by the feed. Each entry is a [Dictionary] describing format parameters. + </member> </members> + <signals> + <signal name="format_changed"> + <description> + Emitted when the format has changed. + </description> + </signal> + <signal name="frame_changed"> + <description> + Emitted when a new frame is available. + </description> + </signal> + </signals> <constants> <constant name="FEED_NOIMAGE" value="0" enum="FeedDataType"> No image set for the feed. diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index 020b5d887b..b09010147e 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -6,7 +6,7 @@ <description> The [CameraServer] keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone. It is notably used to provide AR modules with a video feed from the camera. - [b]Note:[/b] This class is currently only implemented on macOS and iOS. To get a [CameraFeed] on iOS, the camera plugin from [url=https://github.com/godotengine/godot-ios-plugins]godot-ios-plugins[/url] is required. On other platforms, no [CameraFeed]s will be available. + [b]Note:[/b] This class is currently only implemented on Linux, macOS, and iOS, on other platforms no [CameraFeed]s will be available. To get a [CameraFeed] on iOS, the camera plugin from [url=https://github.com/godotengine/godot-ios-plugins]godot-ios-plugins[/url] is required. </description> <tutorials> </tutorials> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 0a0223c550..bc17c8b008 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -528,6 +528,7 @@ <description> Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is therefore not drawn (see [method _draw]). Visibility is checked only in parent nodes that inherit from [CanvasItem], [CanvasLayer], and [Window]. If the parent is of any other type (such as [Node], [AnimationPlayer], or [Node3D]), it is assumed to be visible. + [b]Note:[/b] This method does not take [member visibility_layer] into account, so even if this method returns [code]true[/code] the node might end up not being rendered. </description> </method> <method name="make_canvas_position_local" qualifiers="const"> @@ -622,7 +623,7 @@ The rendering layer in which this [CanvasItem] is rendered by [Viewport] nodes. A [Viewport] will render a [CanvasItem] if it and all its parents share a layer with the [Viewport]'s canvas cull mask. </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> - If [code]true[/code], this [CanvasItem] is drawn. The node is only visible if all of its ancestors are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]). + If [code]true[/code], this [CanvasItem] may be drawn. Whether this [CanvasItem] is actually drawn depends on the visibility of all of its [CanvasItem] ancestors. In other words: this [CanvasItem] will be drawn when [method is_visible_in_tree] returns [code]true[/code] and all [CanvasItem] ancestors share at least one [member visibility_layer] with this [CanvasItem]. [b]Note:[/b] For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. </member> <member name="y_sort_enabled" type="bool" setter="set_y_sort_enabled" getter="is_y_sort_enabled" default="false"> @@ -647,17 +648,17 @@ </signal> <signal name="hidden"> <description> - Emitted when becoming hidden. + Emitted when the [CanvasItem] is hidden, i.e. it's no longer visible in the tree (see [method is_visible_in_tree]). </description> </signal> <signal name="item_rect_changed"> <description> - Emitted when the item's [Rect2] boundaries (position or size) have changed, or when an action is taking place that may have impacted these boundaries (e.g. changing [member Sprite2D.texture]). + Emitted when the [CanvasItem]'s boundaries (position or size) change, or when an action took place that may have affected these boundaries (e.g. changing [member Sprite2D.texture]). </description> </signal> <signal name="visibility_changed"> <description> - Emitted when the visibility (hidden/visible) changes. + Emitted when the [CanvasItem]'s visibility changes, either because its own [member visible] property changed or because its visibility in the tree changed (see [method is_visible_in_tree]). </description> </signal> </signals> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 99d0c9be84..d1b666097c 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -31,6 +31,13 @@ Returns whether the specified [param class] is available or not. </description> </method> + <method name="class_get_api_type" qualifiers="const"> + <return type="int" enum="ClassDB.APIType" /> + <param index="0" name="class" type="StringName" /> + <description> + Returns the API type of [param class]. See [enum APIType]. + </description> + </method> <method name="class_get_enum_constants" qualifiers="const"> <return type="PackedStringArray" /> <param index="0" name="class" type="StringName" /> @@ -242,4 +249,21 @@ </description> </method> </methods> + <constants> + <constant name="API_CORE" value="0" enum="APIType"> + Native Core class type. + </constant> + <constant name="API_EDITOR" value="1" enum="APIType"> + Native Editor class type. + </constant> + <constant name="API_EXTENSION" value="2" enum="APIType"> + GDExtension class type. + </constant> + <constant name="API_EDITOR_EXTENSION" value="3" enum="APIType"> + GDExtension Editor class type. + </constant> + <constant name="API_NONE" value="4" enum="APIType"> + Unknown class type. + </constant> + </constants> </class> diff --git a/doc/classes/CompositorEffect.xml b/doc/classes/CompositorEffect.xml index 76a3887918..8961e10f91 100644 --- a/doc/classes/CompositorEffect.xml +++ b/doc/classes/CompositorEffect.xml @@ -57,6 +57,17 @@ var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() var roughness_buffer = render_scene_buffers.get_texture("forward_clustered", "normal_roughness") [/codeblock] + The raw normal and roughness buffer is stored in an optimized format, different than the one available in Spatial shaders. When sampling the buffer, a conversion function must be applied. Use this function, copied from [url=https://github.com/godotengine/godot/blob/da5f39889f155658cef7f7ec3cc1abb94e17d815/servers/rendering/renderer_rd/shaders/forward_clustered/scene_forward_clustered_inc.glsl#L334-L341]here[/url]: + [codeblock] + vec4 normal_roughness_compatibility(vec4 p_normal_roughness) { + float roughness = p_normal_roughness.w; + if (roughness > 0.5) { + roughness = 1.0 - roughness; + } + roughness /= (127.0 / 255.0); + return vec4(normalize(p_normal_roughness.xyz * 2.0 - 1.0) * 0.5 + 0.5, roughness); + } + [/codeblock] </member> <member name="needs_separate_specular" type="bool" setter="set_needs_separate_specular" getter="get_needs_separate_specular"> If [code]true[/code] this triggers specular data being rendered to a separate buffer and combined after effects have been applied, only applicable for the Forward+ renderer. @@ -76,7 +87,7 @@ The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers. </constant> <constant name="EFFECT_CALLBACK_TYPE_POST_TRANSPARENT" value="4" enum="EffectCallbackType"> - The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target. + The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target. </constant> <constant name="EFFECT_CALLBACK_TYPE_MAX" value="5" enum="EffectCallbackType"> Represents the size of the [enum EffectCallbackType] enum. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 927ab9ae0e..9d36bc657b 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1057,6 +1057,10 @@ [b]Note:[/b] To look up [Control]'s own items use various [code]get_theme_*[/code] methods without specifying [code]theme_type[/code]. [b]Note:[/b] Theme items are looked for in the tree order, from branch to root, where each [Control] node is checked for its [member theme] property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last. </member> + <member name="tooltip_auto_translate_mode" type="int" setter="set_tooltip_auto_translate_mode" getter="get_tooltip_auto_translate_mode" enum="Node.AutoTranslateMode" default="0"> + Defines if tooltip text should automatically change to its translated version depending on the current locale. Uses the same auto translate mode as this control when set to [constant Node.AUTO_TRANSLATE_MODE_INHERIT]. + [b]Note:[/b] When the tooltip is customized using [method _make_custom_tooltip], this auto translate mode is applied automatically to the returned control. + </member> <member name="tooltip_text" type="String" setter="set_tooltip_text" getter="get_tooltip_text" default=""""> The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. The time required for the tooltip to appear can be changed with the [member ProjectSettings.gui/timers/tooltip_delay_sec] option. See also [method get_tooltip]. The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding [method _make_custom_tooltip]. The default tooltip includes a [PopupPanel] and [Label] whose theme properties can be customized using [Theme] methods with the [code]"TooltipPanel"[/code] and [code]"TooltipLabel"[/code] respectively. For example: diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index feb2a07e4a..4441c3cb79 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -460,6 +460,14 @@ Returns [code]true[/code] if the two dictionaries contain the same keys and values, inner [Dictionary] and [Array] keys and values are compared recursively. </description> </method> + <method name="set"> + <return type="bool" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="value" type="Variant" /> + <description> + Sets the value of the element at the given [param key] to the given [param value]. This is the same as using the [code][][/code] operator ([code]array[index] = value[/code]). + </description> + </method> <method name="size" qualifiers="const"> <return type="int" /> <description> diff --git a/doc/classes/EditorContextMenuPlugin.xml b/doc/classes/EditorContextMenuPlugin.xml index 7eeee3d7fd..71c4ca0f9b 100644 --- a/doc/classes/EditorContextMenuPlugin.xml +++ b/doc/classes/EditorContextMenuPlugin.xml @@ -14,7 +14,7 @@ <return type="void" /> <param index="0" name="paths" type="PackedStringArray" /> <description> - Called when creating a context menu, custom options can be added by using the [method add_context_menu_item] function. + Called when creating a context menu, custom options can be added by using the [method add_context_menu_item] or [method add_context_menu_item_from_shortcut] functions. [param paths] contains currently selected paths (depending on menu), which can be used to conditionally add options. </description> </method> <method name="add_context_menu_item"> @@ -22,14 +22,29 @@ <param index="0" name="name" type="String" /> <param index="1" name="callback" type="Callable" /> <param index="2" name="icon" type="Texture2D" default="null" /> - <param index="3" name="shortcut" type="Shortcut" default="null" /> <description> - Add custom options to the context menu of the currently specified slot. - To trigger a [param shortcut] before the context menu is created, please additionally call the [method add_menu_shortcut] function. + Add custom option to the context menu of the plugin's specified slot. When the option is activated, [param callback] will be called. Callback should take single [Array] argument; array contents depend on context menu slot. [codeblock] func _popup_menu(paths): add_context_menu_item("File Custom options", handle, ICON) [/codeblock] + If you want to assign shortcut to the menu item, use [method add_context_menu_item_from_shortcut] instead. + </description> + </method> + <method name="add_context_menu_item_from_shortcut"> + <return type="void" /> + <param index="0" name="name" type="String" /> + <param index="1" name="shortcut" type="Shortcut" /> + <param index="2" name="icon" type="Texture2D" default="null" /> + <description> + Add custom option to the context menu of the plugin's specified slot. The option will have the [param shortcut] assigned and reuse its callback. The shortcut has to be registered beforehand with [method add_menu_shortcut]. + [codeblock] + func _init(): + add_menu_shortcut(SHORTCUT, handle) + + func _popup_menu(paths): + add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON) + [/codeblock] </description> </method> <method name="add_menu_shortcut"> @@ -37,13 +52,26 @@ <param index="0" name="shortcut" type="Shortcut" /> <param index="1" name="callback" type="Callable" /> <description> - To register the shortcut for the context menu, call this function within the [method Object._init] function, even if the context menu has not been created yet. - Note that this method should only be invoked from [method Object._init]; otherwise, the shortcut will not be registered correctly. + Registers a shortcut associated with the plugin's context menu. This method should be called once (e.g. in plugin's [method Object._init]). [param callback] will be called when user presses the specified [param shortcut] while the menu's context is in effect (e.g. FileSystem dock is focused). Callback should take single [Array] argument; array contents depend on context menu slot. [codeblock] func _init(): - add_menu_shortcut(SHORTCUT, handle); + add_menu_shortcut(SHORTCUT, handle) [/codeblock] </description> </method> </methods> + <constants> + <constant name="CONTEXT_SLOT_SCENE_TREE" value="0" enum="ContextMenuSlot"> + Context menu of Scene dock. [method _popup_menu] will be called with a list of paths to currently selected nodes, while option callback will receive the list of currently selected nodes. + </constant> + <constant name="CONTEXT_SLOT_FILESYSTEM" value="1" enum="ContextMenuSlot"> + Context menu of FileSystem dock. [method _popup_menu] and option callback will be called with list of paths of the currently selected files. + </constant> + <constant name="CONTEXT_SLOT_FILESYSTEM_CREATE" value="3" enum="ContextMenuSlot"> + The "Create..." submenu of FileSystem dock's context menu. [method _popup_menu] and option callback will be called with list of paths of the currently selected files. + </constant> + <constant name="CONTEXT_SLOT_SCRIPT_EDITOR" value="2" enum="ContextMenuSlot"> + Context menu of Scene dock. [method _popup_menu] will be called with the path to the currently edited script, while option callback will receive reference to that script. + </constant> + </constants> </class> diff --git a/doc/classes/EditorExportPlatform.xml b/doc/classes/EditorExportPlatform.xml index d4084e84a0..8792bbedc3 100644 --- a/doc/classes/EditorExportPlatform.xml +++ b/doc/classes/EditorExportPlatform.xml @@ -42,6 +42,18 @@ Creates a PCK archive at [param path] for the specified [param preset]. </description> </method> + <method name="export_pack_patch"> + <return type="int" enum="Error" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <param index="3" name="patches" type="PackedStringArray" default="PackedStringArray()" /> + <param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" default="0" /> + <description> + Creates a patch PCK archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. + [b]Note:[/b] [param patches] is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead. + </description> + </method> <method name="export_project"> <return type="int" enum="Error" /> <param index="0" name="preset" type="EditorExportPreset" /> @@ -75,6 +87,18 @@ Create a ZIP archive at [param path] for the specified [param preset]. </description> </method> + <method name="export_zip_patch"> + <return type="int" enum="Error" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <param index="3" name="patches" type="PackedStringArray" default="PackedStringArray()" /> + <param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" default="0" /> + <description> + Create a patch ZIP archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. + [b]Note:[/b] [param patches] is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead. + </description> + </method> <method name="find_export_template" qualifiers="const"> <return type="Dictionary" /> <param index="0" name="template_file_name" type="String" /> @@ -151,6 +175,15 @@ If [param embed] is [code]true[/code], PCK content is appended to the end of [param path] file and return [Dictionary] additionally include following keys: [code]embedded_start: int[/code] (embedded PCK offset) and [code]embedded_size: int[/code] (embedded PCK size). </description> </method> + <method name="save_pack_patch"> + <return type="Dictionary" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <description> + Saves patch PCK archive and returns [Dictionary] with the following keys: [code]result: Error[/code], [code]so_files: Array[/code] (array of the shared/static objects which contains dictionaries with the following keys: [code]path: String[/code], [code]tags: PackedStringArray[/code], and [code]target_folder: String[/code]). + </description> + </method> <method name="save_zip"> <return type="Dictionary" /> <param index="0" name="preset" type="EditorExportPreset" /> @@ -160,6 +193,15 @@ Saves ZIP archive and returns [Dictionary] with the following keys: [code]result: Error[/code], [code]so_files: Array[/code] (array of the shared/static objects which contains dictionaries with the following keys: [code]path: String[/code], [code]tags: PackedStringArray[/code], and [code]target_folder: String[/code]). </description> </method> + <method name="save_zip_patch"> + <return type="Dictionary" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <description> + Saves patch ZIP archive and returns [Dictionary] with the following keys: [code]result: Error[/code], [code]so_files: Array[/code] (array of the shared/static objects which contains dictionaries with the following keys: [code]path: String[/code], [code]tags: PackedStringArray[/code], and [code]target_folder: String[/code]). + </description> + </method> <method name="ssh_push_to_remote" qualifiers="const"> <return type="int" enum="Error" /> <param index="0" name="host" type="String" /> diff --git a/doc/classes/EditorExportPlatformExtension.xml b/doc/classes/EditorExportPlatformExtension.xml index ef589e2f58..f2d14b1710 100644 --- a/doc/classes/EditorExportPlatformExtension.xml +++ b/doc/classes/EditorExportPlatformExtension.xml @@ -36,7 +36,21 @@ <description> [b]Optional.[/b] Creates a PCK archive at [param path] for the specified [param preset]. - This method is called when "Export PCK/ZIP" button is pressed in the export dialog, and PCK is selected as a file type. + This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type. + </description> + </method> + <method name="_export_pack_patch" qualifiers="virtual"> + <return type="int" enum="Error" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <param index="3" name="patches" type="PackedStringArray" /> + <param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" /> + <description> + [b]Optional.[/b] + Creates a patch PCK archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. + This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type. + [b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. </description> </method> <method name="_export_project" qualifiers="virtual"> @@ -61,7 +75,21 @@ <description> [b]Optional.[/b] Create a ZIP archive at [param path] for the specified [param preset]. - This method is called when "Export PCK/ZIP" button is pressed in the export dialog, and ZIP is selected as a file type. + This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type. + </description> + </method> + <method name="_export_zip_patch" qualifiers="virtual"> + <return type="int" enum="Error" /> + <param index="0" name="preset" type="EditorExportPreset" /> + <param index="1" name="debug" type="bool" /> + <param index="2" name="path" type="String" /> + <param index="3" name="patches" type="PackedStringArray" /> + <param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" /> + <description> + [b]Optional.[/b] + Create a ZIP archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. + This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type. + [b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. </description> </method> <method name="_get_binary_extensions" qualifiers="virtual const"> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 42e1968eb0..aa8e4b3d56 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -159,6 +159,15 @@ Return a [PackedStringArray] of additional features this preset, for the given [param platform], should have. </description> </method> + <method name="_get_export_option_visibility" qualifiers="virtual const"> + <return type="bool" /> + <param index="0" name="platform" type="EditorExportPlatform" /> + <param index="1" name="option" type="String" /> + <description> + [b]Optional.[/b] + Validates [param option] and returns the visibility for the specified [param platform]. The default implementation returns [code]true[/code] for all options. + </description> + </method> <method name="_get_export_option_warning" qualifiers="virtual const"> <return type="String" /> <param index="0" name="platform" type="EditorExportPlatform" /> diff --git a/doc/classes/EditorExportPreset.xml b/doc/classes/EditorExportPreset.xml index bba79364e4..314f74340a 100644 --- a/doc/classes/EditorExportPreset.xml +++ b/doc/classes/EditorExportPreset.xml @@ -109,6 +109,12 @@ Returns export option value or value of environment variable if it is set. </description> </method> + <method name="get_patches" qualifiers="const"> + <return type="PackedStringArray" /> + <description> + Returns the list of packs on which to base a patch export on. + </description> + </method> <method name="get_preset_name" qualifiers="const"> <return type="String" /> <description> diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index cfdc172fd1..6b25be490e 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -28,6 +28,7 @@ </method> </methods> <members> + <member name="follow_focus" type="bool" setter="set_follow_focus" getter="is_following_focus" overrides="ScrollContainer" default="true" /> <member name="horizontal_scroll_mode" type="int" setter="set_horizontal_scroll_mode" getter="get_horizontal_scroll_mode" overrides="ScrollContainer" enum="ScrollContainer.ScrollMode" default="0" /> </members> <signals> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index b3191e5378..8189f253fb 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -403,11 +403,11 @@ </method> <method name="add_context_menu_plugin"> <return type="void" /> - <param index="0" name="slot" type="int" enum="EditorPlugin.ContextMenuSlot" /> + <param index="0" name="slot" type="int" enum="EditorContextMenuPlugin.ContextMenuSlot" /> <param index="1" name="plugin" type="EditorContextMenuPlugin" /> <description> - Adds a plugin to the context menu. [param slot] is the position in the context menu where the plugin will be added. - Context menus are supported for three commonly used areas: the file system, scene tree, and editor script list panel. + Adds a plugin to the context menu. [param slot] is the context menu where the plugin will be added. + See [enum EditorContextMenuPlugin.ContextMenuSlot] for available context menus. A plugin instance can belong only to a single context menu slot. </description> </method> <method name="add_control_to_bottom_panel"> @@ -635,10 +635,9 @@ </method> <method name="remove_context_menu_plugin"> <return type="void" /> - <param index="0" name="slot" type="int" enum="EditorPlugin.ContextMenuSlot" /> - <param index="1" name="plugin" type="EditorContextMenuPlugin" /> + <param index="0" name="plugin" type="EditorContextMenuPlugin" /> <description> - Removes a context menu plugin from the specified slot. + Removes the specified context menu plugin. </description> </method> <method name="remove_control_from_bottom_panel"> @@ -702,7 +701,7 @@ <return type="void" /> <param index="0" name="plugin" type="EditorInspectorPlugin" /> <description> - Removes an inspector plugin registered by [method add_import_plugin] + Removes an inspector plugin registered by [method add_inspector_plugin]. </description> </method> <method name="remove_node_3d_gizmo_plugin"> @@ -891,17 +890,5 @@ <constant name="AFTER_GUI_INPUT_CUSTOM" value="2" enum="AfterGUIInput"> Pass the [InputEvent] to other editor plugins except the main [Node3D] one. This can be used to prevent node selection changes and work with sub-gizmos instead. </constant> - <constant name="CONTEXT_SLOT_SCENE_TREE" value="0" enum="ContextMenuSlot"> - Context menu slot for the SceneTree. - </constant> - <constant name="CONTEXT_SLOT_FILESYSTEM" value="1" enum="ContextMenuSlot"> - Context menu slot for the FileSystem. - </constant> - <constant name="CONTEXT_SLOT_SCRIPT_EDITOR" value="2" enum="ContextMenuSlot"> - Context menu slot for the ScriptEditor file list. - </constant> - <constant name="CONTEXT_SUBMENU_SLOT_FILESYSTEM_CREATE" value="3" enum="ContextMenuSlot"> - Context menu slot for the FileSystem create submenu. - </constant> </constants> </class> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 1de63b4a39..a5097521dc 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -181,8 +181,12 @@ </method> </methods> <members> + <member name="asset_library/use_threads" type="bool" setter="" getter=""> + If [code]true[/code], the Asset Library uses multiple threads for its HTTP requests. This prevents the Asset Library from blocking the main thread for every loaded asset. + </member> <member name="debugger/auto_switch_to_remote_scene_tree" type="bool" setter="" getter=""> If [code]true[/code], automatically switches to the [b]Remote[/b] scene tree when running the project from the editor. If [code]false[/code], stays on the [b]Local[/b] scene tree when running the project from the editor. + [b]Warning:[/b] Enabling this setting can cause stuttering when running a project with a large amount of nodes (typically a few thousands of nodes or more), even if the editor window isn't focused. This is due to the remote scene tree being updated every second regardless of whether the editor is focused. </member> <member name="debugger/profile_native_calls" type="bool" setter="" getter=""> If [code]true[/code], enables collection of profiling data from non-GDScript Godot functions, such as engine class methods. Enabling this slows execution while profiling further. @@ -222,6 +226,12 @@ <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. </member> + <member name="docks/scene_tree/ask_before_deleting_related_animation_tracks" type="bool" setter="" getter=""> + If [code]true[/code], when a node is deleted with animation tracks referencing it, a confirmation dialog appears before the tracks are deleted. The dialog will appear even when using the "Delete (No Confirm)" shortcut. + </member> + <member name="docks/scene_tree/ask_before_revoking_unique_name" type="bool" setter="" getter=""> + If [code]true[/code], displays a confirmation dialog before left-clicking the "percent" icon next to a node name in the Scene tree dock. When clicked, this icon revokes the node's scene-unique name, which can impact the behavior of scripts that rely on this scene-unique name due to identifiers not being found anymore. + </member> <member name="docks/scene_tree/auto_expand_to_selected" type="bool" setter="" getter=""> If [code]true[/code], the scene tree dock will automatically unfold nodes when a node that has folded parents is selected. </member> @@ -327,6 +337,12 @@ <member name="editors/3d/grid_yz_plane" type="bool" setter="" getter=""> If [code]true[/code], renders the grid on the YZ plane in perspective view. This can be useful for 3D side-scrolling games. </member> + <member name="editors/3d/manipulator_gizmo_opacity" type="float" setter="" getter=""> + Opacity of the default gizmo for moving, rotating, and scaling 3D nodes. + </member> + <member name="editors/3d/manipulator_gizmo_size" type="int" setter="" getter=""> + Size of the default gizmo for moving, rotating, and scaling 3D nodes. + </member> <member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter=""> If [code]true[/code], enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad. When 3-button mouse emulation mode is enabled, the pan, zoom and orbit modifiers can always be used in the 3D editor viewport, even when not holding down any mouse button. @@ -355,6 +371,12 @@ <member name="editors/3d/navigation/pan_mouse_button" type="int" setter="" getter=""> The mouse button that needs to be held down to pan in the 3D editor viewport. </member> + <member name="editors/3d/navigation/show_viewport_navigation_gizmo" type="bool" setter="" getter=""> + If [code]true[/code], shows gizmos for moving and rotating the camera in the bottom corners of the 3D editor's viewport. Useful for devices that use touch screen. + </member> + <member name="editors/3d/navigation/show_viewport_rotation_gizmo" type="bool" setter="" getter=""> + If [code]true[/code], shows a small orientation gizmo in the top-right corner of the 3D editor's viewports. + </member> <member name="editors/3d/navigation/warped_mouse_panning" type="bool" setter="" getter=""> If [code]true[/code], warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. </member> @@ -391,12 +413,78 @@ <member name="editors/3d_gizmos/gizmo_colors/aabb" type="Color" setter="" getter=""> The color to use for the AABB gizmo that displays the [GeometryInstance3D]'s custom [AABB]. </member> + <member name="editors/3d_gizmos/gizmo_colors/camera" type="Color" setter="" getter=""> + The 3D editor gizmo color for [Camera3D]s. + </member> + <member name="editors/3d_gizmos/gizmo_colors/csg" type="Color" setter="" getter=""> + The 3D editor gizmo color for CSG nodes (such as [CSGShape3D] or [CSGBox3D]). + </member> + <member name="editors/3d_gizmos/gizmo_colors/decal" type="Color" setter="" getter=""> + The 3D editor gizmo color for [Decal] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/fog_volume" type="Color" setter="" getter=""> + The 3D editor gizmo color for [FogVolume] nodes. + </member> <member name="editors/3d_gizmos/gizmo_colors/instantiated" type="Color" setter="" getter=""> The color override to use for 3D editor gizmos if the [Node3D] in question is part of an instantiated scene file (from the perspective of the current scene). </member> <member name="editors/3d_gizmos/gizmo_colors/joint" type="Color" setter="" getter=""> The 3D editor gizmo color for [Joint3D]s and [PhysicalBone3D]s. </member> + <member name="editors/3d_gizmos/gizmo_colors/joint_body_a" type="Color" setter="" getter=""> + Color for representing [member Joint3D.node_a] for some [Joint3D] types. + </member> + <member name="editors/3d_gizmos/gizmo_colors/joint_body_b" type="Color" setter="" getter=""> + Color for representing [member Joint3D.node_b] for some [Joint3D] types. + </member> + <member name="editors/3d_gizmos/gizmo_colors/lightmap_lines" type="Color" setter="" getter=""> + Color of lines displayed in baked [LightmapGI] node's grid. + </member> + <member name="editors/3d_gizmos/gizmo_colors/lightprobe_lines" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [LightmapProbe] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/occluder" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [OccluderInstance3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/particle_attractor" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [GPUParticlesAttractor3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/particle_collision" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [GPUParticlesCollision3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/particles" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [CPUParticles3D] and [GPUParticles3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/path_tilt" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [Path3D] tilt circles, which indicate the direction the [Curve3D] is tilted towards. + </member> + <member name="editors/3d_gizmos/gizmo_colors/reflection_probe" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [ReflectionProbe] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/selected_bone" type="Color" setter="" getter=""> + The 3D editor gizmo color used for the currently selected [Skeleton3D] bone. + </member> + <member name="editors/3d_gizmos/gizmo_colors/skeleton" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [Skeleton3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/stream_player_3d" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [AudioStreamPlayer3D]'s emission angle. + </member> + <member name="editors/3d_gizmos/gizmo_colors/visibility_notifier" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [VisibleOnScreenNotifier3D] and [VisibleOnScreenEnabler3D] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_colors/voxel_gi" type="Color" setter="" getter=""> + The 3D editor gizmo color used for [VoxelGI] nodes. + </member> + <member name="editors/3d_gizmos/gizmo_settings/bone_axis_length" type="float" setter="" getter=""> + The length of [Skeleton3D] bone gizmos in the 3D editor. + </member> + <member name="editors/3d_gizmos/gizmo_settings/bone_shape" type="int" setter="" getter=""> + The shape of [Skeleton3D] bone gizmos in the 3D editor. [b]Wire[/b] is a thin line, while [b]Octahedron[/b] is a set of lines that represent a thicker hollow line pointing in a specific direction (similar to most 3D animation software). + </member> + <member name="editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size" type="float" setter="" getter=""> + Size of the disk gizmo displayed when editing [Path3D]'s tilt handles. + </member> <member name="editors/animation/autorename_animation_tracks" type="bool" setter="" getter=""> If [code]true[/code], automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock. </member> @@ -416,9 +504,26 @@ <member name="editors/animation/onion_layers_past_color" type="Color" setter="" getter=""> The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature. </member> + <member name="editors/bone_mapper/handle_colors/error" type="Color" setter="" getter=""> + </member> + <member name="editors/bone_mapper/handle_colors/missing" type="Color" setter="" getter=""> + </member> + <member name="editors/bone_mapper/handle_colors/set" type="Color" setter="" getter=""> + </member> + <member name="editors/bone_mapper/handle_colors/unset" type="Color" setter="" getter=""> + </member> + <member name="editors/grid_map/editor_side" type="int" setter="" getter=""> + Specifies the side of 3D editor's viewport where GridMap's mesh palette will appear. + </member> + <member name="editors/grid_map/palette_min_width" type="int" setter="" getter=""> + Minimum width of GridMap's mesh palette side panel. + </member> <member name="editors/grid_map/pick_distance" type="float" setter="" getter=""> The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units). </member> + <member name="editors/grid_map/preview_size" type="int" setter="" getter=""> + Texture size of mesh previews generated for GridMap's MeshLibrary. + </member> <member name="editors/panning/2d_editor_pan_speed" type="int" setter="" getter=""> The panning speed when using the mouse wheel or touchscreen events in the 2D editor. This setting does not apply to panning by holding down the middle or right mouse buttons. </member> @@ -528,6 +633,13 @@ <member name="editors/visual_editors/visual_shader/port_preview_size" type="int" setter="" getter=""> The size to use for port previews in the visual shader uniforms (toggled by clicking the "eye" icon next to an output). The value is defined in pixels at 100% zoom, and will scale with zoom automatically. </member> + <member name="export/ssh/scp" type="String" setter="" getter=""> + Path to the SCP (secure copy) executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run [code]scp[/code] from [code]PATH[/code]. + [b]Note:[/b] SCP is not the same as SFTP. Specifying the SFTP executable here will not work. + </member> + <member name="export/ssh/ssh" type="String" setter="" getter=""> + Path to the SSH executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run [code]ssh[/code] from [code]PATH[/code]. + </member> <member name="filesystem/directories/autoscan_project_path" type="String" setter="" getter=""> The folder where projects should be scanned for (recursively), in a way similar to the project manager's [b]Scan[/b] button. This can be set to the same value as [member filesystem/directories/default_project_path] for convenience. [b]Note:[/b] Setting this path to a folder with very large amounts of files/folders can slow down the project manager startup significantly. To keep the project manager quick to start up, it is recommended to set this value to a folder as "specific" as possible. @@ -573,6 +685,12 @@ <member name="filesystem/file_dialog/thumbnail_size" type="int" setter="" getter=""> The thumbnail size to use in the editor's file dialogs (in pixels). See also [member docks/filesystem/thumbnail_size]. </member> + <member name="filesystem/file_server/password" type="String" setter="" getter=""> + Password used for file server when exporting project with remote file system. + </member> + <member name="filesystem/file_server/port" type="int" setter="" getter=""> + Port used for file server when exporting project with remote file system. + </member> <member name="filesystem/import/blender/blender_path" type="String" setter="" getter=""> The path to the directory containing the Blender executable used for converting the Blender 3D scene files [code].blend[/code] to glTF 2.0 format during import. Blender 3.0 or later is required. To enable this feature for your specific project, use [member ProjectSettings.filesystem/import/blender/enabled]. @@ -596,6 +714,12 @@ If [code]true[/code], when saving a file, the editor will rename the old file to a different name, save a new file, then only remove the old file once the new file has been saved. This makes loss of data less likely to happen if the editor or operating system exits unexpectedly while saving (e.g. due to a crash or power outage). [b]Note:[/b] On Windows, this feature can interact negatively with certain antivirus programs. In this case, you may have to set this to [code]false[/code] to prevent file locking issues. </member> + <member name="filesystem/quick_open_dialog/default_display_mode" type="int" setter="" getter=""> + If set to [code]Adaptive[/code], the dialog opens in list view or grid view depending on the requested type. If set to [code]Last Used[/code], the display mode will always open the way you last used it. + </member> + <member name="filesystem/quick_open_dialog/include_addons" type="bool" setter="" getter=""> + If [code]true[/code], results will include files located in the [code]addons[/code] folder. + </member> <member name="filesystem/tools/oidn/oidn_denoise_path" type="String" setter="" getter=""> The path to the directory containing the Open Image Denoise (OIDN) executable, used optionally for denoising lightmaps. It can be downloaded from [url=https://www.openimagedenoise.org/downloads.html]openimagedenoise.org[/url]. To enable this feature for your specific project, use [member ProjectSettings.rendering/lightmapping/denoising/denoiser]. @@ -654,7 +778,7 @@ Translations are provided by the community. If you spot a mistake, [url=$DOCS_URL/contributing/documentation/editor_and_docs_localization.html]contribute to editor translations on Weblate![/url] </member> <member name="interface/editor/editor_screen" type="int" setter="" getter=""> - The preferred monitor to display the editor. + The preferred monitor to display the editor. If [b]Auto[/b], the editor will remember the last screen it was displayed on across restarts. </member> <member name="interface/editor/expand_to_title" type="bool" setter="" getter=""> Expanding main editor window content to the title, if supported by [DisplayServer]. See [constant DisplayServer.WINDOW_FLAG_EXTEND_TO_TITLE]. @@ -708,9 +832,6 @@ <member name="interface/editor/project_manager_screen" type="int" setter="" getter=""> The preferred monitor to display the project manager. </member> - <member name="interface/editor/remember_window_size_and_position" type="bool" setter="" getter=""> - If [code]true[/code], the editor window will remember its size, position, and which screen it was displayed on across restarts. - </member> <member name="interface/editor/save_each_scene_on_quit" type="bool" setter="" getter=""> If [code]false[/code], the editor will save all scenes when confirming the [b]Save[/b] action when quitting the editor or quitting to the project list. If [code]true[/code], the editor will ask to save each scene individually. </member> @@ -759,6 +880,12 @@ Depending on the platform and used renderer, the engine will fall back to [b]Enabled[/b] if the desired mode is not supported. [b]Note:[/b] V-Sync modes other than [b]Enabled[/b] are only supported in the Forward+ and Mobile rendering methods, not Compatibility. </member> + <member name="interface/editors/derive_script_globals_by_name" type="bool" setter="" getter=""> + If [code]true[/code], when extending a script, the global class name of the script is inserted in the script creation dialog, if it exists. If [code]false[/code], the script's file path is always inserted. + </member> + <member name="interface/editors/show_scene_tree_root_selection" type="bool" setter="" getter=""> + If [code]true[/code], the Scene dock will display buttons to quickly add a root node to a newly created scene. + </member> <member name="interface/inspector/auto_unfold_foreign_scenes" type="bool" setter="" getter=""> If [code]true[/code], automatically expands property groups in the Inspector dock when opening a scene that hasn't been opened previously. If [code]false[/code], all groups remain collapsed by default. </member> @@ -780,7 +907,7 @@ </member> <member name="interface/inspector/delimitate_all_container_and_resources" type="bool" setter="" getter=""> If [code]true[/code], add a margin around Array, Dictionary, and Resource Editors that are not already colored. - [b]Note:[/b] If [member interface/inspector/nested_color_mode] is set to [b]Containers & Resources[/b] this parameter will have no effect since those editors will already be colored + [b]Note:[/b] If [member interface/inspector/nested_color_mode] is set to [b]Containers & Resources[/b] this parameter will have no effect since those editors will already be colored. </member> <member name="interface/inspector/disable_folding" type="bool" setter="" getter=""> If [code]true[/code], forces all property groups to be expanded in the Inspector dock and prevents collapsing them. @@ -1052,6 +1179,9 @@ <member name="text_editor/appearance/whitespace/line_spacing" type="int" setter="" getter=""> The space to add between lines (in pixels). Greater line spacing can help improve readability at the cost of displaying fewer lines on screen. </member> + <member name="text_editor/behavior/files/auto_reload_and_parse_scripts_on_save" type="bool" setter="" getter=""> + If [code]true[/code], tool scripts will be automatically soft-reloaded after they are saved. + </member> <member name="text_editor/behavior/files/auto_reload_scripts_on_external_change" type="bool" setter="" getter=""> If [code]true[/code], automatically reloads scripts in the editor when they have been modified and saved by external editors. </member> @@ -1061,6 +1191,9 @@ <member name="text_editor/behavior/files/convert_indent_on_save" type="bool" setter="" getter=""> If [code]true[/code], converts indentation to match the script editor's indentation settings when saving a script. See also [member text_editor/behavior/indent/type]. </member> + <member name="text_editor/behavior/files/open_dominant_script_on_scene_change" type="bool" setter="" getter=""> + If [code]true[/code], opening a scene automatically opens the script attached to the root node, or the topmost node if the root has no script. + </member> <member name="text_editor/behavior/files/restore_scripts_on_load" type="bool" setter="" getter=""> If [code]true[/code], reopens scripts that were opened in the last session when the editor is reopened on a given project. </member> @@ -1070,6 +1203,9 @@ <member name="text_editor/behavior/files/trim_trailing_whitespace_on_save" type="bool" setter="" getter=""> If [code]true[/code], trims trailing whitespace when saving a script. Trailing whitespace refers to tab and space characters placed at the end of lines. Since these serve no practical purpose, they can and should be removed to make version control diffs less noisy. </member> + <member name="text_editor/behavior/general/empty_selection_clipboard" type="bool" setter="" getter=""> + If [code]true[/code], copying or cutting without a selection is performed on all lines with a caret. Otherwise, copy and cut require a selection. + </member> <member name="text_editor/behavior/indent/auto_indent" type="bool" setter="" getter=""> If [code]true[/code], automatically indents code when pressing the [kbd]Enter[/kbd] key based on blocks above the new line. </member> @@ -1148,6 +1284,15 @@ <member name="text_editor/completion/use_single_quotes" type="bool" setter="" getter=""> If [code]true[/code], performs string autocompletion with single quotes. If [code]false[/code], performs string autocompletion with double quotes (which matches the [url=$DOCS_URL/tutorials/scripting/gdscript/gdscript_styleguide.html]GDScript style guide[/url]). </member> + <member name="text_editor/external/exec_flags" type="String" setter="" getter=""> + The command-line arguments to pass to the external text editor that is run when [member text_editor/external/use_external_editor] is [code]true[/code]. See also [member text_editor/external/exec_path]. + </member> + <member name="text_editor/external/exec_path" type="String" setter="" getter=""> + The path to the text editor executable used to edit text files if [member text_editor/external/use_external_editor] is [code]true[/code]. + </member> + <member name="text_editor/external/use_external_editor" type="bool" setter="" getter=""> + If [code]true[/code], uses an external editor instead of the built-in Script Editor. See also [member text_editor/external/exec_path] and [member text_editor/external/exec_flags]. + </member> <member name="text_editor/help/class_reference_examples" type="int" setter="" getter=""> Controls which multi-line code blocks should be displayed in the editor help. This setting does not affect single-line code literals in the editor help. </member> @@ -1163,6 +1308,21 @@ <member name="text_editor/help/show_help_index" type="bool" setter="" getter=""> If [code]true[/code], displays a table of contents at the left of the editor help (at the location where the members overview would appear when editing a script). </member> + <member name="text_editor/help/sort_functions_alphabetically" type="bool" setter="" getter=""> + If [code]true[/code], the script's method list in the Script Editor is sorted alphabetically. + </member> + <member name="text_editor/script_list/group_help_pages" type="bool" setter="" getter=""> + If [code]true[/code], class reference pages are grouped together at the bottom of the Script Editor's script list. + </member> + <member name="text_editor/script_list/list_script_names_as" type="int" setter="" getter=""> + Specifies how script paths should be displayed in Script Editor's script list. If using the "Name" option and some scripts share the same file name, more parts of their paths are revealed to avoid conflicts. + </member> + <member name="text_editor/script_list/script_temperature_enabled" type="bool" setter="" getter=""> + If [code]true[/code], the names of recently opened scripts in the Script Editor are highlighted with the accent color, with its intensity based on how recently they were opened. + </member> + <member name="text_editor/script_list/script_temperature_history_size" type="int" setter="" getter=""> + How many script names can be highlighted at most, if [member text_editor/script_list/script_temperature_enabled] is [code]true[/code]. Scripts older than this value use the default font color. + </member> <member name="text_editor/script_list/show_members_overview" type="bool" setter="" getter=""> If [code]true[/code], displays an overview of the current script's member variables and functions at the left of the script editor. See also [member text_editor/script_list/sort_members_outline_alphabetically]. </member> @@ -1170,6 +1330,9 @@ If [code]true[/code], sorts the members outline (located at the left of the script editor) using alphabetical order. If [code]false[/code], sorts the members outline depending on the order in which members are found in the script. [b]Note:[/b] Only effective if [member text_editor/script_list/show_members_overview] is [code]true[/code]. </member> + <member name="text_editor/script_list/sort_scripts_by" type="int" setter="" getter=""> + Specifies sorting used for Script Editor's open script list. + </member> <member name="text_editor/theme/color_theme" type="String" setter="" getter=""> The syntax theme to use in the script editor. You can save your own syntax theme from your current settings by using [b]File > Theme > Save As...[/b] at the top of the script editor. The syntax theme will then be available locally in the list of color themes. @@ -1294,6 +1457,18 @@ <member name="text_editor/theme/highlighting/word_highlighted_color" type="Color" setter="" getter=""> The script editor's color for words highlighted by selecting them. Only visible if [member text_editor/appearance/caret/highlight_all_occurrences] is [code]true[/code]. </member> + <member name="text_editor/theme/line_spacing" type="int" setter="" getter=""> + The vertical line separation used in text editors, in pixels. + </member> + <member name="version_control/ssh_private_key_path" type="String" setter="" getter=""> + Path to private SSH key file for the editor's Version Control integration credentials. + </member> + <member name="version_control/ssh_public_key_path" type="String" setter="" getter=""> + Path to public SSH key file for the editor's Version Control integration credentials. + </member> + <member name="version_control/username" type="String" setter="" getter=""> + Default username for editor's Version Control integration. + </member> </members> <signals> <signal name="settings_changed"> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index ca78054875..bba5157053 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -337,6 +337,10 @@ [b]Note:[/b] This property does not impact the editor's Errors tab when running a project from the editor. [b]Warning:[/b] If set to [code]false[/code] anywhere in the project, important error messages may be hidden even if they are emitted from other scripts. In a [code]@tool[/code] script, this will also impact the editor itself. Do [i]not[/i] report bugs before ensuring error messages are enabled (as they are by default). </member> + <member name="print_to_stdout" type="bool" setter="set_print_to_stdout" getter="is_printing_to_stdout" default="true"> + If [code]false[/code], stops printing messages (for example using [method @GlobalScope.print]) to the console, log files, and editor Output log. This property is equivalent to the [member ProjectSettings.application/run/disable_stdout] project setting. + [b]Note:[/b] This does not stop printing errors or warnings produced by scripts to the console or log files, for more details see [member print_error_messages]. + </member> <member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale" default="1.0"> The speed multiplier at which the in-game clock updates, compared to real time. For example, if set to [code]2.0[/code] the game runs twice as fast, and if set to [code]0.5[/code] the game runs half as fast. This value affects [Timer], [SceneTreeTimer], and all other simulations that make use of [code]delta[/code] time (such as [method Node._process] and [method Node._physics_process]). diff --git a/doc/classes/EngineDebugger.xml b/doc/classes/EngineDebugger.xml index 7583520da0..bcc1ac5299 100644 --- a/doc/classes/EngineDebugger.xml +++ b/doc/classes/EngineDebugger.xml @@ -87,7 +87,7 @@ <method name="line_poll"> <return type="void" /> <description> - Forces a processing loop of debugger events. The purpose of this method is just processing events every now and then when the script might get too busy, so that bugs like infinite loops can be caught + Forces a processing loop of debugger events. The purpose of this method is just processing events every now and then when the script might get too busy, so that bugs like infinite loops can be caught. </description> </method> <method name="profiler_add_frame_data"> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 8c26509812..de3295fbe0 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -414,7 +414,7 @@ Linear tonemapper operator. Reads the linear data and passes it on unmodified. This can cause bright lighting to look blown out, with noticeable clipping in the output colors. </constant> <constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper"> - Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. This avoids clipping bright highlights, but the resulting image can look a bit dull. + Reinhard tonemapper operator. Performs a variation on rendered pixels' colors by this formula: [code]color = color * (1 + color / (white * white)) / (1 + color)[/code]. This avoids clipping bright highlights, but the resulting image can look a bit dull. When [member tonemap_white] is left at the default value of [code]1.0[/code] this is identical to [constant TONE_MAPPER_LINEAR] while also being slightly less performant. </constant> <constant name="TONE_MAPPER_FILMIC" value="2" enum="ToneMapper"> Filmic tonemapper operator. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than [constant TONE_MAPPER_REINHARDT]. diff --git a/doc/classes/ExternalTexture.xml b/doc/classes/ExternalTexture.xml new file mode 100644 index 0000000000..6f27b62f24 --- /dev/null +++ b/doc/classes/ExternalTexture.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ExternalTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + Texture which displays the content of an external buffer. + </brief_description> + <description> + Displays the content of an external buffer provided by the platform. + Requires the [url=https://registry.khronos.org/OpenGL/extensions/OES/OES_EGL_image_external.txt]OES_EGL_image_external[/url] extension (OpenGL) or [url=https://registry.khronos.org/vulkan/specs/1.1-extensions/html/vkspec.html#VK_ANDROID_external_memory_android_hardware_buffer]VK_ANDROID_external_memory_android_hardware_buffer[/url] extension (Vulkan). + [b]Note:[/b] This is currently only supported in Android builds. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_external_texture_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the external texture ID. + Depending on your use case, you may need to pass this to platform APIs, for example, when creating an [code]android.graphics.SurfaceTexture[/code] on Android. + </description> + </method> + <method name="set_external_buffer_id"> + <return type="void" /> + <param index="0" name="external_buffer_id" type="int" /> + <description> + Sets the external buffer ID. + Depending on your use case, you may need to call this with data received from a platform API, for example, [code]SurfaceTexture.getHardwareBuffer()[/code] on Android. + </description> + </method> + </methods> + <members> + <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" type="Vector2" setter="set_size" getter="get_size" default="Vector2(256, 256)"> + External texture size. + </member> + </members> +</class> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 38985e99ae..1ae889adc1 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -151,6 +151,7 @@ If [code]true[/code], the dialog will show hidden files. [b]Note:[/b] This property is ignored by native file dialogs on Linux. </member> + <member name="size" type="Vector2i" setter="set_size" getter="get_size" overrides="Window" default="Vector2i(640, 360)" /> <member name="title" type="String" setter="set_title" getter="get_title" overrides="Window" default=""Save a File"" /> <member name="use_native_dialog" type="bool" setter="set_use_native_dialog" getter="get_use_native_dialog" default="false"> If [code]true[/code], [member access] is set to [constant ACCESS_FILESYSTEM], and it is supported by the current [DisplayServer], OS native dialog will be used instead of custom one. diff --git a/doc/classes/FontFile.xml b/doc/classes/FontFile.xml index 1b8fa00772..c230bf5ad2 100644 --- a/doc/classes/FontFile.xml +++ b/doc/classes/FontFile.xml @@ -58,7 +58,7 @@ <return type="void" /> <param index="0" name="cache_index" type="int" /> <description> - Removes all font sizes from the cache entry + Removes all font sizes from the cache entry. </description> </method> <method name="clear_textures"> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 670df10a89..3451e427f3 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -399,6 +399,11 @@ Emitted when this [GraphEdit] captures a [code]ui_copy[/code] action ([kbd]Ctrl + C[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be copied. </description> </signal> + <signal name="cut_nodes_request"> + <description> + Emitted when this [GraphEdit] captures a [code]ui_cut[/code] action ([kbd]Ctrl + X[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be cut. + </description> + </signal> <signal name="delete_nodes_request"> <param index="0" name="nodes" type="StringName[]" /> <description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 864c29a2b5..af98636056 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -12,7 +12,7 @@ [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. [b]Note:[/b] It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. [b]Note:[/b] When performing HTTP requests from a project exported to Web, keep in mind the remote server may not allow requests from foreign origins due to [url=https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS]CORS[/url]. If you host the server in question, you should modify its backend to allow requests from foreign origins by adding the [code]Access-Control-Allow-Origin: *[/code] HTTP header. - [b]Note:[/b] TLS support is currently limited to TLS 1.0, TLS 1.1, and TLS 1.2. Attempting to connect to a TLS 1.3-only server will return an error. + [b]Note:[/b] TLS support is currently limited to TLSv1.2 and TLSv1.3. Attempting to connect to a server that only supports older (insecure) TLS versions will return an error. [b]Warning:[/b] TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. </description> <tutorials> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index a970f63c6e..6cf490accb 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -91,6 +91,7 @@ <description> Returns [code]true[/code] if the specified [param event] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + [b]Note:[/b] Only considers the event configuration (such as the keyboard key or joypad axis), not state information like [method is_pressed], [method is_released], [method is_echo], or [method is_canceled]. </description> </method> <method name="is_pressed" qualifiers="const"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index a1e5d9cbd9..c60a2ca887 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -407,13 +407,14 @@ <param index="0" name="at_position" type="Vector2" /> <param index="1" name="mouse_button_index" type="int" /> <description> - Triggered when any mouse click is issued within the rect of the list but on empty space. + Emitted when any mouse click is issued within the rect of the list but on empty space. + [param at_position] is the click position in this control's local coordinate system. </description> </signal> <signal name="item_activated"> <param index="0" name="index" type="int" /> <description> - Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. + Emitted when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. </description> </signal> <signal name="item_clicked"> @@ -421,14 +422,14 @@ <param index="1" name="at_position" type="Vector2" /> <param index="2" name="mouse_button_index" type="int" /> <description> - Triggered when specified list item has been clicked with any mouse button. - The click position is also provided to allow appropriate popup of context menus at the correct location. + Emitted when specified list item has been clicked with any mouse button. + [param at_position] is the click position in this control's local coordinate system. </description> </signal> <signal name="item_selected"> <param index="0" name="index" type="int" /> <description> - Triggered when specified item has been selected. + Emitted when specified item has been selected. Only applicable in single selection mode. [member allow_reselect] must be enabled to reselect an item. </description> </signal> @@ -436,7 +437,7 @@ <param index="0" name="index" type="int" /> <param index="1" name="selected" type="bool" /> <description> - Triggered when a multiple selection is altered on a list allowing multiple selection. + Emitted when a multiple selection is altered on a list allowing multiple selection. </description> </signal> </signals> diff --git a/doc/classes/JavaScriptBridge.xml b/doc/classes/JavaScriptBridge.xml index faf5424c47..ea3ede8857 100644 --- a/doc/classes/JavaScriptBridge.xml +++ b/doc/classes/JavaScriptBridge.xml @@ -60,6 +60,20 @@ Returns an interface to a JavaScript object that can be used by scripts. The [param interface] must be a valid property of the JavaScript [code]window[/code]. The callback must accept a single [Array] argument, which will contain the JavaScript [code]arguments[/code]. See [JavaScriptObject] for usage. </description> </method> + <method name="is_js_buffer"> + <return type="bool" /> + <param index="0" name="javascript_object" type="JavaScriptObject" /> + <description> + Returns [code]true[/code] if the given [param javascript_object] is of type [url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer][code]ArrayBuffer[/code][/url], [url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView][code]DataView[/code][/url], or one of the many [url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray]typed array objects[/url]. + </description> + </method> + <method name="js_buffer_to_packed_byte_array"> + <return type="PackedByteArray" /> + <param index="0" name="javascript_buffer" type="JavaScriptObject" /> + <description> + Returns a copy of [param javascript_buffer]'s contents as a [PackedByteArray]. See also [method is_js_buffer]. + </description> + </method> <method name="pwa_needs_update" qualifiers="const"> <return type="bool" /> <description> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index e6eba30ab7..f91006f69a 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -14,7 +14,7 @@ <return type="Rect2" /> <param index="0" name="pos" type="int" /> <description> - Returns the bounding rectangle of the character at position [param pos]. If the character is a non-visual character or [param pos] is outside the valid range, an empty [Rect2] is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned. + Returns the bounding rectangle of the character at position [param pos] in the label's local coordinate system. If the character is a non-visual character or [param pos] is outside the valid range, an empty [Rect2] is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned. </description> </method> <method name="get_line_count" qualifiers="const"> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index f938460c2f..41f42392de 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -4,7 +4,14 @@ An input field for single-line text. </brief_description> <description> - [LineEdit] provides an input field for editing a single line of text. It features many built-in shortcuts that are always available ([kbd]Ctrl[/kbd] here maps to [kbd]Cmd[/kbd] on macOS): + [LineEdit] provides an input field for editing a single line of text. + - When the [LineEdit] control is focused using the keyboard arrow keys, it will only gain focus and not enter edit mode. + - To enter edit mode, click on the control with the mouse or press the [code]ui_text_submit[/code] action (by default [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]). + - To exit edit mode, press [code]ui_text_submit[/code] or [code]ui_cancel[/code] (by default [kbd]Escape[/kbd]) actions. + - Check [method is_editing] and [signal editing_toggled] for more information. + [b]Important:[/b] + - Focusing the [LineEdit] with [code]ui_focus_next[/code] (by default [kbd]Tab[/kbd]) or [code]ui_focus_prev[/code] (by default [kbd]Shift + Tab[/kbd]) or [method Control.grab_focus] still enters edit mode (for compatibility). + [LineEdit] features many built-in shortcuts that are always available ([kbd]Ctrl[/kbd] here maps to [kbd]Cmd[/kbd] on macOS): - [kbd]Ctrl + C[/kbd]: Copy - [kbd]Ctrl + X[/kbd]: Cut - [kbd]Ctrl + V[/kbd] or [kbd]Ctrl + Y[/kbd]: Paste/"yank" @@ -30,6 +37,18 @@ <tutorials> </tutorials> <methods> + <method name="apply_ime"> + <return type="void" /> + <description> + Applies text from the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) and closes the IME if it is open. + </description> + </method> + <method name="cancel_ime"> + <return type="void" /> + <description> + Closes the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) if it is open. Any text in the IME will be lost. + </description> + </method> <method name="clear"> <return type="void" /> <description> @@ -126,12 +145,30 @@ Returns the selection end column. </description> </method> + <method name="has_ime_text" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the user has text in the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME). + </description> + </method> + <method name="has_redo" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if a "redo" action is available. + </description> + </method> <method name="has_selection" qualifiers="const"> <return type="bool" /> <description> Returns [code]true[/code] if the user has selected text. </description> </method> + <method name="has_undo" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if an "undo" action is available. + </description> + </method> <method name="insert_text_at_caret"> <return type="void" /> <param index="0" name="text" type="String" /> @@ -139,6 +176,12 @@ Inserts [param text] at the caret. If the resulting value is longer than [member max_length], nothing happens. </description> </method> + <method name="is_editing" qualifiers="const"> + <return type="bool" /> + <description> + Returns whether the [LineEdit] is being edited. + </description> + </method> <method name="is_menu_visible" qualifiers="const"> <return type="bool" /> <description> @@ -301,6 +344,12 @@ </member> </members> <signals> + <signal name="editing_toggled"> + <param index="0" name="toggled_on" type="bool" /> + <description> + Emitted when the [LineEdit] switches in or out of edit mode. + </description> + </signal> <signal name="text_change_rejected"> <param index="0" name="rejected_substring" type="String" /> <description> @@ -316,7 +365,7 @@ <signal name="text_submitted"> <param index="0" name="new_text" type="String" /> <description> - Emitted when the user presses [constant KEY_ENTER] on the [LineEdit]. + Emitted when the user presses the [code]ui_text_submit[/code] action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]) while the [LineEdit] has focus. </description> </signal> </signals> diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index a0d03d7a01..7e78006240 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -486,7 +486,7 @@ <param index="0" name="map" type="RID" /> <param index="1" name="to_point" type="Vector2" /> <description> - Returns the point closest to the provided [param to_point] on the navigation mesh surface. + Returns the navigation mesh surface point closest to the provided [param to_point] on the navigation [param map]. </description> </method> <method name="map_get_closest_point_owner" qualifiers="const"> @@ -494,7 +494,7 @@ <param index="0" name="map" type="RID" /> <param index="1" name="to_point" type="Vector2" /> <description> - Returns the owner region RID for the point returned by [method map_get_closest_point]. + Returns the owner region RID for the navigation mesh surface point closest to the provided [param to_point] on the navigation [param map]. </description> </method> <method name="map_get_edge_connection_margin" qualifiers="const"> @@ -768,6 +768,14 @@ Creates a new region. </description> </method> + <method name="region_get_closest_point" qualifiers="const"> + <return type="Vector2" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="to_point" type="Vector2" /> + <description> + Returns the navigation mesh surface point closest to the provided [param to_point] on the navigation [param region]. + </description> + </method> <method name="region_get_connection_pathway_end" qualifiers="const"> <return type="Vector2" /> <param index="0" name="region" type="RID" /> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 42f6235f8b..7e206046d6 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -532,7 +532,7 @@ <param index="0" name="map" type="RID" /> <param index="1" name="to_point" type="Vector3" /> <description> - Returns the point closest to the provided [param to_point] on the navigation mesh surface. + Returns the navigation mesh surface point closest to the provided [param to_point] on the navigation [param map]. </description> </method> <method name="map_get_closest_point_normal" qualifiers="const"> @@ -540,7 +540,7 @@ <param index="0" name="map" type="RID" /> <param index="1" name="to_point" type="Vector3" /> <description> - Returns the normal for the point returned by [method map_get_closest_point]. + Returns the navigation mesh surface normal closest to the provided [param to_point] on the navigation [param map]. </description> </method> <method name="map_get_closest_point_owner" qualifiers="const"> @@ -548,7 +548,7 @@ <param index="0" name="map" type="RID" /> <param index="1" name="to_point" type="Vector3" /> <description> - Returns the owner region RID for the point returned by [method map_get_closest_point]. + Returns the owner region RID for the navigation mesh surface point closest to the provided [param to_point] on the navigation [param map]. </description> </method> <method name="map_get_closest_point_to_segment" qualifiers="const"> @@ -558,7 +558,8 @@ <param index="2" name="end" type="Vector3" /> <param index="3" name="use_collision" type="bool" default="false" /> <description> - Returns the closest point between the navigation surface and the segment. + Returns the navigation mesh surface point closest to the provided [param start] and [param end] segment on the navigation [param map]. + If [param use_collision] is [code]true[/code], a closest point test is only done when the segment intersects with the navigation mesh surface. </description> </method> <method name="map_get_edge_connection_margin" qualifiers="const"> @@ -908,6 +909,33 @@ Creates a new region. </description> </method> + <method name="region_get_closest_point" qualifiers="const"> + <return type="Vector3" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="to_point" type="Vector3" /> + <description> + Returns the navigation mesh surface point closest to the provided [param to_point] on the navigation [param region]. + </description> + </method> + <method name="region_get_closest_point_normal" qualifiers="const"> + <return type="Vector3" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="to_point" type="Vector3" /> + <description> + Returns the navigation mesh surface normal closest to the provided [param to_point] on the navigation [param region]. + </description> + </method> + <method name="region_get_closest_point_to_segment" qualifiers="const"> + <return type="Vector3" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="start" type="Vector3" /> + <param index="2" name="end" type="Vector3" /> + <param index="3" name="use_collision" type="bool" default="false" /> + <description> + Returns the navigation mesh surface point closest to the provided [param start] and [param end] segment on the navigation [param region]. + If [param use_collision] is [code]true[/code], a closest point test is only done when the segment intersects with the navigation mesh surface. + </description> + </method> <method name="region_get_connection_pathway_end" qualifiers="const"> <return type="Vector3" /> <param index="0" name="region" type="RID" /> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index ae1eff4220..42753f7071 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -498,6 +498,12 @@ Returns the time elapsed (in seconds) since the last process callback. This value is identical to [method _process]'s [code]delta[/code] parameter, and may vary from frame to frame. See also [constant NOTIFICATION_PROCESS]. </description> </method> + <method name="get_rpc_config" qualifiers="const"> + <return type="Variant" /> + <description> + Returns a [Dictionary] mapping method names to their RPC configuration defined for this node using [method rpc_config]. + </description> + </method> <method name="get_scene_instance_load_placeholder" qualifiers="const"> <return type="bool" /> <description> @@ -967,6 +973,13 @@ Similar to [method call_thread_safe], but for setting properties. </description> </method> + <method name="set_translation_domain_inherited"> + <return type="void" /> + <description> + Makes this node inherit the translation domain from its parent node. If this node has no parent, the main translation domain will be used. + This is the default behavior for all nodes. Calling [method Object.set_translation_domain] disables this behavior. + </description> + </method> <method name="update_configuration_warnings"> <return type="void" /> <description> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 851290de7b..0b2dfcea03 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -95,43 +95,44 @@ </methods> <members> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> - Global position. + Global position. See also [member position]. </member> <member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation"> - Global rotation in radians. + Global rotation in radians. See also [member rotation]. </member> <member name="global_rotation_degrees" type="float" setter="set_global_rotation_degrees" getter="get_global_rotation_degrees"> - Helper property to access [member global_rotation] in degrees instead of radians. + Helper property to access [member global_rotation] in degrees instead of radians. See also [member rotation_degrees]. </member> <member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale"> - Global scale. + Global scale. See also [member scale]. </member> <member name="global_skew" type="float" setter="set_global_skew" getter="get_global_skew"> - Global skew in radians. + Global skew in radians. See also [member skew]. </member> <member name="global_transform" type="Transform2D" setter="set_global_transform" getter="get_global_transform"> - Global [Transform2D]. + Global [Transform2D]. See also [member transform]. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)"> - Position, relative to the node's parent. + Position, relative to the node's parent. See also [member global_position]. </member> <member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0"> - Rotation in radians, relative to the node's parent. + Rotation in radians, relative to the node's parent. See also [member global_rotation]. [b]Note:[/b] This property is edited in the inspector in degrees. If you want to use degrees in a script, use [member rotation_degrees]. </member> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> - Helper property to access [member rotation] in degrees instead of radians. + Helper property to access [member rotation] in degrees instead of radians. See also [member global_rotation_degrees]. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2(1, 1)"> - The node's scale. Unscaled value: [code](1, 1)[/code]. + The node's scale, relative to the node's parent. Unscaled value: [code](1, 1)[/code]. See also [member global_scale]. [b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. </member> <member name="skew" type="float" setter="set_skew" getter="get_skew" default="0.0"> - Slants the node. - [b]Note:[/b] Skew is X axis only. + If set to a non-zero value, slants the node in one direction or another. This can be used for pseudo-3D effects. See also [member global_skew]. + [b]Note:[/b] Skew is performed on the X axis only, and [i]between[/i] rotation and scaling. + [b]Note:[/b] This property is edited in the inspector in degrees. If you want to use degrees in a script, use [code]skew = deg_to_rad(value_in_degrees)[/code]. </member> <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> - Local [Transform2D]. + The node's [Transform2D], relative to the node's parent. See also [member global_transform]. </member> </members> </class> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index a331c05e47..2767a11e80 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -818,6 +818,20 @@ [b]Note:[/b] Due of the implementation, each [Dictionary] is formatted very similarly to the returned values of [method get_method_list]. </description> </method> + <method name="get_translation_domain" qualifiers="const"> + <return type="StringName" /> + <description> + Returns the name of the translation domain used by [method tr] and [method tr_n]. See also [TranslationServer]. + </description> + </method> + <method name="has_connections" qualifiers="const"> + <return type="bool" /> + <param index="0" name="signal" type="StringName" /> + <description> + Returns [code]true[/code] if any connection exists on the given [param signal] name. + [b]Note:[/b] In C#, [param signal] must be in snake_case when referring to built-in Godot methods. Prefer using the names exposed in the [code]SignalName[/code] class to avoid allocating a new [StringName] on each call. + </description> + </method> <method name="has_meta" qualifiers="const"> <return type="bool" /> <param index="0" name="name" type="StringName" /> @@ -1070,6 +1084,13 @@ If a script already exists, its instance is detached, and its property values and state are lost. Built-in property values are still kept. </description> </method> + <method name="set_translation_domain"> + <return type="void" /> + <param index="0" name="domain" type="StringName" /> + <description> + Sets the name of the translation domain used by [method tr] and [method tr_n]. See also [TranslationServer]. + </description> + </method> <method name="to_string"> <return type="String" /> <description> @@ -1121,7 +1142,7 @@ Notification received when the object is initialized, before its script is attached. Used internally. </constant> <constant name="NOTIFICATION_PREDELETE" value="1"> - Notification received when the object is about to be deleted. Can act as the deconstructor of some programming languages. + Notification received when the object is about to be deleted. Can be used like destructors in object-oriented programming languages. </constant> <constant name="NOTIFICATION_EXTENSION_RELOADED" value="2"> Notification received when the object finishes hot reloading. This notification is only sent for extensions classes and derived. diff --git a/doc/classes/OptimizedTranslation.xml b/doc/classes/OptimizedTranslation.xml index 124f430f1b..bc158984d7 100644 --- a/doc/classes/OptimizedTranslation.xml +++ b/doc/classes/OptimizedTranslation.xml @@ -14,6 +14,7 @@ <param index="0" name="from" type="Translation" /> <description> Generates and sets an optimized translation from the given [Translation] resource. + [b]Note:[/b] This method is intended to be used in the editor. It does nothing when called from an exported project. </description> </method> </methods> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 494e9966ac..ec0300c068 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -42,12 +42,12 @@ </method> <method name="pck_start"> <return type="int" enum="Error" /> - <param index="0" name="pck_name" type="String" /> + <param index="0" name="pck_path" type="String" /> <param index="1" name="alignment" type="int" default="32" /> <param index="2" name="key" type="String" default=""0000000000000000000000000000000000000000000000000000000000000000"" /> <param index="3" name="encrypt_directory" type="bool" default="false" /> <description> - Creates a new PCK file with the name [param pck_name]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [param pck_name] (even though it's not required). + Creates a new PCK file at the file path [param pck_path]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [param pck_path] (even though it's not required). </description> </method> </methods> diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index e179c111a2..75193ae8ed 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -307,6 +307,13 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> + <method name="get" qualifiers="const"> + <return type="int" /> + <param index="0" name="index" type="int" /> + <description> + Returns the byte at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="get_string_from_ascii" qualifiers="const"> <return type="String" /> <description> diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 57295cb1e3..b9cef0ead6 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -94,6 +94,13 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> + <method name="get" qualifiers="const"> + <return type="Color" /> + <param index="0" name="index" type="int" /> + <description> + Returns the [Color] at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="Color" /> diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 2db1386fd0..d421993b8f 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -93,6 +93,13 @@ [b]Note:[/b] [constant @GDScript.NAN] doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included. </description> </method> + <method name="get" qualifiers="const"> + <return type="float" /> + <param index="0" name="index" type="int" /> + <description> + Returns the 32-bit float at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="float" /> diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 0bcee918ed..4622d63258 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -94,6 +94,13 @@ [b]Note:[/b] [constant @GDScript.NAN] doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included. </description> </method> + <method name="get" qualifiers="const"> + <return type="float" /> + <param index="0" name="index" type="int" /> + <description> + Returns the 64-bit float at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="float" /> diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index 93b2ae7394..3a3596b2d0 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -90,6 +90,13 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> + <method name="get" qualifiers="const"> + <return type="int" /> + <param index="0" name="index" type="int" /> + <description> + Returns the 32-bit integer at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="int" /> diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index 3d34165915..cfaf012a55 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -91,6 +91,13 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> + <method name="get" qualifiers="const"> + <return type="int" /> + <param index="0" name="index" type="int" /> + <description> + Returns the 64-bit integer at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="int" /> diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 621831c7a3..511850d645 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -97,6 +97,13 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> + <method name="get" qualifiers="const"> + <return type="String" /> + <param index="0" name="index" type="int" /> + <description> + Returns the [String] at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="String" /> diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 14a3816353..da41812e0b 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -98,6 +98,13 @@ [b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. </description> </method> + <method name="get" qualifiers="const"> + <return type="Vector2" /> + <param index="0" name="index" type="int" /> + <description> + Returns the [Vector2] at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="Vector2" /> diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 49220c6fd6..d47f2f3cd1 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -97,6 +97,13 @@ [b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. </description> </method> + <method name="get" qualifiers="const"> + <return type="Vector3" /> + <param index="0" name="index" type="int" /> + <description> + Returns the [Vector3] at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="Vector3" /> diff --git a/doc/classes/PackedVector4Array.xml b/doc/classes/PackedVector4Array.xml index fd0cfeb74b..6dbfc7413d 100644 --- a/doc/classes/PackedVector4Array.xml +++ b/doc/classes/PackedVector4Array.xml @@ -96,6 +96,13 @@ [b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. </description> </method> + <method name="get" qualifiers="const"> + <return type="Vector4" /> + <param index="0" name="index" type="int" /> + <description> + Returns the [Vector4] at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]). + </description> + </method> <method name="has" qualifiers="const"> <return type="bool" /> <param index="0" name="value" type="Vector4" /> diff --git a/doc/classes/ParticleProcessMaterial.xml b/doc/classes/ParticleProcessMaterial.xml index 28c60194c8..742e0cc44c 100644 --- a/doc/classes/ParticleProcessMaterial.xml +++ b/doc/classes/ParticleProcessMaterial.xml @@ -90,6 +90,7 @@ <members> <member name="alpha_curve" type="Texture2D" setter="set_alpha_curve" getter="get_alpha_curve"> The alpha value of each particle's color will be multiplied by this [CurveTexture] over its lifetime. + [b]Note:[/b] [member alpha_curve] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member alpha_curve] will have no visible effect. </member> <member name="angle_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture"> Each particle's rotation will be animated along this [CurveTexture]. @@ -193,7 +194,7 @@ </member> <member name="emission_curve" type="Texture2D" setter="set_emission_curve" getter="get_emission_curve"> Each particle's color will be multiplied by this [CurveTexture] over its lifetime. - [b]Note:[/b] This property won't have a visible effect unless the render material is marked as unshaded. + [b]Note:[/b] [member emission_curve] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member emission_curve] will have no visible effect. </member> <member name="emission_normal_texture" type="Texture2D" setter="set_emission_normal_texture" getter="get_emission_normal_texture"> Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 004bbe2286..d73cda7460 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -776,7 +776,7 @@ [StyleBox] for the right side of labeled separator. See [method add_separator]. </theme_item> <theme_item name="panel" data_type="style" type="StyleBox"> - [StyleBox] for the the background panel. + [StyleBox] for the background panel. </theme_item> <theme_item name="separator" data_type="style" type="StyleBox"> [StyleBox] used for the separators. See [method add_separator]. diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml index 399e285402..b581f32686 100644 --- a/doc/classes/PopupPanel.xml +++ b/doc/classes/PopupPanel.xml @@ -10,7 +10,7 @@ </tutorials> <theme_items> <theme_item name="panel" data_type="style" type="StyleBox"> - [StyleBox] for the the background panel. + [StyleBox] for the background panel. </theme_item> </theme_items> </class> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 497070fa81..4266bab2a1 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -314,11 +314,11 @@ </member> <member name="application/run/disable_stderr" type="bool" setter="" getter="" default="false"> If [code]true[/code], disables printing to standard error. If [code]true[/code], this also hides error and warning messages printed by [method @GlobalScope.push_error] and [method @GlobalScope.push_warning]. See also [member application/run/disable_stdout]. - Changes to this setting will only be applied upon restarting the application. + Changes to this setting will only be applied upon restarting the application. To control this at runtime, use [member Engine.print_error_messages]. </member> <member name="application/run/disable_stdout" type="bool" setter="" getter="" default="false"> If [code]true[/code], disables printing to standard output. This is equivalent to starting the editor or project with the [code]--quiet[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. See also [member application/run/disable_stderr]. - Changes to this setting will only be applied upon restarting the application. + Changes to this setting will only be applied upon restarting the application. To control this at runtime, use [member Engine.print_to_stdout]. </member> <member name="application/run/enable_alt_space_menu" type="bool" setter="" getter="" default="false"> If [code]true[/code], allows the [kbd]Alt + Space[/kbd] keys to display the window menu. This menu allows the user to perform various window management operations such as moving, resizing, or minimizing the window. @@ -1369,7 +1369,7 @@ macOS specific override for the shortcut to select the word currently under the caret. </member> <member name="input/ui_text_skip_selection_for_next_occurrence" type="Dictionary" setter="" getter=""> - If no selection is currently active with the last caret in text fields, searches for the next occurrence of the the word currently under the caret and moves the caret to the next occurrence. The action can be performed sequentially for other occurrences of the word under the last caret. + If no selection is currently active with the last caret in text fields, searches for the next occurrence of the word currently under the caret and moves the caret to the next occurrence. The action can be performed sequentially for other occurrences of the word under the last caret. If a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret, selects the next occurrence then deselects the previous selection and its associated caret. The action can be performed sequentially for other occurrences of the selection of the last caret. The viewport is adjusted to the latest newly added caret. [b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified. @@ -1386,6 +1386,10 @@ Default [InputEventAction] to undo the most recent action. [b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified. </member> + <member name="input/ui_unicode_start" type="Dictionary" setter="" getter=""> + Default [InputEventAction] to start Unicode character hexadecimal code input in a text field. + [b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified. + </member> <member name="input/ui_up" type="Dictionary" setter="" getter=""> Default [InputEventAction] to move up in the UI. [b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified. @@ -2211,6 +2215,7 @@ <member name="physics/2d/physics_engine" type="String" setter="" getter="" default=""DEFAULT""> Sets which physics engine to use for 2D physics. "DEFAULT" and "GodotPhysics2D" are the same, as there is currently no alternative 2D physics server implemented. + "Dummy" is a 2D physics server that does nothing and returns only dummy values, effectively disabling all 2D physics functionality. </member> <member name="physics/2d/run_on_separate_thread" type="bool" setter="" getter="" default="false"> If [code]true[/code], the 2D physics server runs on a separate thread, making better use of multi-core CPUs. If [code]false[/code], the 2D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. @@ -2289,6 +2294,7 @@ <member name="physics/3d/physics_engine" type="String" setter="" getter="" default=""DEFAULT""> Sets which physics engine to use for 3D physics. "DEFAULT" and "GodotPhysics3D" are the same, as there is currently no alternative 3D physics server implemented. + "Dummy" is a 3D physics server that does nothing and returns only dummy values, effectively disabling all 3D physics functionality. </member> <member name="physics/3d/run_on_separate_thread" type="bool" setter="" getter="" default="false"> If [code]true[/code], the 3D physics server runs on a separate thread, making better use of multi-core CPUs. If [code]false[/code], the 3D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. @@ -2341,6 +2347,9 @@ [b]Note:[/b] This property is only read when the project starts. To change the physics FPS at runtime, set [member Engine.physics_ticks_per_second] instead. [b]Note:[/b] Only [member physics/common/max_physics_steps_per_frame] physics ticks may be simulated per rendered frame at most. If more physics ticks have to be simulated per rendered frame to keep up with rendering, the project will appear to slow down (even if [code]delta[/code] is used consistently in physics calculations). Therefore, it is recommended to also increase [member physics/common/max_physics_steps_per_frame] if increasing [member physics/common/physics_ticks_per_second] significantly above its default value. </member> + <member name="rendering/2d/batching/item_buffer_size" type="int" setter="" getter="" default="16384"> + Maximum number of canvas item commands that can be batched into a single draw call. + </member> <member name="rendering/2d/sdf/oversize" type="int" setter="" getter="" default="1"> Controls how much of the original viewport size should be covered by the 2D signed distance field. This SDF can be sampled in [CanvasItem] shaders and is used for [GPUParticles2D] collision. Higher values allow portions of occluders located outside the viewport to still be taken into account in the generated signed distance field, at the cost of performance. If you notice particles falling through [LightOccluder2D]s as the occluders leave the viewport, increase this setting. The percentage specified is added on each axis and on both sides. For example, with the default setting of 120%, the signed distance field will cover 20% of the viewport's size outside the viewport on each side (top, right, bottom, left). @@ -2788,6 +2797,10 @@ If [code]true[/code], the forward renderer will fall back to Direct3D 12 if Vulkan is not supported. [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 both Direct3D 12, Metal and Vulkan are not supported. + [b]Note:[/b] This setting is implemented only 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 is not supported. [b]Note:[/b] This setting is implemented only on Windows. @@ -2850,11 +2863,6 @@ </member> <member name="rendering/shading/overrides/force_vertex_shading" type="bool" setter="" getter="" default="false"> If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. - [b]Note:[/b] This setting currently has no effect, as vertex shading is not implemented yet. - </member> - <member name="rendering/shading/overrides/force_vertex_shading.mobile" type="bool" setter="" getter="" default="true"> - Lower-end override for [member rendering/shading/overrides/force_vertex_shading] on mobile devices, due to performance concerns or driver support. - [b]Note:[/b] This setting currently has no effect, as vertex shading is not implemented yet. </member> <member name="rendering/textures/canvas_textures/default_texture_filter" type="int" setter="" getter="" default="1"> The default texture filtering mode to use on [CanvasItem]s. @@ -2887,10 +2895,13 @@ <member name="rendering/textures/lossless_compression/force_png" type="bool" setter="" getter="" default="false"> 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. + </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, which makes large textures import significantly faster. + If [code]true[/code], the texture importer will utilize the GPU for compressing textures, improving the import time of large images. [b]Note:[/b] This setting requires either Vulkan or D3D12 available as a rendering backend. - [b]Note:[/b] Currently this only affects BC6H compression, which is used on Desktop and Console for HDR images. + [b]Note:[/b] Currently this only affects BC1 and BC6H compression, which are used on Desktop and Console for fully opaque and HDR images respectively. </member> <member name="rendering/textures/vram_compression/import_etc2_astc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm for lower quality textures and normal maps and Adaptable Scalable Texture Compression algorithm for high quality textures (in 4×4 block size). diff --git a/doc/classes/RDPipelineDepthStencilState.xml b/doc/classes/RDPipelineDepthStencilState.xml index b8245f97af..dc1e70eb55 100644 --- a/doc/classes/RDPipelineDepthStencilState.xml +++ b/doc/classes/RDPipelineDepthStencilState.xml @@ -19,7 +19,7 @@ The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test. </member> <member name="back_op_fail" type="int" setter="set_back_op_fail" getter="get_back_op_fail" enum="RenderingDevice.StencilOperation" default="1"> - The operation to perform on the stencil buffer for back pixels that fail the stencil test + The operation to perform on the stencil buffer for back pixels that fail the stencil test. </member> <member name="back_op_pass" type="int" setter="set_back_op_pass" getter="get_back_op_pass" enum="RenderingDevice.StencilOperation" default="1"> The operation to perform on the stencil buffer for back pixels that pass the stencil test. diff --git a/doc/classes/RDShaderSource.xml b/doc/classes/RDShaderSource.xml index 062c22f11f..a7b897d56e 100644 --- a/doc/classes/RDShaderSource.xml +++ b/doc/classes/RDShaderSource.xml @@ -23,6 +23,7 @@ <param index="1" name="source" type="String" /> <description> Sets [param source] code for the specified shader [param stage]. Equivalent to setting one of [member source_compute], [member source_fragment], [member source_tesselation_control], [member source_tesselation_evaluation] or [member source_vertex]. + [b]Note:[/b] If you set the compute shader source code using this method directly, remember to remove the Godot-specific hint [code]#[compute][/code]. </description> </method> </methods> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index ddd52c6835..2ff7e934e9 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -905,7 +905,7 @@ <param index="4" name="mipmaps" type="int" default="1" /> <param index="5" name="slice_type" type="int" enum="RenderingDevice.TextureSliceType" default="0" /> <description> - Creates a shared texture using the specified [param view] and the texture information from [param with_texture]'s [param layer] and [param mipmap]. The number of included mipmaps from the original texture can be controlled using the [param mipmaps] parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use [method texture_create_shared] + Creates a shared texture using the specified [param view] and the texture information from [param with_texture]'s [param layer] and [param mipmap]. The number of included mipmaps from the original texture can be controlled using the [param mipmaps] parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use [method texture_create_shared]. For 2D textures (which only have one layer), [param layer] must be [code]0[/code]. [b]Note:[/b] Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps. </description> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index cea9a4cec4..91af70b565 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -913,7 +913,7 @@ <param index="1" name="transform" type="Transform2D" /> <description> Transforms both the current and previous stored transform for a canvas light. - This allows transforming a light without creating a "glitch" in the interpolation, which is is particularly useful for large worlds utilizing a shifting origin. + This allows transforming a light without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin. </description> </method> <method name="canvas_occluder_polygon_create"> @@ -2639,6 +2639,9 @@ - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data) - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data) [/codeblock] + Instance transforms are in row-major order. Specifically: + - For [Transform2D] the float-order is: [code](x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y)[/code]. + - For [Transform3D] the float-order is: [code](basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z)[/code]. </description> </method> <method name="multimesh_set_buffer_interpolated"> @@ -3532,7 +3535,7 @@ <method name="texture_2d_placeholder_create"> <return type="RID" /> <description> - Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]texture_2d_layered_*[/code] RenderingServer functions, although it does nothing when used. See also [method texture_2d_layered_placeholder_create] + Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]texture_2d_layered_*[/code] RenderingServer functions, although it does nothing when used. See also [method texture_2d_layered_placeholder_create]. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] method. [b]Note:[/b] The equivalent resource is [PlaceholderTexture2D]. </description> @@ -3583,6 +3586,21 @@ [b]Note:[/b] The [param texture] must have the same width, height, depth and format as the current texture data. Otherwise, an error will be printed and the original texture won't be modified. If you need to use different width, height, depth or format, use [method texture_replace] instead. </description> </method> + <method name="texture_create_from_native_handle"> + <return type="RID" /> + <param index="0" name="type" type="int" enum="RenderingServer.TextureType" /> + <param index="1" name="format" type="int" enum="Image.Format" /> + <param index="2" name="native_handle" type="int" /> + <param index="3" name="width" type="int" /> + <param index="4" name="height" type="int" /> + <param index="5" name="depth" type="int" /> + <param index="6" name="layers" type="int" default="1" /> + <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 the rendering device renderer, using [method RenderingDevice.texture_create_from_extension] rather than this method is recommended. It will give you much more control over the texture's format and usage. + </description> + </method> <method name="texture_get_format" qualifiers="const"> <return type="int" enum="Image.Format" /> <param index="0" name="texture" type="RID" /> @@ -3721,7 +3739,7 @@ <return type="float" /> <param index="0" name="viewport" type="RID" /> <description> - Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_gpu]. + Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_cpu]. [b]Note:[/b] Requires measurements to be enabled on the specified [param viewport] using [method viewport_set_measure_render_time]. Otherwise, this method returns [code]0.0[/code]. [b]Note:[/b] When GPU utilization is low enough during a certain period of time, GPUs will decrease their power state (which in turn decreases core and memory clock speeds). This can cause the reported GPU time to increase if GPU utilization is kept low enough by a framerate cap (compared to what it would be at the GPU's highest power state). Keep this in mind when benchmarking using [method viewport_get_measured_render_time_gpu]. This behavior can be overridden in the graphics driver settings at the cost of higher power usage. </description> @@ -4311,6 +4329,15 @@ <constant name="MAX_MESH_SURFACES" value="256"> The maximum number of surfaces a mesh can have. </constant> + <constant name="TEXTURE_TYPE_2D" value="0" enum="TextureType"> + 2D texture. + </constant> + <constant name="TEXTURE_TYPE_LAYERED" value="1" enum="TextureType"> + Layered texture. + </constant> + <constant name="TEXTURE_TYPE_3D" value="2" enum="TextureType"> + 3D texture. + </constant> <constant name="TEXTURE_LAYERED_2D_ARRAY" value="0" enum="TextureLayeredType"> Array of 2-dimensional textures (see [Texture2DArray]). </constant> @@ -5124,7 +5151,7 @@ The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers. </constant> <constant name="COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT" value="4" enum="CompositorEffectCallbackType"> - The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target. + The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target. </constant> <constant name="COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY" value="-1" enum="CompositorEffectCallbackType"> </constant> @@ -5195,7 +5222,7 @@ Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors. </constant> <constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper"> - Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. This avoids clipping bright highlights, but the resulting image can look a bit dull. + Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: [code]color = color * (1 + color / (white * white)) / (1 + color)[/code]. This avoids clipping bright highlights, but the resulting image can look a bit dull. When [member Environment.tonemap_white] is left at the default value of [code]1.0[/code] this is identical to [constant ENV_TONE_MAPPER_LINEAR] while also being slightly less performant. </constant> <constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper"> Use the filmic tonemapper. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than [constant ENV_TONE_MAPPER_REINHARD]. @@ -5636,7 +5663,10 @@ <constant name="GLOBAL_VAR_TYPE_SAMPLERCUBE" value="27" enum="GlobalShaderParameterType"> Cubemap sampler global shader parameter ([code]global uniform samplerCube ...[/code]). Exposed as a [Cubemap] in the editor UI. </constant> - <constant name="GLOBAL_VAR_TYPE_MAX" value="28" enum="GlobalShaderParameterType"> + <constant name="GLOBAL_VAR_TYPE_SAMPLEREXT" value="28" enum="GlobalShaderParameterType"> + External sampler global shader parameter ([code]global uniform samplerExternalOES ...[/code]). Exposed as a [ExternalTexture] in the editor UI. + </constant> + <constant name="GLOBAL_VAR_TYPE_MAX" value="29" enum="GlobalShaderParameterType"> Represents the size of the [enum GlobalShaderParameterType] enum. </constant> <constant name="RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME" value="0" enum="RenderingInfo"> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index fe09472c14..18d4047339 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -20,6 +20,19 @@ Override this method to return a custom [RID] when [method get_rid] is called. </description> </method> + <method name="_reset_state" qualifiers="virtual"> + <return type="void" /> + <description> + For resources that use a variable number of properties, either via [method Object._validate_property] or [method Object._get_property_list], this method should be implemented to correctly clear the resource's state. + </description> + </method> + <method name="_set_path_cache" qualifiers="virtual const"> + <return type="void" /> + <param index="0" name="path" type="String" /> + <description> + Sets the resource's path to [param path] without involving the resource cache. + </description> + </method> <method name="_setup_local_to_scene" qualifiers="virtual"> <return type="void" /> <description> @@ -68,6 +81,14 @@ Generates a unique identifier for a resource to be contained inside a [PackedScene], based on the current date, time, and a random value. The returned string is only composed of letters ([code]a[/code] to [code]y[/code]) and numbers ([code]0[/code] to [code]8[/code]). See also [member resource_scene_unique_id]. </description> </method> + <method name="get_id_for_path" qualifiers="const"> + <return type="String" /> + <param index="0" name="path" type="String" /> + <description> + Returns the unique identifier for the resource with the given [param path] from the resource cache. If the resource is not loaded and cached, an empty string is returned. + [b]Note:[/b] This method is only implemented when running in an editor context. At runtime, it returns an empty string. + </description> + </method> <method name="get_local_scene" qualifiers="const"> <return type="Node" /> <description> @@ -80,6 +101,34 @@ Returns the [RID] of this resource (or an empty RID). Many resources (such as [Texture2D], [Mesh], and so on) are high-level abstractions of resources stored in a specialized server ([DisplayServer], [RenderingServer], etc.), so this function will return the original [RID]. </description> </method> + <method name="is_built_in" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the resource is built-in (from the engine) or [code]false[/code] if it is user-defined. + </description> + </method> + <method name="reset_state"> + <return type="void" /> + <description> + For resources that use a variable number of properties, either via [method Object._validate_property] or [method Object._get_property_list], override [method _reset_state] to correctly clear the resource's state. + </description> + </method> + <method name="set_id_for_path"> + <return type="void" /> + <param index="0" name="path" type="String" /> + <param index="1" name="id" type="String" /> + <description> + Sets the unique identifier to [param id] for the resource with the given [param path] in the resource cache. If the unique identifier is empty, the cache entry using [param path] is removed if it exists. + [b]Note:[/b] This method is only implemented when running in an editor context. + </description> + </method> + <method name="set_path_cache"> + <return type="void" /> + <param index="0" name="path" type="String" /> + <description> + Sets the resource's path to [param path] without involving the resource cache. + </description> + </method> <method name="setup_local_to_scene" deprecated="This method should only be called internally."> <return type="void" /> <description> diff --git a/doc/classes/ResourceImporterDynamicFont.xml b/doc/classes/ResourceImporterDynamicFont.xml index b678a04e34..3727bed8e5 100644 --- a/doc/classes/ResourceImporterDynamicFont.xml +++ b/doc/classes/ResourceImporterDynamicFont.xml @@ -54,7 +54,7 @@ Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. Only effective if [member multichannel_signed_distance_field] is [code]true[/code]. </member> <member name="multichannel_signed_distance_field" type="bool" setter="" getter="" default="false"> - If set to [code]true[/code], the default font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for [Control]s that are scaled down (or for [Label3D]s viewed from a long distance). + If set to [code]true[/code], the font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for [Control]s that are scaled down (or for [Label3D]s viewed from a long distance). MSDF font rendering can be combined with [member generate_mipmaps] to further improve font rendering quality when scaled down. </member> <member name="opentype_features" type="Dictionary" setter="" getter="" default="{}"> diff --git a/doc/classes/ResourceImporterScene.xml b/doc/classes/ResourceImporterScene.xml index 900e028b25..1565a244fe 100644 --- a/doc/classes/ResourceImporterScene.xml +++ b/doc/classes/ResourceImporterScene.xml @@ -68,6 +68,9 @@ <member name="nodes/root_type" type="String" setter="" getter="" default=""""> Override for the root node type. If empty, the root node will use what the scene specifies, or [Node3D] if the scene does not specify a root type. Using a node type that inherits from [Node3D] is recommended. Otherwise, you'll lose the ability to position the node directly in the 3D editor. </member> + <member name="nodes/use_node_type_suffixes" type="bool" setter="" getter="" default="true"> + If [code]true[/code], use suffixes in the node names to determine the node type, such as [code]-col[/code] for collision shapes. Disabling this makes editor-imported files more similar to the original files, and more similar to importing files at runtime. See [url=$DOCS_URL/tutorials/assets_pipeline/importing_3d_scenes/node_type_customization.html]Node type customization using name suffixes[/url] for more information. + </member> <member name="skins/use_named_skins" type="bool" setter="" getter="" default="true"> If checked, use named [Skin]s for animation. The [MeshInstance3D] node contains 3 properties of relevance here: a skeleton [NodePath] pointing to the [Skeleton3D] node (usually [code]..[/code]), a mesh, and a skin: - The [Skeleton3D] node contains a list of bones with names, their pose and rest, a name and a parent bone. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 42c9bd7a3c..05c749bc24 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -26,6 +26,14 @@ Returns the list of extensions available for saving a resource of a given type. </description> </method> + <method name="get_resource_id_for_path"> + <return type="int" /> + <param index="0" name="path" type="String" /> + <param index="1" name="generate" type="bool" default="false" /> + <description> + Returns the resource ID for the given path. If [param generate] is [code]true[/code], a new resource ID will be generated if one for the path is not found. If [param generate] is [code]false[/code] and the path is not found, [constant ResourceUID.INVALID_ID] is returned. + </description> + </method> <method name="remove_resource_format_saver"> <return type="void" /> <param index="0" name="format_saver" type="ResourceFormatSaver" /> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 45f0bbb8aa..80aad9d30d 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -58,6 +58,12 @@ Returns the default value of the specified property. </description> </method> + <method name="get_rpc_config" qualifiers="const"> + <return type="Variant" /> + <description> + Returns a [Dictionary] mapping method names to their RPC configuration defined by this script. + </description> + </method> <method name="get_script_constant_map"> <return type="Dictionary" /> <description> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 5cf077c266..67a2af2932 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -99,6 +99,14 @@ [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened. </description> </method> + <method name="update_docs_from_script"> + <return type="void" /> + <param index="0" name="script" type="Script" /> + <description> + Updates the documentation for the given [param script] if the script's documentation is currently open. + [b]Note:[/b] This should be called whenever the script is changed to keep the open documentation state up to date. + </description> + </method> </methods> <signals> <signal name="editor_script_changed"> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 2181194fd4..405bba3564 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -102,6 +102,9 @@ <constant name="SCROLL_MODE_SHOW_NEVER" value="3" enum="ScrollMode"> Scrolling enabled, scrollbar will be hidden. </constant> + <constant name="SCROLL_MODE_RESERVE" value="4" enum="ScrollMode"> + Combines [constant SCROLL_MODE_AUTO] and [constant SCROLL_MODE_SHOW_ALWAYS]. The scrollbar is only visible if necessary, but the content size is adjusted as if it was always visible. It's useful for ensuring that content size stays the same regardless if the scrollbar is visible. + </constant> </constants> <theme_items> <theme_item name="panel" data_type="style" type="StyleBox"> diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 4343a789fd..b1e931aef8 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -26,7 +26,7 @@ <return type="bool" /> <param index="0" name="event" type="InputEvent" /> <description> - Returns whether any [InputEvent] in [member events] equals [param event]. + Returns whether any [InputEvent] in [member events] equals [param event]. This uses [method InputEvent.is_match] to compare events. </description> </method> </methods> diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 7d6ff1e9b0..c970ccb094 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -48,7 +48,7 @@ <param index="0" name="object" type="Object" /> <param index="1" name="signal" type="StringName" /> <description> - Creates a new [Signal] named [param signal] in the specified [param object]. + Creates a [Signal] object referencing a signal named [param signal] in the specified [param object]. </description> </constructor> </constructors> @@ -109,6 +109,12 @@ Returns the ID of the object emitting this signal (see [method Object.get_instance_id]). </description> </method> + <method name="has_connections" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if any [Callable] is connected to this signal. + </description> + </method> <method name="is_connected" qualifiers="const"> <return type="bool" /> <param index="0" name="callable" type="Callable" /> diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index cc3f61e1b2..f5b808be8e 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -99,6 +99,21 @@ Returns the global rest transform for [param bone_idx]. </description> </method> + <method name="get_bone_meta" qualifiers="const"> + <return type="Variant" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="key" type="StringName" /> + <description> + Returns bone metadata for [param bone_idx] with [param key]. + </description> + </method> + <method name="get_bone_meta_list" qualifiers="const"> + <return type="StringName[]" /> + <param index="0" name="bone_idx" type="int" /> + <description> + Returns a list of all metadata keys for [param bone_idx]. + </description> + </method> <method name="get_bone_name" qualifiers="const"> <return type="String" /> <param index="0" name="bone_idx" type="int" /> @@ -171,6 +186,14 @@ Use for invalidating caches in IK solvers and other nodes which process bones. </description> </method> + <method name="has_bone_meta" qualifiers="const"> + <return type="bool" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="key" type="StringName" /> + <description> + Returns whether there exists any bone metadata for [param bone_idx] with key [param key]. + </description> + </method> <method name="is_bone_enabled" qualifiers="const"> <return type="bool" /> <param index="0" name="bone_idx" type="int" /> @@ -263,6 +286,15 @@ [b]Note:[/b] The pose transform needs to be a global pose! To convert a world transform from a [Node3D] to a global bone pose, multiply the [method Transform3D.affine_inverse] of the node's [member Node3D.global_transform] by the desired world transform. </description> </method> + <method name="set_bone_meta"> + <return type="void" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="key" type="StringName" /> + <param index="2" name="value" type="Variant" /> + <description> + Sets bone metadata for [param bone_idx], will set the [param key] meta to [param value]. + </description> + </method> <method name="set_bone_name"> <return type="void" /> <param index="0" name="bone_idx" type="int" /> diff --git a/doc/classes/SoftBody3D.xml b/doc/classes/SoftBody3D.xml index 195196b78c..4d8791d8c1 100644 --- a/doc/classes/SoftBody3D.xml +++ b/doc/classes/SoftBody3D.xml @@ -87,6 +87,7 @@ <param index="0" name="point_index" type="int" /> <param index="1" name="pinned" type="bool" /> <param index="2" name="attachment_path" type="NodePath" default="NodePath("")" /> + <param index="3" name="insert_at" type="int" default="-1" /> <description> Sets the pinned state of a surface vertex. When set to [code]true[/code], the optional [param attachment_path] can define a [Node3D] the pinned vertex will be attached to. </description> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 454a542cc8..650c396190 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -16,13 +16,39 @@ Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values. </description> </method> + <method name="get_drag_area_control"> + <return type="Control" /> + <description> + Returns the drag area [Control]. For example, you can move a pre-configured button into the drag area [Control] so that it rides along with the split bar. Try setting the [Button] anchors to [code]center[/code] prior to the [code]reparent()[/code] call. + [codeblock] + $BarnacleButton.reparent($SplitContainer.get_drag_area_control()) + [/codeblock] + [b]Note:[/b] The drag area [Control] is drawn over the [SplitContainer]'s children, so [CanvasItem] draw objects called from the [Control] and children added to the [Control] will also appear over the [SplitContainer]'s children. Try setting [member Control.mouse_filter] of custom children to [constant Control.MOUSE_FILTER_IGNORE] to prevent blocking the mouse from dragging if desired. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. + </description> + </method> </methods> <members> <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false"> If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled. </member> + <member name="drag_area_highlight_in_editor" type="bool" setter="set_drag_area_highlight_in_editor" getter="is_drag_area_highlight_in_editor_enabled" default="false"> + Highlights the drag area [Rect2] so you can see where it is during development. The drag area is gold if [member dragging_enabled] is [code]true[/code], and red if [code]false[/code]. + </member> + <member name="drag_area_margin_begin" type="int" setter="set_drag_area_margin_begin" getter="get_drag_area_margin_begin" default="0"> + Reduces the size of the drag area and split bar [theme_item split_bar_background] at the beginning of the container. + </member> + <member name="drag_area_margin_end" type="int" setter="set_drag_area_margin_end" getter="get_drag_area_margin_end" default="0"> + Reduces the size of the drag area and split bar [theme_item split_bar_background] at the end of the container. + </member> + <member name="drag_area_offset" type="int" setter="set_drag_area_offset" getter="get_drag_area_offset" default="0"> + Shifts the drag area in the axis of the container to prevent the drag area from overlapping the [ScrollBar] or other selectable [Control] of a child node. + </member> <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0"> - Determines the dragger's visibility. See [enum DraggerVisibility] for details. + Determines the dragger's visibility. See [enum DraggerVisibility] for details. This property does not determine whether dragging is enabled or not. Use [member dragging_enabled] for that. + </member> + <member name="dragging_enabled" type="bool" setter="set_dragging_enabled" getter="is_dragging_enabled" default="true"> + Enables or disables split dragging. </member> <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0"> The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control]. @@ -33,6 +59,16 @@ </member> </members> <signals> + <signal name="drag_ended"> + <description> + Emitted when the user ends dragging. + </description> + </signal> + <signal name="drag_started"> + <description> + Emitted when the user starts dragging. + </description> + </signal> <signal name="dragged"> <param index="0" name="offset" type="int" /> <description> @@ -42,24 +78,28 @@ </signals> <constants> <constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility"> - The split dragger is visible when the cursor hovers it. + The split dragger icon is always visible when [theme_item autohide] is [code]false[/code], otherwise visible only when the cursor hovers it. + The size of the grabber icon determines the minimum [theme_item separation]. + The dragger icon is automatically hidden if the length of the grabber icon is longer than the split bar. </constant> <constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility"> - The split dragger is never visible. + The split dragger icon is never visible regardless of the value of [theme_item autohide]. + The size of the grabber icon determines the minimum [theme_item separation]. </constant> <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility"> - The split dragger is never visible and its space collapsed. + The split dragger icon is not visible, and the split bar is collapsed to zero thickness. </constant> </constants> <theme_items> <theme_item name="autohide" data_type="constant" type="int" default="1"> - Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible. + Boolean value. If [code]1[/code] ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If [code]0[/code] ([code]false[/code]), it's always visible. The [member dragger_visibility] must be [constant DRAGGER_VISIBLE]. </theme_item> <theme_item name="minimum_grab_thickness" data_type="constant" type="int" default="6"> - The minimum thickness of the area users can click on to grab the splitting line. If [theme_item separation] or [theme_item h_grabber] / [theme_item v_grabber]'s thickness are too small, this ensure that the splitting line can still be dragged. + The minimum thickness of the area users can click on to grab the split bar. This ensures that the split bar can still be dragged if [theme_item separation] or [theme_item h_grabber] / [theme_item v_grabber]'s size is too narrow to easily select. </theme_item> <theme_item name="separation" data_type="constant" type="int" default="12"> - The space between sides of the container. + The split bar thickness, i.e., the gap between the two children of the container. This is overridden by the size of the grabber icon if [member dragger_visibility] is set to [constant DRAGGER_VISIBLE], or [constant DRAGGER_HIDDEN], and [theme_item separation] is smaller than the size of the grabber icon in the same axis. + [b]Note:[/b] To obtain [theme_item separation] values less than the size of the grabber icon, for example a [code]1 px[/code] hairline, set [theme_item h_grabber] or [theme_item v_grabber] to a new [ImageTexture], which effectively sets the grabber icon size to [code]0 px[/code]. </theme_item> <theme_item name="grabber" data_type="icon" type="Texture2D"> The icon used for the grabber drawn in the middle area. @@ -70,5 +110,8 @@ <theme_item name="v_grabber" data_type="icon" type="Texture2D"> The icon used for the grabber drawn in the middle area when [member vertical] is [code]true[/code]. </theme_item> + <theme_item name="split_bar_background" data_type="style" type="StyleBox"> + Determines the background of the split bar if its thickness is greater than zero. + </theme_item> </theme_items> </class> diff --git a/doc/classes/Sprite2D.xml b/doc/classes/Sprite2D.xml index d73cb02d94..239c4dcf09 100644 --- a/doc/classes/Sprite2D.xml +++ b/doc/classes/Sprite2D.xml @@ -76,7 +76,7 @@ If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect]. </member> <member name="region_filter_clip_enabled" type="bool" setter="set_region_filter_clip_enabled" getter="is_region_filter_clip_enabled" default="false"> - If [code]true[/code], the outermost pixels get blurred out. [member region_enabled] must be [code]true[/code]. + If [code]true[/code], the area outside of the [member region_rect] is clipped to avoid bleeding of the surrounding texture pixels. [member region_enabled] must be [code]true[/code]. </member> <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2(0, 0, 0, 0)"> The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index d99eaa64a6..40f08dafe6 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -6,7 +6,7 @@ <description> This is the built-in string Variant type (and the one used by GDScript). Strings may contain any number of Unicode characters, and expose methods useful for manipulating and generating strings. Strings are reference-counted and use a copy-on-write approach (every modification to a string returns a new [String]), so passing them around is cheap in resources. Some string methods have corresponding variations. Variations suffixed with [code]n[/code] ([method countn], [method findn], [method replacen], etc.) are [b]case-insensitive[/b] (they make no distinction between uppercase and lowercase letters). Method variations prefixed with [code]r[/code] ([method rfind], [method rsplit], etc.) are reversed, and start from the end of the string, instead of the beginning. - [b]Note:[/b] In a boolean context, a string will evaluate to [code]false[/code] if it is empty ([code]""[/code]). Otherwise, a string will always evaluate to [code]true[/code]. The [code]not[/code] operator cannot be used. Instead, [method is_empty] should be used to check for empty strings. + [b]Note:[/b] In a boolean context, a string will evaluate to [code]false[/code] if it is empty ([code]""[/code]). Otherwise, a string will always evaluate to [code]true[/code]. </description> <tutorials> <link title="GDScript format strings">$DOCS_URL/tutorials/scripting/gdscript/gdscript_format_string.html</link> diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 1a891de05f..3a2b492496 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -9,7 +9,7 @@ See also [NodePath], which is a similar concept specifically designed to store pre-parsed scene tree paths. All of [String]'s methods are available in this class too. They convert the [StringName] into a string, and they also return a string. This is highly inefficient and should only be used if the string is desired. [b]Note:[/b] In C#, an explicit conversion to [code]System.String[/code] is required to use the methods listed on this page. Use the [code]ToString()[/code] method to cast a [StringName] to a string, and then use the equivalent methods in [code]System.String[/code] or [code]StringExtensions[/code]. - [b]Note:[/b] In a boolean context, a [StringName] will evaluate to [code]false[/code] if it is empty ([code]StringName("")[/code]). Otherwise, a [StringName] will always evaluate to [code]true[/code]. The [code]not[/code] operator cannot be used. Instead, [method is_empty] should be used to check for empty [StringName]s. + [b]Note:[/b] In a boolean context, a [StringName] will evaluate to [code]false[/code] if it is empty ([code]StringName("")[/code]). Otherwise, a [StringName] will always evaluate to [code]true[/code]. </description> <tutorials> </tutorials> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index a8bd068b1c..9c1525d8f8 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -241,7 +241,7 @@ <param index="0" name="count" type="int" enum="SurfaceTool.SkinWeightCount" /> <description> Set to [constant SKIN_8_WEIGHTS] to indicate that up to 8 bone influences per vertex may be used. - By default, only 4 bone influences are used ([constant SKIN_4_WEIGHTS]) + By default, only 4 bone influences are used ([constant SKIN_4_WEIGHTS]). [b]Note:[/b] This function takes an enum, not the exact number of weights. </description> </method> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 6505e48fb9..42558bf992 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1299,6 +1299,9 @@ <member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true" keywords="readonly, disabled, enabled"> If [code]false[/code], existing text cannot be modified and new text cannot be added. </member> + <member name="empty_selection_clipboard_enabled" type="bool" setter="set_empty_selection_clipboard_enabled" getter="is_empty_selection_clipboard_enabled" default="true"> + If [code]true[/code], copying or cutting without a selection is performed on all lines with a caret. Otherwise, copy and cut require a selection. + </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" /> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled" default="false"> If [code]true[/code], all occurrences of the selected text will be highlighted. @@ -1361,7 +1364,8 @@ Set additional options for BiDi override. </member> <member name="syntax_highlighter" type="SyntaxHighlighter" setter="set_syntax_highlighter" getter="get_syntax_highlighter"> - Sets the [SyntaxHighlighter] to use. + The syntax highlighter to use. + [b]Note:[/b] A [SyntaxHighlighter] instance should not be used across multiple [TextEdit] nodes. </member> <member name="text" type="String" setter="set_text" getter="get_text" default=""""> String value of the [TextEdit]. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 9d476691bf..aed041c5ad 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -1732,7 +1732,7 @@ Returns array of the composite character boundaries. [codeblock] var ts = TextServerManager.get_primary_interface() - print(ts.string_get_word_breaks("Test ❤️🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14] + print(ts.string_get_character_breaks("Test ❤️🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14] [/codeblock] </description> </method> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index eb3c170583..479456ae66 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -551,7 +551,7 @@ </member> <member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1"> The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used (see [member ThemeDB.fallback_font_size]). - Values below [code]0[/code] are invalid and can be used to unset the property. Use [method has_default_font_size] to check if this value is valid. + Values below [code]1[/code] are invalid and can be used to unset the property. Use [method has_default_font_size] to check if this value is valid. </member> </members> <constants> diff --git a/doc/classes/TranslationDomain.xml b/doc/classes/TranslationDomain.xml new file mode 100644 index 0000000000..da6f2704bf --- /dev/null +++ b/doc/classes/TranslationDomain.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TranslationDomain" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + A self-contained collection of [Translation] resources. + </brief_description> + <description> + [TranslationDomain] is a self-contained collection of [Translation] resources. Translations can be added to or removed from it. + If you're working with the main translation domain, it is more convenient to use the wrap methods on [TranslationServer]. + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_translation"> + <return type="void" /> + <param index="0" name="translation" type="Translation" /> + <description> + Adds a translation. + </description> + </method> + <method name="clear"> + <return type="void" /> + <description> + Removes all translations. + </description> + </method> + <method name="get_translation_object" qualifiers="const"> + <return type="Translation" /> + <param index="0" name="locale" type="String" /> + <description> + Returns the [Translation] instance that best matches [param locale]. Returns [code]null[/code] if there are no matches. + </description> + </method> + <method name="remove_translation"> + <return type="void" /> + <param index="0" name="translation" type="Translation" /> + <description> + Removes the given translation. + </description> + </method> + <method name="translate" qualifiers="const"> + <return type="StringName" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="context" type="StringName" default="&""" /> + <description> + Returns the current locale's translation for the given message and context. + </description> + </method> + <method name="translate_plural" qualifiers="const"> + <return type="StringName" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="message_plural" type="StringName" /> + <param index="2" name="n" type="int" /> + <param index="3" name="context" type="StringName" default="&""" /> + <description> + Returns the current locale's translation for the given message, plural message and context. + The number [param n] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. + </description> + </method> + </methods> +</class> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index db1a65278c..0a4965c36c 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -4,7 +4,8 @@ The server responsible for language translations. </brief_description> <description> - The server that manages all language translations. Translations can be added to or removed from it. + The translation server is the API backend that manages all language translations. + Translations are stored in [TranslationDomain]s, which can be accessed by name. The most commonly used translation domain is the main translation domain. It always exists and can be accessed using an empty [StringName]. The translation server provides wrapper methods for accessing the main translation domain directly, without having to fetch the translation domain first. Custom translation domains are mainly for advanced usages like editor plugins. Names starting with [code]godot.[/code] are reserved for engine internals. </description> <tutorials> <link title="Internationalizing games">$DOCS_URL/tutorials/i18n/internationalizing_games.html</link> @@ -15,13 +16,13 @@ <return type="void" /> <param index="0" name="translation" type="Translation" /> <description> - Adds a [Translation] resource. + Adds a translation to the main translation domain. </description> </method> <method name="clear"> <return type="void" /> <description> - Clears the server from all translations. + Removes all translations from the main translation domain. </description> </method> <method name="compare_locales" qualifiers="const"> @@ -84,6 +85,13 @@ Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). </description> </method> + <method name="get_or_add_domain"> + <return type="TranslationDomain" /> + <param index="0" name="domain" type="StringName" /> + <description> + Returns the translation domain with the specified name. An empty translation domain will be created and added if it does not exist. + </description> + </method> <method name="get_script_name" qualifiers="const"> <return type="String" /> <param index="0" name="script" type="String" /> @@ -102,8 +110,14 @@ <return type="Translation" /> <param index="0" name="locale" type="String" /> <description> - Returns the [Translation] instance based on the [param locale] passed in. - It will return [code]null[/code] if there is no [Translation] instance that matches the [param locale]. + Returns the [Translation] instance that best matches [param locale] in the main translation domain. Returns [code]null[/code] if there are no matches. + </description> + </method> + <method name="has_domain" qualifiers="const"> + <return type="bool" /> + <param index="0" name="domain" type="StringName" /> + <description> + Returns [code]true[/code] if a translation domain with the specified name exists. </description> </method> <method name="pseudolocalize" qualifiers="const"> @@ -119,11 +133,19 @@ Reparses the pseudolocalization options and reloads the translation. </description> </method> + <method name="remove_domain"> + <return type="void" /> + <param index="0" name="domain" type="StringName" /> + <description> + Removes the translation domain with the specified name. + [b]Note:[/b] Trying to remove the main translation domain is an error. + </description> + </method> <method name="remove_translation"> <return type="void" /> <param index="0" name="translation" type="Translation" /> <description> - Removes the given translation from the server. + Removes the given translation from the main translation domain. </description> </method> <method name="set_locale"> @@ -146,7 +168,8 @@ <param index="0" name="message" type="StringName" /> <param index="1" name="context" type="StringName" default="&""" /> <description> - Returns the current locale's translation for the given message (key) and context. + Returns the current locale's translation for the given message and context. + [b]Note:[/b] This method always uses the main translation domain. </description> </method> <method name="translate_plural" qualifiers="const"> @@ -156,8 +179,9 @@ <param index="2" name="n" type="int" /> <param index="3" name="context" type="StringName" default="&""" /> <description> - Returns the current locale's translation for the given message (key), plural message and context. + Returns the current locale's translation for the given message, plural message and context. The number [param n] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. + [b]Note:[/b] This method always uses the main translation domain. </description> </method> </methods> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 78a703c213..132ecc3f92 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -19,7 +19,7 @@ <param index="3" name="disabled" type="bool" default="false" /> <param index="4" name="tooltip_text" type="String" default="""" /> <description> - Adds a button with [Texture2D] [param button] at column [param column]. The [param id] is used to identify the button in the according [signal Tree.button_clicked] signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately before this method. Optionally, the button can be [param disabled] and have a [param tooltip_text]. + Adds a button with [Texture2D] [param button] to the end of the cell at column [param column]. The [param id] is used to identify the button in the according [signal Tree.button_clicked] signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately before this method. Optionally, the button can be [param disabled] and have a [param tooltip_text]. </description> </method> <method name="add_child"> @@ -73,6 +73,13 @@ Removes the button at index [param button_index] in column [param column]. </description> </method> + <method name="get_auto_translate_mode" qualifiers="const"> + <return type="int" enum="Node.AutoTranslateMode" /> + <param index="0" name="column" type="int" /> + <description> + Returns the column's auto translate mode. + </description> + </method> <method name="get_autowrap_mode" qualifiers="const"> <return type="int" enum="TextServer.AutowrapMode" /> <param index="0" name="column" type="int" /> @@ -223,6 +230,13 @@ Returns the [Color] modulating the column's icon. </description> </method> + <method name="get_icon_overlay" qualifiers="const"> + <return type="Texture2D" /> + <param index="0" name="column" type="int" /> + <description> + Returns the given column's icon overlay [Texture2D]. + </description> + </method> <method name="get_icon_region" qualifiers="const"> <return type="Rect2" /> <param index="0" name="column" type="int" /> @@ -486,6 +500,15 @@ Selects the given [param column]. </description> </method> + <method name="set_auto_translate_mode"> + <return type="void" /> + <param index="0" name="column" type="int" /> + <param index="1" name="mode" type="int" enum="Node.AutoTranslateMode" /> + <description> + Sets the given column's auto translate mode to [param mode]. + All columns use [constant Node.AUTO_TRANSLATE_MODE_INHERIT] by default, which uses the same auto translate mode as the [Tree] itself. + </description> + </method> <method name="set_autowrap_mode"> <return type="void" /> <param index="0" name="column" type="int" /> @@ -643,7 +666,7 @@ <param index="0" name="column" type="int" /> <param index="1" name="texture" type="Texture2D" /> <description> - Sets the given cell's icon [Texture2D]. The cell has to be in [constant CELL_MODE_ICON] mode. + Sets the given cell's icon [Texture2D]. If the cell is in [constant CELL_MODE_ICON] mode, the icon is displayed in the center of the cell. Otherwise, the icon is displayed before the cell's text. [constant CELL_MODE_RANGE] does not display an icon. </description> </method> <method name="set_icon_max_width"> @@ -662,6 +685,14 @@ Modulates the given column's icon with [param modulate]. </description> </method> + <method name="set_icon_overlay"> + <return type="void" /> + <param index="0" name="column" type="int" /> + <param index="1" name="texture" type="Texture2D" /> + <description> + Sets the given cell's icon overlay [Texture2D]. The cell has to be in [constant CELL_MODE_ICON] mode, and icon has to be set. Overlay is drawn on top of icon, in the bottom left corner. + </description> + </method> <method name="set_icon_region"> <return type="void" /> <param index="0" name="column" type="int" /> @@ -811,17 +842,17 @@ </members> <constants> <constant name="CELL_MODE_STRING" value="0" enum="TreeCellMode"> - Cell shows a string label. When editable, the text can be edited using a [LineEdit], or a [TextEdit] popup if [method set_edit_multiline] is used. + Cell shows a string label, optionally with an icon. When editable, the text can be edited using a [LineEdit], or a [TextEdit] popup if [method set_edit_multiline] is used. </constant> <constant name="CELL_MODE_CHECK" value="1" enum="TreeCellMode"> - Cell shows a checkbox, optionally with text. The checkbox can be pressed, released, or indeterminate (via [method set_indeterminate]). The checkbox can't be clicked unless the cell is editable. + Cell shows a checkbox, optionally with text and an icon. The checkbox can be pressed, released, or indeterminate (via [method set_indeterminate]). The checkbox can't be clicked unless the cell is editable. </constant> <constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode"> Cell shows a numeric range. When editable, it can be edited using a range slider. Use [method set_range] to set the value and [method set_range_config] to configure the range. This cell can also be used in a text dropdown mode when you assign a text with [method set_text]. Separate options with a comma, e.g. [code]"Option1,Option2,Option3"[/code]. </constant> <constant name="CELL_MODE_ICON" value="3" enum="TreeCellMode"> - Cell shows an icon. It can't be edited nor display text. + Cell shows an icon. It can't be edited nor display text. The icon is always centered within the cell. </constant> <constant name="CELL_MODE_CUSTOM" value="4" enum="TreeCellMode"> Cell shows as a clickable button. It will display an arrow similar to [OptionButton], but doesn't feature a dropdown (for that you can use [constant CELL_MODE_RANGE]). Clicking the button emits the [signal Tree.item_edited] signal. The button is flat by default, you can use [method set_custom_as_button] to display it with a [StyleBox]. diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index 8f54b767e0..b351f2ccb6 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -216,7 +216,7 @@ <return type="Vector4i" /> <param index="0" name="right" type="int" /> <description> - Gets the remainder of each component of the [Vector4i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + Gets the remainder of each component of the [Vector4i] with the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] print(Vector4i(10, -20, 30, -40) % 7) # Prints "(3, -6, 2, -5)" [/codeblock] diff --git a/doc/classes/VehicleWheel3D.xml b/doc/classes/VehicleWheel3D.xml index 7b4952580c..621f32de6d 100644 --- a/doc/classes/VehicleWheel3D.xml +++ b/doc/classes/VehicleWheel3D.xml @@ -54,10 +54,10 @@ Slows down the wheel by applying a braking force. The wheel is only slowed down if it is in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody3D.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. </member> <member name="damping_compression" type="float" setter="set_damping_compression" getter="get_damping_compression" default="0.83"> - The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. + The damping applied to the suspension spring when being compressed, meaning when the wheel is moving up relative to the vehicle. It is measured in Newton-seconds per millimeter (N⋅s/mm), or megagrams per second (Mg/s). This value should be between 0.0 (no damping) and 1.0, but may be more. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. </member> <member name="damping_relaxation" type="float" setter="set_damping_relaxation" getter="get_damping_relaxation" default="0.88"> - The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5. + The damping applied to the suspension spring when rebounding or extending, meaning when the wheel is moving down relative to the vehicle. It is measured in Newton-seconds per millimeter (N⋅s/mm), or megagrams per second (Mg/s). This value should be between 0.0 (no damping) and 1.0, but may be more. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5. </member> <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force" default="0.0"> Accelerates the wheel by applying an engine force. The wheel is only sped up if it is in contact with a surface. The [member RigidBody3D.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. @@ -71,7 +71,7 @@ The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody3D.mass] of the [VehicleBody3D] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number. </member> <member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness" default="5.88"> - This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. + The stiffness of the suspension, measured in Newtons per millimeter (N/mm), or megagrams per second squared (Mg/s²). Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. </member> <member name="suspension_travel" type="float" setter="set_suspension_travel" getter="get_suspension_travel" default="0.2"> This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 350fd65197..95a1d0f77e 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -33,6 +33,18 @@ Returns the first valid [World3D] for this viewport, searching the [member world_3d] property of itself and any Viewport ancestor. </description> </method> + <method name="get_audio_listener_2d" qualifiers="const"> + <return type="AudioListener2D" /> + <description> + Returns the currently active 2D audio listener. Returns [code]null[/code] if there are no active 2D audio listeners, in which case the active 2D camera will be treated as listener. + </description> + </method> + <method name="get_audio_listener_3d" qualifiers="const"> + <return type="AudioListener3D" /> + <description> + Returns the currently active 3D audio listener. Returns [code]null[/code] if there are no active 3D audio listeners, in which case the active 3D camera will be treated as listener. + </description> + </method> <method name="get_camera_2d" qualifiers="const"> <return type="Camera2D" /> <description> @@ -151,7 +163,7 @@ <method name="gui_is_dragging" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the viewport is currently performing a drag operation. + Returns [code]true[/code] if a drag operation is currently ongoing and where the drop action could happen in this viewport. Alternative to [constant Node.NOTIFICATION_DRAG_BEGIN] and [constant Node.NOTIFICATION_DRAG_END] when you prefer polling the value. </description> </method> diff --git a/doc/classes/VisualShaderNodeRemap.xml b/doc/classes/VisualShaderNodeRemap.xml index 102672ff60..d4ecb2dd31 100644 --- a/doc/classes/VisualShaderNodeRemap.xml +++ b/doc/classes/VisualShaderNodeRemap.xml @@ -8,4 +8,34 @@ </description> <tutorials> </tutorials> + <members> + <member name="op_type" type="int" setter="set_op_type" getter="get_op_type" enum="VisualShaderNodeRemap.OpType" default="0"> + </member> + </members> + <constants> + <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> + A floating-point scalar type. + </constant> + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_2D_SCALAR" value="2" enum="OpType"> + The [code]value[/code] port uses a 2D vector type, while the [code]input min[/code], [code]input max[/code], [code]output min[/code], and [code]output max[/code] ports use a floating-point scalar type. + </constant> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> + The [code]value[/code] port uses a 3D vector type, while the [code]input min[/code], [code]input max[/code], [code]output min[/code], and [code]output max[/code] ports use a floating-point scalar type. + </constant> + <constant name="OP_TYPE_VECTOR_4D" value="5" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_4D_SCALAR" value="6" enum="OpType"> + The [code]value[/code] port uses a 4D vector type, while the [code]input min[/code], [code]input max[/code], [code]output min[/code], and [code]output max[/code] ports use a floating-point scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="7" enum="OpType"> + Represents the size of the [enum OpType] enum. + </constant> + </constants> </class> diff --git a/doc/classes/XRPose.xml b/doc/classes/XRPose.xml index 60a2226a60..76c1ced352 100644 --- a/doc/classes/XRPose.xml +++ b/doc/classes/XRPose.xml @@ -29,11 +29,11 @@ The linear velocity of this pose. </member> <member name="name" type="StringName" setter="set_name" getter="get_name" default="&"""> - The name of this pose. Pose names are often driven by an action map setup by the user. Godot does suggest a number of pose names that it expects [XRInterface]s to implement: - - [code]root[/code] defines a root location, often used for tracked objects that do not have further nodes. - - [code]aim[/code] defines the tip of a controller with the orientation pointing outwards, for example: add your raycasts to this. - - [code]grip[/code] defines the location where the user grips the controller - - [code]skeleton[/code] defines the root location a hand mesh should be placed when using hand tracking and the animated skeleton supplied by the XR runtime. + The name of this pose. Usually, this name is derived from an action map set up by the user. Godot also suggests some pose names that [XRInterface] objects are expected to implement: + - [code]root[/code] is the root location, often used for tracked objects that do not have further nodes. + - [code]aim[/code] is the tip of a controller with its orientation pointing outwards, often used for raycasts. + - [code]grip[/code] is the location where the user grips the controller. + - [code]skeleton[/code] is the root location for a hand mesh, when using hand tracking and an animated skeleton is supplied by the XR runtime. </member> <member name="tracking_confidence" type="int" setter="set_tracking_confidence" getter="get_tracking_confidence" enum="XRPose.TrackingConfidence" default="0"> The tracking confidence for this pose, provides insight on how accurate the spatial positioning of this record is. |