diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AcceptDialog.xml | 2 | ||||
| -rw-r--r-- | doc/classes/CanvasItem.xml | 2 | ||||
| -rw-r--r-- | doc/classes/EditorFileSystemImportFormatSupportQuery.xml | 31 | ||||
| -rw-r--r-- | doc/classes/NavigationAgent2D.xml | 3 | ||||
| -rw-r--r-- | doc/classes/NavigationAgent3D.xml | 3 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 5 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 4 | ||||
| -rw-r--r-- | doc/classes/String.xml | 3 | ||||
| -rw-r--r-- | doc/classes/Tween.xml | 7 |
9 files changed, 53 insertions, 7 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 4836f48a57..c1e28ffba3 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -61,6 +61,8 @@ <member name="dialog_autowrap" type="bool" setter="set_autowrap" getter="has_autowrap" default="false"> Sets autowrapping for the text in the dialog. </member> + <member name="dialog_close_on_escape" type="bool" setter="set_close_on_escape" getter="get_close_on_escape" default="true"> + </member> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok" default="true"> If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. [b]Note:[/b] Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such, this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 1fe2f5a756..5205a1db3b 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -490,7 +490,7 @@ The texture repeating mode to use on this [CanvasItem]. </member> <member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false"> - If [code]true[/code], the node will not inherit its transform from parent [CanvasItem]s. + If [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that do not have [member top_level] set to [code]true[/code]. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node]. </member> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false"> If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. diff --git a/doc/classes/EditorFileSystemImportFormatSupportQuery.xml b/doc/classes/EditorFileSystemImportFormatSupportQuery.xml new file mode 100644 index 0000000000..8431a3a7ef --- /dev/null +++ b/doc/classes/EditorFileSystemImportFormatSupportQuery.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorFileSystemImportFormatSupportQuery" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + Used to query and configure import format support. + </brief_description> + <description> + This class is used to query and configure a certain import format. It is used in conjuntion with asset format import plugins. + </description> + <tutorials> + </tutorials> + <methods> + <method name="_get_file_extensions" qualifiers="virtual const"> + <return type="PackedStringArray" /> + <description> + Return the file extensions supported. + </description> + </method> + <method name="_is_active" qualifiers="virtual const"> + <return type="bool" /> + <description> + Return whether this importer is active. + </description> + </method> + <method name="_query" qualifiers="virtual const"> + <return type="bool" /> + <description> + Query support. Return false if import must not continue. + </description> + </method> + </methods> +</class> diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index b7b23a1097..baab91569a 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -90,6 +90,9 @@ <member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="200.0"> The maximum speed that an agent can move. </member> + <member name="navigable_layers" type="int" setter="set_navigable_layers" getter="get_navigable_layers" default="1"> + A bitfield determining what layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new layers. + </member> <member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="500.0"> The distance to search for other agents. </member> diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index 18886ac33e..04b148c70d 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -96,6 +96,9 @@ <member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="10.0"> The maximum speed that an agent can move. </member> + <member name="navigable_layers" type="int" setter="set_navigable_layers" getter="get_navigable_layers" default="1"> + A bitfield determining what layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new layers. + </member> <member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="50.0"> The distance to search for other agents. </member> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 5d0a49c23b..b1a6ed7740 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -483,10 +483,11 @@ [b]Note:[/b] Internal children can only be moved within their expected "internal range" (see [code]internal[/code] parameter in [method add_child]). </description> </method> - <method name="print_stray_nodes"> + <method name="print_orphan_nodes"> <return type="void" /> <description> - Prints all stray nodes (nodes outside the [SceneTree]). Used for debugging. Works only in debug builds. + Prints all orphan nodes (nodes outside the [SceneTree]). Used for debugging. + [b]Note:[/b] [method print_orphan_nodes] only works in debug builds. When called in a project exported in release mode, [method print_orphan_nodes] will not print anything. </description> </method> <method name="print_tree"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 44b16de0cf..5e43c4a4cf 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -553,9 +553,9 @@ <member name="editor/script/templates_search_path" type="String" setter="" getter="" default=""res://script_templates""> Search path for project-specific script templates. Godot will search for script templates both in the editor-specific path and in this project-specific path. </member> - <member name="filesystem/import/blend/enabled" type="bool" setter="" getter="" default="true"> + <member name="filesystem/import/blender/enabled" type="bool" setter="" getter="" default="true"> If [code]true[/code], Blender 3D scene files with the [code].blend[/code] extension will be imported by converting them to glTF 2.0. - This requires configuring a path to a Blender executable in the editor settings at [code]filesystem/import/blend/blender_path[/code]. Blender 3.0 or later is required. + This requires configuring a path to a Blender executable in the editor settings at [code]filesystem/import/blender/blender3_path[/code]. Blender 3.0 or later is required. </member> <member name="filesystem/import/fbx/enabled" type="bool" setter="" getter="" default="true"> If [code]true[/code], Autodesk FBX 3D scene files with the [code].fbx[/code] extension will be imported by converting them to glTF 2.0. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 8108c5eb46..1f3d5596aa 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -341,7 +341,6 @@ print("1.7".is_valid_float()) # Prints "true" print("24".is_valid_float()) # Prints "true" print("7e3".is_valid_float()) # Prints "true" - print("24".is_valid_float()) # Prints "true" print("Hello".is_valid_float()) # Prints "false" [/codeblock] </description> @@ -678,7 +677,7 @@ <return type="float" /> <argument index="0" name="text" type="String" /> <description> - Returns the similarity index ([url=https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient]Sorensen-Dice coefficient[/url]) this string compared to another. 1.0 means totally similar and 0.0 means totally dissimilar. + Returns the similarity index ([url=https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient]Sorensen-Dice coefficient[/url]) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar. [codeblock] print("ABC123".similarity("ABC123")) # Prints "1" print("ABC123".similarity("XYZ456")) # Prints "0" diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 2c152410ce..72f32f39c2 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -72,6 +72,13 @@ [b]Note:[/b] The [Tween] will become invalid after finished, but you can call [method stop] after the step, to keep it and reset. </description> </method> + <method name="get_total_elapsed_time" qualifiers="const"> + <return type="float" /> + <description> + Returns the total time in seconds the [Tween] has been animating (i.e. time since it started, not counting pauses etc.). The time is affected by [method set_speed_scale] and [method stop] will reset it to [code]0[/code]. + [b]Note:[/code] As it results from accumulating frame deltas, the time returned after the [Tween] has finished animating will be slightly greater than the actual [Tween] duration. + </description> + </method> <method name="interpolate_value"> <return type="Variant" /> <argument index="0" name="initial_value" type="Variant" /> |