summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/AStar2D.xml2
-rw-r--r--doc/classes/AStar3D.xml2
-rw-r--r--doc/classes/AudioEffectStereoEnhance.xml3
-rw-r--r--doc/classes/Basis.xml8
-rw-r--r--doc/classes/CollisionPolygon2D.xml1
-rw-r--r--doc/classes/CollisionShape2D.xml1
-rw-r--r--doc/classes/EngineProfiler.xml4
-rw-r--r--doc/classes/ItemList.xml25
-rw-r--r--doc/classes/MissingNode.xml17
-rw-r--r--doc/classes/MissingResource.xml17
-rw-r--r--doc/classes/PackedByteArray.xml23
-rw-r--r--doc/classes/PackedColorArray.xml23
-rw-r--r--doc/classes/PackedFloat32Array.xml23
-rw-r--r--doc/classes/PackedFloat64Array.xml23
-rw-r--r--doc/classes/PackedInt32Array.xml23
-rw-r--r--doc/classes/PackedInt64Array.xml23
-rw-r--r--doc/classes/PackedStringArray.xml23
-rw-r--r--doc/classes/PackedVector2Array.xml23
-rw-r--r--doc/classes/PackedVector3Array.xml23
-rw-r--r--doc/classes/ProgressBar.xml17
-rw-r--r--doc/classes/TileSet.xml2
-rw-r--r--doc/classes/Time.xml4
-rw-r--r--doc/classes/Transform2D.xml8
-rw-r--r--doc/classes/Transform3D.xml8
-rw-r--r--doc/classes/Vector2.xml4
-rw-r--r--doc/classes/Vector3.xml6
-rw-r--r--doc/classes/VisualShaderNodeColorFunc.xml10
-rw-r--r--doc/classes/VisualShaderNodeVectorFunc.xml66
28 files changed, 335 insertions, 77 deletions
diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml
index 4b65a64389..7a27568d30 100644
--- a/doc/classes/AStar2D.xml
+++ b/doc/classes/AStar2D.xml
@@ -33,7 +33,7 @@
<argument index="1" name="position" type="Vector2" />
<argument index="2" name="weight_scale" type="float" default="1.0" />
<description>
- Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger.
+ Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater.
The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path.
[codeblocks]
[gdscript]
diff --git a/doc/classes/AStar3D.xml b/doc/classes/AStar3D.xml
index 3087b9e363..33407c3e74 100644
--- a/doc/classes/AStar3D.xml
+++ b/doc/classes/AStar3D.xml
@@ -62,7 +62,7 @@
<argument index="1" name="position" type="Vector3" />
<argument index="2" name="weight_scale" type="float" default="1.0" />
<description>
- Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger.
+ Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater.
The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path.
[codeblocks]
[gdscript]
diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml
index ff176c6ad8..5c62ba982f 100644
--- a/doc/classes/AudioEffectStereoEnhance.xml
+++ b/doc/classes/AudioEffectStereoEnhance.xml
@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectStereoEnhance" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
+ An audio effect that can be used to adjust the intensity of stereo panning.
</brief_description>
<description>
+ An audio effect that can be used to adjust the intensity of stereo panning.
</description>
<tutorials>
</tutorials>
<members>
<member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0">
+ Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono.
</member>
<member name="surround" type="float" setter="set_surround" getter="get_surround" default="0.0">
</member>
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index 3b703884a5..0af482d654 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -35,9 +35,9 @@
<constructor name="Basis">
<return type="Basis" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector.
+ Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</constructor>
<constructor name="Basis">
@@ -136,9 +136,9 @@
<method name="rotated" qualifiers="const">
<return type="Basis" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
+ Introduce an additional rotation around the given axis by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</method>
<method name="scaled" qualifiers="const">
diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml
index a9d8a85226..f290fc9801 100644
--- a/doc/classes/CollisionPolygon2D.xml
+++ b/doc/classes/CollisionPolygon2D.xml
@@ -18,6 +18,7 @@
</member>
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.
+ [b]Note:[/b] This property has no effect if this [CollisionPolygon2D] is a child of an [Area2D] node.
</member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml
index f3a4cbc2d6..246e0e8663 100644
--- a/doc/classes/CollisionShape2D.xml
+++ b/doc/classes/CollisionShape2D.xml
@@ -18,6 +18,7 @@
</member>
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
Sets whether this collision shape should only detect collision on one side (top or bottom).
+ [b]Note:[/b] This property has no effect if this [CollisionShape2D] is a child of an [Area2D] node.
</member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.
diff --git a/doc/classes/EngineProfiler.xml b/doc/classes/EngineProfiler.xml
index 45eb926108..752ecda867 100644
--- a/doc/classes/EngineProfiler.xml
+++ b/doc/classes/EngineProfiler.xml
@@ -20,11 +20,11 @@
<method name="_tick" qualifiers="virtual">
<return type="void" />
<argument index="0" name="frame_time" type="float" />
- <argument index="1" name="idle_time" type="float" />
+ <argument index="1" name="process_time" type="float" />
<argument index="2" name="physics_time" type="float" />
<argument index="3" name="physics_frame_time" type="float" />
<description>
- Called once every engine iteration when the profiler is active with information about the current frame.
+ Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better.
</description>
</method>
<method name="_toggle" qualifiers="virtual">
diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml
index edfd8daec1..83e7eba5e5 100644
--- a/doc/classes/ItemList.xml
+++ b/doc/classes/ItemList.xml
@@ -407,19 +407,26 @@
</member>
</members>
<signals>
+ <signal name="empty_clicked">
+ <argument index="0" name="at_position" type="Vector2" />
+ <argument 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.
+ </description>
+ </signal>
<signal name="item_activated">
<argument index="0" name="index" type="int" />
<description>
Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd].
</description>
</signal>
- <signal name="item_rmb_selected">
+ <signal name="item_clicked">
<argument index="0" name="index" type="int" />
<argument index="1" name="at_position" type="Vector2" />
+ <argument index="2" name="mouse_button_index" type="int" />
<description>
- Triggered when specified list item has been selected via right mouse clicking.
+ 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.
- [member allow_rmb_select] must be enabled.
</description>
</signal>
<signal name="item_selected">
@@ -436,18 +443,6 @@
Triggered when a multiple selection is altered on a list allowing multiple selection.
</description>
</signal>
- <signal name="nothing_selected">
- <description>
- Triggered when a left mouse click is issued within the rect of the list but on empty space.
- </description>
- </signal>
- <signal name="rmb_clicked">
- <argument index="0" name="at_position" type="Vector2" />
- <description>
- Triggered when a right mouse click is issued within the rect of the list but on empty space.
- [member allow_rmb_select] must be enabled.
- </description>
- </signal>
</signals>
<constants>
<constant name="ICON_MODE_TOP" value="0" enum="IconMode">
diff --git a/doc/classes/MissingNode.xml b/doc/classes/MissingNode.xml
new file mode 100644
index 0000000000..b5aa02cfd6
--- /dev/null
+++ b/doc/classes/MissingNode.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="MissingNode" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ This is an internal editor class intended for keeping data of nodes of unknown type.
+ </brief_description>
+ <description>
+ This is an internal editor class intended for keeping data of nodes of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is.
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="original_class" type="String" setter="set_original_class" getter="get_original_class">
+ </member>
+ <member name="recording_properties" type="bool" setter="set_recording_properties" getter="is_recording_properties">
+ </member>
+ </members>
+</class>
diff --git a/doc/classes/MissingResource.xml b/doc/classes/MissingResource.xml
new file mode 100644
index 0000000000..eede6350d8
--- /dev/null
+++ b/doc/classes/MissingResource.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="MissingResource" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ This is an internal editor class intended for keeping data of resources of unknown type.
+ </brief_description>
+ <description>
+ This is an internal editor class intended for keeping data of resources of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is.
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="original_class" type="String" setter="set_original_class" getter="get_original_class">
+ </member>
+ <member name="recording_properties" type="bool" setter="set_recording_properties" getter="is_recording_properties">
+ </member>
+ </members>
+</class>
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml
index 61dc1eef00..5d0861bcf3 100644
--- a/doc/classes/PackedByteArray.xml
+++ b/doc/classes/PackedByteArray.xml
@@ -61,6 +61,13 @@
Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="decode_double" qualifiers="const">
<return type="float" />
<argument index="0" name="byte_offset" type="int" />
@@ -257,6 +264,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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_string_from_ascii" qualifiers="const">
<return type="String" />
<description>
@@ -352,6 +367,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml
index f880771c77..12a553af49 100644
--- a/doc/classes/PackedColorArray.xml
+++ b/doc/classes/PackedColorArray.xml
@@ -54,6 +54,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Color" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedColorArray" />
<description>
@@ -67,6 +74,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Color" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="Color" />
@@ -115,6 +130,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Color" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml
index e2b877ad5f..0a114e6c06 100644
--- a/doc/classes/PackedFloat32Array.xml
+++ b/doc/classes/PackedFloat32Array.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedFloat32Array" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="float" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml
index be7a52b7f4..0327559f5b 100644
--- a/doc/classes/PackedFloat64Array.xml
+++ b/doc/classes/PackedFloat64Array.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedFloat64Array" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="float" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml
index 108273d859..f8b606d266 100644
--- a/doc/classes/PackedInt32Array.xml
+++ b/doc/classes/PackedInt32Array.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedInt32Array" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="int" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml
index c34f2fc75e..ea3e304d35 100644
--- a/doc/classes/PackedInt64Array.xml
+++ b/doc/classes/PackedInt64Array.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedInt64Array" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="int" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="int" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml
index 536f5f02eb..d0f1d5f753 100644
--- a/doc/classes/PackedStringArray.xml
+++ b/doc/classes/PackedStringArray.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedStringArray" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="String" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml
index 29423d1cde..8f3e5d173d 100644
--- a/doc/classes/PackedVector2Array.xml
+++ b/doc/classes/PackedVector2Array.xml
@@ -55,6 +55,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector2" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedVector2Array" />
<description>
@@ -68,6 +75,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector2" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="Vector2" />
@@ -116,6 +131,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector2" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml
index 6d460cecab..1207293c32 100644
--- a/doc/classes/PackedVector3Array.xml
+++ b/doc/classes/PackedVector3Array.xml
@@ -54,6 +54,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector3" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedVector3Array" />
<description>
@@ -67,6 +74,14 @@
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
+ <method name="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector3" />
+ <argument index="1" name="from" type="int" default="0" />
+ <description>
+ 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="Vector3" />
@@ -115,6 +130,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="Vector3" />
+ <argument index="1" name="from" type="int" default="-1" />
+ <description>
+ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
+ </description>
+ </method>
<method name="set">
<return type="void" />
<argument index="0" name="index" type="int" />
diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml
index 1e9ab7c375..8a781c51fb 100644
--- a/doc/classes/ProgressBar.xml
+++ b/doc/classes/ProgressBar.xml
@@ -9,10 +9,27 @@
<tutorials>
</tutorials>
<members>
+ <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode" default="0">
+ The fill direction. See [enum FillMode] for possible values.
+ </member>
<member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible" default="true">
If [code]true[/code], the fill percentage is displayed on the bar.
</member>
</members>
+ <constants>
+ <constant name="FILL_BEGIN_TO_END" value="0" enum="FillMode">
+ The progress bar fills from begin to end horizontally, according to the language direction. If [method Control.is_layout_rtl] returns [code]false[/code], it fills from left to right, and if it returns [code]true[/code], it fills from right to left.
+ </constant>
+ <constant name="FILL_END_TO_BEGIN" value="1" enum="FillMode">
+ The progress bar fills from end to begin horizontally, according to the language direction. If [method Control.is_layout_rtl] returns [code]false[/code], it fills from right to left, and if it returns [code]true[/code], it fills from left to right.
+ </constant>
+ <constant name="FILL_TOP_TO_BOTTOM" value="2" enum="FillMode">
+ The progress fills from top to bottom.
+ </constant>
+ <constant name="FILL_BOTTOM_TO_TOP" value="3" enum="FillMode">
+ The progress fills from bottom to top.
+ </constant>
+ </constants>
<theme_items>
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
The color of the text.
diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index 809992b58f..10ccad973f 100644
--- a/doc/classes/TileSet.xml
+++ b/doc/classes/TileSet.xml
@@ -113,7 +113,7 @@
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<description>
- Returns the coodinate-level proxy for the given identifiers. The returned array contains the two proxie's target identifiers (source ID and atlas coords ID).
+ Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID).
If the TileSet has no proxy for the given identifiers, returns an empty Array.
</description>
</method>
diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml
index d3aac5fa00..5fc85c869b 100644
--- a/doc/classes/Time.xml
+++ b/doc/classes/Time.xml
@@ -43,7 +43,7 @@
Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD).
</description>
</method>
- <method name="get_datetime_dict_from_string" qualifiers="const">
+ <method name="get_datetime_dict_from_datetime_string" qualifiers="const">
<return type="Dictionary" />
<argument index="0" name="datetime" type="String" />
<argument index="1" name="weekday" type="bool" />
@@ -68,7 +68,7 @@
The returned Dictionary's values will be the same as the [method get_datetime_dict_from_system] if the Unix timestamp is the current time, with the exception of Daylight Savings Time as it cannot be determined from the epoch.
</description>
</method>
- <method name="get_datetime_string_from_dict" qualifiers="const">
+ <method name="get_datetime_string_from_datetime_dict" qualifiers="const">
<return type="String" />
<argument index="0" name="datetime" type="Dictionary" />
<argument index="1" name="use_space" type="bool" />
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 3ad21ee809..8c2a5aa6d9 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -139,16 +139,16 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="phi" type="float" />
+ <argument index="0" name="angle" type="float" />
<description>
- Rotates the transform by the given angle (in radians), using matrix multiplication.
+ Returns a copy of the transform rotated by the given [code]angle[/code] (in radians), using matrix multiplication.
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform2D" />
<argument index="0" name="scale" type="Vector2" />
<description>
- Scales the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="set_rotation">
@@ -176,7 +176,7 @@
<return type="Transform2D" />
<argument index="0" name="offset" type="Vector2" />
<description>
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 5a72dc223c..afd11b6c77 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -94,16 +94,16 @@
<method name="rotated" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
+ Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector.
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="scale" type="Vector3" />
<description>
- Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform with its basis and origin scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="sphere_interpolate_with" qualifiers="const">
@@ -118,7 +118,7 @@
<return type="Transform3D" />
<argument index="0" name="offset" type="Vector3" />
<description>
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index f9ef126658..6ccc0fc6a6 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -278,9 +278,9 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="phi" type="float" />
+ <argument index="0" name="angle" type="float" />
<description>
- Returns the vector rotated by [code]phi[/code] radians. See also [method @GlobalScope.deg2rad].
+ Returns the vector rotated by [code]angle[/code] (in radians). See also [method @GlobalScope.deg2rad].
</description>
</method>
<method name="round" qualifiers="const">
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 18204943fd..d907ceb52b 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -258,10 +258,10 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Vector3" />
- <argument index="0" name="by_axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="0" name="axis" type="Vector3" />
+ <argument index="1" name="angle" type="float" />
<description>
- Rotates this vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector.
+ Rotates this vector around a given axis by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</method>
<method name="round" qualifiers="const">
diff --git a/doc/classes/VisualShaderNodeColorFunc.xml b/doc/classes/VisualShaderNodeColorFunc.xml
index 4a73b1662e..6116e0df68 100644
--- a/doc/classes/VisualShaderNodeColorFunc.xml
+++ b/doc/classes/VisualShaderNodeColorFunc.xml
@@ -24,7 +24,13 @@
return vec3(max3, max3, max3);
[/codeblock]
</constant>
- <constant name="FUNC_SEPIA" value="1" enum="Function">
+ <constant name="FUNC_HSV2RGB" value="1" enum="Function">
+ Converts HSV vector to RGB equivalent.
+ </constant>
+ <constant name="FUNC_RGB2HSV" value="2" enum="Function">
+ Converts RGB vector to HSV equivalent.
+ </constant>
+ <constant name="FUNC_SEPIA" value="3" enum="Function">
Applies sepia tone effect using the following formula:
[codeblock]
vec3 c = input;
@@ -34,7 +40,7 @@
return vec3(r, g, b);
[/codeblock]
</constant>
- <constant name="FUNC_MAX" value="2" enum="Function">
+ <constant name="FUNC_MAX" value="4" enum="Function">
Represents the size of the [enum Function] enum.
</constant>
</constants>
diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml
index dc6628a9af..bc4e12c0b3 100644
--- a/doc/classes/VisualShaderNodeVectorFunc.xml
+++ b/doc/classes/VisualShaderNodeVectorFunc.xml
@@ -26,100 +26,94 @@
<constant name="FUNC_RECIPROCAL" value="3" enum="Function">
Returns [code]1/vector[/code].
</constant>
- <constant name="FUNC_RGB2HSV" value="4" enum="Function">
- Converts RGB vector to HSV equivalent.
- </constant>
- <constant name="FUNC_HSV2RGB" value="5" enum="Function">
- Converts HSV vector to RGB equivalent.
- </constant>
- <constant name="FUNC_ABS" value="6" enum="Function">
+ <constant name="FUNC_ABS" value="4" enum="Function">
Returns the absolute value of the parameter.
</constant>
- <constant name="FUNC_ACOS" value="7" enum="Function">
+ <constant name="FUNC_ACOS" value="5" enum="Function">
Returns the arc-cosine of the parameter.
</constant>
- <constant name="FUNC_ACOSH" value="8" enum="Function">
+ <constant name="FUNC_ACOSH" value="6" enum="Function">
Returns the inverse hyperbolic cosine of the parameter.
</constant>
- <constant name="FUNC_ASIN" value="9" enum="Function">
+ <constant name="FUNC_ASIN" value="7" enum="Function">
Returns the arc-sine of the parameter.
</constant>
- <constant name="FUNC_ASINH" value="10" enum="Function">
+ <constant name="FUNC_ASINH" value="8" enum="Function">
Returns the inverse hyperbolic sine of the parameter.
</constant>
- <constant name="FUNC_ATAN" value="11" enum="Function">
+ <constant name="FUNC_ATAN" value="9" enum="Function">
Returns the arc-tangent of the parameter.
</constant>
- <constant name="FUNC_ATANH" value="12" enum="Function">
+ <constant name="FUNC_ATANH" value="10" enum="Function">
Returns the inverse hyperbolic tangent of the parameter.
</constant>
- <constant name="FUNC_CEIL" value="13" enum="Function">
+ <constant name="FUNC_CEIL" value="11" enum="Function">
Finds the nearest integer that is greater than or equal to the parameter.
</constant>
- <constant name="FUNC_COS" value="14" enum="Function">
+ <constant name="FUNC_COS" value="12" enum="Function">
Returns the cosine of the parameter.
</constant>
- <constant name="FUNC_COSH" value="15" enum="Function">
+ <constant name="FUNC_COSH" value="13" enum="Function">
Returns the hyperbolic cosine of the parameter.
</constant>
- <constant name="FUNC_DEGREES" value="16" enum="Function">
+ <constant name="FUNC_DEGREES" value="14" enum="Function">
Converts a quantity in radians to degrees.
</constant>
- <constant name="FUNC_EXP" value="17" enum="Function">
+ <constant name="FUNC_EXP" value="15" enum="Function">
Base-e Exponential.
</constant>
- <constant name="FUNC_EXP2" value="18" enum="Function">
+ <constant name="FUNC_EXP2" value="16" enum="Function">
Base-2 Exponential.
</constant>
- <constant name="FUNC_FLOOR" value="19" enum="Function">
+ <constant name="FUNC_FLOOR" value="17" enum="Function">
Finds the nearest integer less than or equal to the parameter.
</constant>
- <constant name="FUNC_FRAC" value="20" enum="Function">
+ <constant name="FUNC_FRAC" value="18" enum="Function">
Computes the fractional part of the argument.
</constant>
- <constant name="FUNC_INVERSE_SQRT" value="21" enum="Function">
+ <constant name="FUNC_INVERSE_SQRT" value="19" enum="Function">
Returns the inverse of the square root of the parameter.
</constant>
- <constant name="FUNC_LOG" value="22" enum="Function">
+ <constant name="FUNC_LOG" value="20" enum="Function">
Natural logarithm.
</constant>
- <constant name="FUNC_LOG2" value="23" enum="Function">
+ <constant name="FUNC_LOG2" value="21" enum="Function">
Base-2 logarithm.
</constant>
- <constant name="FUNC_RADIANS" value="24" enum="Function">
+ <constant name="FUNC_RADIANS" value="22" enum="Function">
Converts a quantity in degrees to radians.
</constant>
- <constant name="FUNC_ROUND" value="25" enum="Function">
+ <constant name="FUNC_ROUND" value="23" enum="Function">
Finds the nearest integer to the parameter.
</constant>
- <constant name="FUNC_ROUNDEVEN" value="26" enum="Function">
+ <constant name="FUNC_ROUNDEVEN" value="24" enum="Function">
Finds the nearest even integer to the parameter.
</constant>
- <constant name="FUNC_SIGN" value="27" enum="Function">
+ <constant name="FUNC_SIGN" value="25" enum="Function">
Extracts the sign of the parameter, i.e. returns [code]-1[/code] if the parameter is negative, [code]1[/code] if it's positive and [code]0[/code] otherwise.
</constant>
- <constant name="FUNC_SIN" value="28" enum="Function">
+ <constant name="FUNC_SIN" value="26" enum="Function">
Returns the sine of the parameter.
</constant>
- <constant name="FUNC_SINH" value="29" enum="Function">
+ <constant name="FUNC_SINH" value="27" enum="Function">
Returns the hyperbolic sine of the parameter.
</constant>
- <constant name="FUNC_SQRT" value="30" enum="Function">
+ <constant name="FUNC_SQRT" value="28" enum="Function">
Returns the square root of the parameter.
</constant>
- <constant name="FUNC_TAN" value="31" enum="Function">
+ <constant name="FUNC_TAN" value="29" enum="Function">
Returns the tangent of the parameter.
</constant>
- <constant name="FUNC_TANH" value="32" enum="Function">
+ <constant name="FUNC_TANH" value="30" enum="Function">
Returns the hyperbolic tangent of the parameter.
</constant>
- <constant name="FUNC_TRUNC" value="33" enum="Function">
+ <constant name="FUNC_TRUNC" value="31" enum="Function">
Returns a value equal to the nearest integer to the parameter whose absolute value is not larger than the absolute value of the parameter.
</constant>
- <constant name="FUNC_ONEMINUS" value="34" enum="Function">
+ <constant name="FUNC_ONEMINUS" value="32" enum="Function">
Returns [code]1.0 - vector[/code].
</constant>
- <constant name="FUNC_MAX" value="35" enum="Function">
+ <constant name="FUNC_MAX" value="33" enum="Function">
Represents the size of the [enum Function] enum.
</constant>
</constants>