diff options
Diffstat (limited to 'doc')
44 files changed, 2172 insertions, 1938 deletions
diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 1be6d5a440..d7b7a309ad 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -13,28 +13,30 @@ <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> </tutorials> - <methods> - <method name="AABB" qualifiers="constructor"> + <constructors> + <constructor name="AABB"> <return type="AABB" /> <description> Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="AABB" qualifiers="constructor"> + </constructor> + <constructor name="AABB"> <return type="AABB" /> <argument index="0" name="from" type="AABB" /> <description> Constructs an [AABB] as a copy of the given [AABB]. </description> - </method> - <method name="AABB" qualifiers="constructor"> + </constructor> + <constructor name="AABB"> <return type="AABB" /> <argument index="0" name="position" type="Vector3" /> <argument index="1" name="size" type="Vector3" /> <description> Constructs an [AABB] from a position and size. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="AABB" /> <description> @@ -193,45 +195,47 @@ Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="AABB" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="AABB" /> <argument index="0" name="right" type="Transform3D" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="AABB" /> <description> </description> - </method> - </methods> - <members> - <member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 8898a59036..275b217247 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -44,83 +44,85 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Array" qualifiers="constructor"> + <constructors> + <constructor name="Array"> <return type="Array" /> <description> Constructs an empty [Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs an [Array] as a copy of the given [Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedByteArray" /> <description> Constructs an array from a [PackedByteArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedColorArray" /> <description> Constructs an array from a [PackedColorArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedFloat32Array" /> <description> Constructs an array from a [PackedFloat32Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedFloat64Array" /> <description> Constructs an array from a [PackedFloat64Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedInt32Array" /> <description> Constructs an array from a [PackedInt32Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedInt64Array" /> <description> Constructs an array from a [PackedInt64Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedStringArray" /> <description> Constructs an array from a [PackedStringArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedVector2Array" /> <description> Constructs an array from a [PackedVector2Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedVector3Array" /> <description> Constructs an array from a [PackedVector3Array]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="void" /> <argument index="0" name="value" type="Variant" /> @@ -345,64 +347,6 @@ Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Array" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="void" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="pop_at"> <return type="Variant" /> <argument index="0" name="position" type="int" /> @@ -550,4 +494,64 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="Array" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="void" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 6215c658c3..8ef9cd2e7c 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -18,36 +18,36 @@ <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Basis" qualifiers="constructor"> + <constructors> + <constructor name="Basis"> <return type="Basis" /> <description> Constructs a default-initialized [Basis] set to [constant IDENTITY]. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="from" type="Basis" /> <description> Constructs a [Basis] as a copy of the given [Basis]. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="axis" type="Vector3" /> <argument index="1" name="phi" 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. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="from" type="Quaternion" /> <description> Constructs a pure rotation basis matrix from the given quaternion. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="x_axis" type="Vector3" /> <argument index="1" name="y_axis" type="Vector3" /> @@ -55,7 +55,9 @@ <description> Constructs a basis matrix from 3 axis vectors (matrix columns). </description> - </method> + </constructor> + </constructors> + <methods> <method name="determinant" qualifiers="const"> <return type="float" /> <description> @@ -125,60 +127,6 @@ The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [code]target[/code] and [code]up[/code] vectors cannot be zero, and cannot be parallel to each other. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Basis], which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Basis], which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Basis" /> <description> @@ -274,4 +222,60 @@ The basis that will flip something along the Z axis when used in a transformation. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Basis" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="Basis" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Basis], which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Basis], which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Basis" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector3" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Callable.xml b/doc/classes/Callable.xml index 0a95836e96..2d3571e36c 100644 --- a/doc/classes/Callable.xml +++ b/doc/classes/Callable.xml @@ -35,28 +35,30 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Callable" qualifiers="constructor"> + <constructors> + <constructor name="Callable"> <return type="Callable" /> <description> Constructs a null [Callable] with no object nor method bound. </description> - </method> - <method name="Callable" qualifiers="constructor"> + </constructor> + <constructor name="Callable"> <return type="Callable" /> <argument index="0" name="from" type="Callable" /> <description> Constructs a [Callable] as a copy of the given [Callable]. </description> - </method> - <method name="Callable" qualifiers="constructor"> + </constructor> + <constructor name="Callable"> <return type="Callable" /> <argument index="0" name="object" type="Object" /> <argument index="1" name="method" type="StringName" /> <description> Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="bind" qualifiers="vararg const"> <return type="Callable" /> <description> @@ -123,30 +125,6 @@ Returns [code]true[/code] if the object exists and has a valid function assigned, or is a custom callable. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Callable" /> - <description> - Returns [code]true[/code] if both [Callable]s invoke different targets. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Callable" /> - <description> - Returns [code]true[/code] if both [Callable]s invoke the same custom target. - </description> - </method> <method name="rpc" qualifiers="vararg const"> <return type="void" /> <description> @@ -168,4 +146,30 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Callable" /> + <description> + Returns [code]true[/code] if both [Callable]s invoke different targets. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Callable" /> + <description> + Returns [code]true[/code] if both [Callable]s invoke the same custom target. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index bd1f3af436..bb1a4a79f0 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -494,7 +494,6 @@ <member name="line_length_guidelines" type="int[]" setter="set_line_length_guidelines" getter="get_line_length_guidelines" default="[]"> Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently </member> - <member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" override="true" default="[]" /> <member name="symbol_lookup_on_click" type="bool" setter="set_symbol_lookup_on_click_enabled" getter="is_symbol_lookup_on_click_enabled" default="false"> Set when a validated word from [signal symbol_validate] is clicked, the [signal symbol_lookup] should be emitted. </member> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index c85bc775c7..71ec225cf6 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -15,21 +15,14 @@ <link title="Tween Demo">https://godotengine.org/asset-library/asset/146</link> <link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link> </tutorials> - <methods> - <method name="Color" qualifiers="constructor"> + <constructors> + <constructor name="Color"> <return type="Color" /> <description> Constructs a default-initialized [Color] with all components set to [code]0[/code]. </description> - </method> - <method name="Color" qualifiers="constructor"> - <return type="Color" /> - <argument index="0" name="from" type="Color" /> - <description> - Constructs a [Color] as a copy of the given [Color]. - </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="from" type="Color" /> <argument index="1" name="alpha" type="float" /> @@ -44,57 +37,66 @@ [/csharp] [/codeblocks] </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> + <return type="Color" /> + <argument index="0" name="from" type="Color" /> + <description> + Constructs a [Color] as a copy of the given [Color]. + </description> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="code" type="String" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="code" type="String" /> <argument index="1" name="alpha" type="float" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants. </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="r" type="float" /> <argument index="1" name="g" type="float" /> <argument index="2" name="b" type="float" /> - <argument index="3" name="a" type="float" /> <description> - Constructs a [Color] from RGBA values, typically between 0 and 1. + Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. [codeblocks] [gdscript] - var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` + var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)` [/gdscript] [csharp] - var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` + var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)` [/csharp] [/codeblocks] </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="r" type="float" /> <argument index="1" name="g" type="float" /> <argument index="2" name="b" type="float" /> + <argument index="3" name="a" type="float" /> <description> - Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. + Constructs a [Color] from RGBA values, typically between 0 and 1. [codeblocks] [gdscript] - var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)` + var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` [/gdscript] [csharp] - var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)` + var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` [/csharp] [/codeblocks] </description> - </method> + </constructor> + </constructors> + <methods> <method name="blend" qualifiers="const"> <return type="Color" /> <argument index="0" name="over" type="Color" /> @@ -259,92 +261,6 @@ [/codeblocks] </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Color" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Color" /> - <description> - </description> - </method> <method name="to_abgr32" qualifiers="const"> <return type="int" /> <description> @@ -937,4 +853,92 @@ Yellow green color. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator -"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + <operator name="operator unary+"> + <return type="Color" /> + <description> + </description> + </operator> + <operator name="operator unary-"> + <return type="Color" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index bab1a261ab..d661da5dd0 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -181,20 +181,22 @@ <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> - <methods> - <method name="Dictionary" qualifiers="constructor"> + <constructors> + <constructor name="Dictionary"> <return type="Dictionary" /> <description> Constructs an empty [Dictionary]. </description> - </method> - <method name="Dictionary" qualifiers="constructor"> + </constructor> + <constructor name="Dictionary"> <return type="Dictionary" /> <argument index="0" name="from" type="Dictionary" /> <description> Constructs a [Dictionary] as a copy of the given [Dictionary]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="clear"> <return type="void" /> <description> @@ -288,45 +290,47 @@ Returns the list of keys in the [Dictionary]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="size" qualifiers="const"> + <return type="int" /> <description> + Returns the number of keys in the dictionary. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Dictionary" /> + <method name="values" qualifiers="const"> + <return type="Array" /> <description> + Returns the list of values in the [Dictionary]. </description> </method> - <method name="operator ==" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Dictionary" /> <description> </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Variant" /> - <argument index="0" name="key" type="Variant" /> + </operator> + <operator name="operator =="> + <return type="bool" /> <description> </description> - </method> - <method name="size" qualifiers="const"> - <return type="int" /> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Dictionary" /> <description> - Returns the number of keys in the dictionary. </description> - </method> - <method name="values" qualifiers="const"> - <return type="Array" /> + </operator> + <operator name="operator []"> + <return type="Variant" /> + <argument index="0" name="key" type="Variant" /> <description> - Returns the list of values in the [Dictionary]. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 57f6e9547a..88c4689b5f 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -128,10 +128,10 @@ The bleed scale of the HDR glow. </member> <member name="glow_hdr_threshold" type="float" setter="set_glow_hdr_bleed_threshold" getter="get_glow_hdr_bleed_threshold" default="1.0"> - The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn't support HDR), this needs to be below [code]1.0[/code] for glow to be visible. A value of [code]0.9[/code] works well in this case. + The lower threshold of the HDR glow. When using the OpenGL renderer (which doesn't support HDR), this needs to be below [code]1.0[/code] for glow to be visible. A value of [code]0.9[/code] works well in this case. </member> <member name="glow_intensity" type="float" setter="set_glow_intensity" getter="get_glow_intensity" default="0.8"> - The overall brightness multiplier of the glow effect. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. + The overall brightness multiplier of the glow effect. When using the OpenGL renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. </member> <member name="glow_levels/1" type="float" setter="set_glow_level" getter="get_glow_level" default="0.0"> The intensity of the 1st level of glow. This is the most "local" level (least blurry). @@ -160,7 +160,7 @@ If [code]true[/code], glow levels will be normalized so that summed together their intensities equal [code]1.0[/code]. </member> <member name="glow_strength" type="float" setter="set_glow_strength" getter="get_glow_strength" default="1.0"> - The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. + The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the OpenGL renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. </member> <member name="reflected_light_source" type="int" setter="set_reflection_source" getter="get_reflection_source" enum="Environment.ReflectionSource" default="0"> </member> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 77fd9165bb..636ed368d1 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -68,11 +68,11 @@ </constant> <constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode"> Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges. - [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. + [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. </constant> <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode"> Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than [constant AXIS_STRETCH_MODE_STRETCH]. The texture must be seamless for this to work without displaying artifacts between edges. - [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. + [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. </constant> </constants> </class> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 17c6ba38b7..e2772a3ee0 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -25,21 +25,21 @@ <tutorials> <link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link> </tutorials> - <methods> - <method name="NodePath" qualifiers="constructor"> + <constructors> + <constructor name="NodePath"> <return type="NodePath" /> <description> Constructs an empty [NodePath]. </description> - </method> - <method name="NodePath" qualifiers="constructor"> + </constructor> + <constructor name="NodePath"> <return type="NodePath" /> <argument index="0" name="from" type="NodePath" /> <description> Constructs a [NodePath] as a copy of the given [NodePath]. </description> - </method> - <method name="NodePath" qualifiers="constructor"> + </constructor> + <constructor name="NodePath"> <return type="NodePath" /> <argument index="0" name="from" type="String" /> <description> @@ -61,7 +61,9 @@ "/root/Level/Path2D" [/codeblock] </description> - </method> + </constructor> + </constructors> + <methods> <method name="get_as_property_path" qualifiers="const"> <return type="NodePath" /> <description> @@ -166,27 +168,29 @@ Returns [code]true[/code] if the node path is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="NodePath" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="NodePath" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 15cc7b9b65..f4d48f5db2 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -31,12 +31,21 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> + <method name="create_instance"> + <return type="int" /> + <argument index="0" name="arguments" type="PackedStringArray" /> + <description> + Creates a new instance of Godot that runs independently. The [code]arguments[/code] are used in the given order and separated by a space. + If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. + [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. + </description> + </method> <method name="create_process"> <return type="int" /> <argument index="0" name="path" type="String" /> <argument index="1" name="arguments" type="PackedStringArray" /> <description> - Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. + Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. For example, running another instance of the project: [codeblocks] @@ -49,7 +58,7 @@ [/codeblocks] See [method execute] if you wish to run an external command and retrieve the results. [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. - [b]Note:[/b] On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export. + [b]Note:[/b] On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export or system .app bundle, system .app bundles will ignore arguments. </description> </method> <method name="delay_msec" qualifiers="const"> @@ -201,6 +210,7 @@ <return type="String" /> <description> Returns the path to the current engine executable. + [b]Note:[/b] On macOS, always use [method create_instance] instead of relying on executable path. </description> </method> <method name="get_granted_permissions" qualifiers="const"> @@ -455,11 +465,11 @@ </member> </members> <constants> - <constant name="VIDEO_DRIVER_GLES2" value="0" enum="VideoDriver"> - The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. + <constant name="VIDEO_DRIVER_VULKAN" value="0" enum="VideoDriver"> + The Vulkan rendering backend. It requires Vulkan 1.0 support and automatically uses features from Vulkan 1.1 and 1.2 if available. </constant> - <constant name="VIDEO_DRIVER_VULKAN" value="1" enum="VideoDriver"> - The Vulkan rendering backend. + <constant name="VIDEO_DRIVER_OPENGL_3" value="1" enum="VideoDriver"> + The OpenGL 3 rendering backend. It uses OpenGL 3.3 Core Profile on desktop platforms, OpenGL ES 3.0 on mobile devices, and WebGL 2.0 on HTML5. </constant> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> Sunday. diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 39733baf40..f951df1eb7 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedByteArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <description> Constructs an empty [PackedByteArray]. </description> - </method> - <method name="PackedByteArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <argument index="0" name="from" type="PackedByteArray" /> <description> Constructs a [PackedByteArray] as a copy of the given [PackedByteArray]. </description> - </method> - <method name="PackedByteArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -323,40 +325,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedByteArray" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -445,4 +413,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedByteArray" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 00e670646d..4aa8a19630 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedColorArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <description> Constructs an empty [PackedColorArray]. </description> - </method> - <method name="PackedColorArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <argument index="0" name="from" type="PackedColorArray" /> <description> Constructs a [PackedColorArray] as a copy of the given [PackedColorArray]. </description> - </method> - <method name="PackedColorArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Color" /> @@ -86,40 +88,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedColorArray" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Color" /> @@ -180,4 +148,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedColorArray" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Color" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 2ee2ac44df..68fb45a62a 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedFloat32Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <description> Constructs an empty [PackedFloat32Array]. </description> - </method> - <method name="PackedFloat32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <argument index="0" name="from" type="PackedFloat32Array" /> <description> Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array]. </description> - </method> - <method name="PackedFloat32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedFloat32Array" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedFloat32Array" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 7414bc72fc..740591a0c0 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedFloat64Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <description> Constructs an empty [PackedFloat64Array]. </description> - </method> - <method name="PackedFloat64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <argument index="0" name="from" type="PackedFloat64Array" /> <description> Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array]. </description> - </method> - <method name="PackedFloat64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedFloat64Array" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedFloat64Array" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index 8ecf4a70ae..7a01bb6c7c 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedInt32Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <description> Constructs an empty [PackedInt32Array]. </description> - </method> - <method name="PackedInt32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <argument index="0" name="from" type="PackedInt32Array" /> <description> Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array]. </description> - </method> - <method name="PackedInt32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedInt32Array" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedInt32Array" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index b82ce79009..c7b69d4ad5 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedInt64Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <description> Constructs an empty [PackedInt64Array]. </description> - </method> - <method name="PackedInt64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <argument index="0" name="from" type="PackedInt64Array" /> <description> Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array]. </description> - </method> - <method name="PackedInt64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedInt64Array" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedInt64Array" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 353bbfb827..dfebfb718b 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -9,27 +9,29 @@ <tutorials> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> - <methods> - <method name="PackedStringArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <description> Constructs an empty [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <argument index="0" name="from" type="PackedStringArray" /> <description> Constructs a [PackedStringArray] as a copy of the given [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="String" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedStringArray" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="String" /> @@ -181,4 +149,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedStringArray" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="String" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 7b7df221e7..bf9b7e97d4 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -9,27 +9,29 @@ <tutorials> <link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link> </tutorials> - <methods> - <method name="PackedVector2Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <description> Constructs an empty [PackedVector2Array]. </description> - </method> - <method name="PackedVector2Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <argument index="0" name="from" type="PackedVector2Array" /> <description> Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array]. </description> - </method> - <method name="PackedVector2Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Vector2" /> @@ -87,46 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Vector2" /> @@ -187,4 +149,46 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index efbf2169fd..b439f8f217 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedVector3Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <description> Constructs an empty [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="PackedVector3Array" /> <description> Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> @@ -86,46 +88,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> @@ -186,4 +148,46 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector3" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index 710e96239b..a9963d59e8 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -37,8 +37,12 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps the body's rotation if greater than [code]0[/code]. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. + See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. + </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="PhysicalBone3D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. </member> <member name="body_offset" type="Transform3D" setter="set_body_offset" getter="get_body_offset" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> Sets the body's transform. @@ -64,14 +68,24 @@ <member name="joint_type" type="int" setter="set_joint_type" getter="get_joint_type" enum="PhysicalBone3D.JointType" default="0"> Sets the joint type. See [enum JointType] for possible values. </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - Damps the body's movement if greater than [code]0[/code]. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. + See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. + </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="PhysicalBone3D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass" default="1.0"> The body's mass. </member> </members> <constants> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> <constant name="JOINT_TYPE_NONE" value="0" enum="JointType"> </constant> <constant name="JOINT_TYPE_PIN" value="1" enum="JointType"> diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index d55feff829..24a20b5613 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -926,15 +926,27 @@ <constant name="BODY_PARAM_GRAVITY_SCALE" value="5" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="6" enum="BodyParameter"> + <constant name="BODY_PARAM_LINEAR_DAMP_MODE" value="6" enum="BodyParameter"> + Constant to set/get a body's linear dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP_MODE" value="7" enum="BodyParameter"> + Constant to set/get a body's angular dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="8" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="7" enum="BodyParameter"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="9" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="8" enum="BodyParameter"> + <constant name="BODY_PARAM_MAX" value="10" enum="BodyParameter"> Represents the size of the [enum BodyParameter] enum. </constant> + <constant name="BODY_DAMP_MODE_COMBINE" value="0" enum="BodyDampMode"> + The body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="BODY_DAMP_MODE_REPLACE" value="1" enum="BodyDampMode"> + The body's damping value replaces any value set in areas or the default value. + </constant> <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 0e32d1defa..034bd55519 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -1294,15 +1294,27 @@ <constant name="BODY_PARAM_GRAVITY_SCALE" value="5" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="6" enum="BodyParameter"> + <constant name="BODY_PARAM_LINEAR_DAMP_MODE" value="6" enum="BodyParameter"> + Constant to set/get a body's linear dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP_MODE" value="7" enum="BodyParameter"> + Constant to set/get a body's angular dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="8" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="7" enum="BodyParameter"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="9" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="8" enum="BodyParameter"> + <constant name="BODY_PARAM_MAX" value="10" enum="BodyParameter"> Represents the size of the [enum BodyParameter] enum. </constant> + <constant name="BODY_DAMP_MODE_COMBINE" value="0" enum="BodyDampMode"> + The body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="BODY_DAMP_MODE_REPLACE" value="1" enum="BodyDampMode"> + The body's damping value replaces any value set in areas or the default value. + </constant> <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index f7a68e6a24..a20607d0a7 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -9,21 +9,21 @@ <tutorials> <link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> </tutorials> - <methods> - <method name="Plane" qualifiers="constructor"> + <constructors> + <constructor name="Plane"> <return type="Plane" /> <description> Constructs a default-initialized [Plane] with all components set to [code]0[/code]. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="from" type="Plane" /> <description> Constructs a [Plane] as a copy of the given [Plane]. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="a" type="float" /> <argument index="1" name="b" type="float" /> @@ -32,31 +32,31 @@ <description> Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="normal" type="Vector3" /> - <argument index="1" name="point" type="Vector3" /> <description> - Creates a plane from the normal vector and a point in the plane. + Creates a plane from the normal vector. The plane will intersect the origin. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="normal" type="Vector3" /> <argument index="1" name="d" type="float" /> <description> - Creates a plane from the normal vector and the plane's distance to the origin. + Creates a plane from the normal vector and the plane's distance from the origin. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="normal" type="Vector3" /> + <argument index="1" name="point" type="Vector3" /> <description> - Creates a plane from the normal vector. The plane will intersect the origin. + Creates a plane from the normal vector and a point on the plane. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="point1" type="Vector3" /> <argument index="1" name="point2" type="Vector3" /> @@ -64,7 +64,9 @@ <description> Creates a plane from the three points, given in clockwise order. </description> - </method> + </constructor> + </constructors> + <methods> <method name="center" qualifiers="const"> <return type="Vector3" /> <description> @@ -130,38 +132,6 @@ Returns a copy of the plane, normalized. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Plane" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Plane" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Plane" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Plane" /> - <description> - </description> - </method> <method name="project" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="point" type="Vector3" /> @@ -200,4 +170,38 @@ A plane that extends in the X and Y axes (normal vector points +Z). </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Plane" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Plane" /> + <description> + </description> + </operator> + <operator name="operator unary+"> + <return type="Plane" /> + <description> + </description> + </operator> + <operator name="operator unary-"> + <return type="Plane" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index e67ccf9efd..30409814d2 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1475,6 +1475,18 @@ The number of fixed iterations per second. This controls how often physics simulation and [method Node._physics_process] methods are run. [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. </member> + <member name="rendering/2d/opengl/batching_send_null" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/batching_stream" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/legacy_orphan_buffers" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/legacy_stream" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/options/ninepatch_mode" type="int" setter="" getter="" default="1"> + </member> + <member name="rendering/2d/options/use_software_skinning" type="bool" setter="" getter="" default="true"> + </member> <member name="rendering/2d/sdf/oversize" type="int" setter="" getter="" default="1"> </member> <member name="rendering/2d/sdf/scale" type="int" setter="" getter="" default="1"> @@ -1504,6 +1516,32 @@ </member> <member name="rendering/anti_aliasing/screen_space_roughness_limiter/limit" type="float" setter="" getter="" default="0.18"> </member> + <member name="rendering/batching/debug/diagnose_frame" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/debug/flash_batching" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/lights/max_join_items" type="int" setter="" getter="" default="32"> + </member> + <member name="rendering/batching/lights/scissor_area_threshold" type="float" setter="" getter="" default="1.0"> + </member> + <member name="rendering/batching/options/single_rect_fallback" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/options/use_batching" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/options/use_batching_in_editor" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/parameters/batch_buffer_size" type="int" setter="" getter="" default="16384"> + </member> + <member name="rendering/batching/parameters/colored_vertex_format_threshold" type="float" setter="" getter="" default="0.25"> + </member> + <member name="rendering/batching/parameters/item_reordering_lookahead" type="int" setter="" getter="" default="4"> + </member> + <member name="rendering/batching/parameters/max_join_item_commands" type="int" setter="" getter="" default="16"> + </member> + <member name="rendering/batching/precision/uv_contract" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/precision/uv_contract_amount" type="int" setter="" getter="" default="100"> + </member> <member name="rendering/camera/depth_of_field/depth_of_field_bokeh_quality" type="int" setter="" getter="" default="1"> Sets the quality of the depth of field effect. Higher quality takes more samples, which is slower but looks smoother. </member> @@ -1519,8 +1557,9 @@ <member name="rendering/driver/depth_prepass/enable" type="bool" setter="" getter="" default="true"> If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. </member> - <member name="rendering/driver/driver_name" type="String" setter="" getter="" default=""Vulkan""> - The video driver to use (currently only "Vulkan" is implemented). + <member name="rendering/driver/driver_name" type="String" setter="" getter="" default=""vulkan""> + The video driver to use. + [b]Note:[/b] OpenGL support is currently incomplete. Only basic 2D rendering is supported, and single-window mode is required for correct operation. [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--rendering-driver[/code] command line argument. [b]FIXME:[/b] No longer valid after DisplayServer split: In such cases, this property is not updated, so use [code]OS.get_current_video_driver[/code] to query it at run-time. @@ -1585,6 +1624,10 @@ <member name="rendering/environment/volumetric_fog/volume_size" type="int" setter="" getter="" default="64"> Base size used to determine size of froxel buffer in the camera X-axis and Y-axis. The final size is scaled by the aspect ratio of the screen, so actual values may differ from what is set. Set a larger size for more detailed fog, set a smaller size for better performance. </member> + <member name="rendering/gles2/compatibility/disable_half_float" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/gles2/compatibility/enable_high_float.Android" type="bool" setter="" getter="" default="false"> + </member> <member name="rendering/global_illumination/gi/use_half_resolution" type="bool" setter="" getter="" default="false"> </member> <member name="rendering/global_illumination/sdfgi/frames_to_converge" type="int" setter="" getter="" default="4"> diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 9c948ca21a..95b2316bf3 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -12,49 +12,49 @@ <link title="Using 3D transforms">https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> - <methods> - <method name="Quaternion" qualifiers="constructor"> + <constructors> + <constructor name="Quaternion"> <return type="Quaternion" /> <description> Constructs a default-initialized quaternion with all components set to [code]0[/code]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="from" type="Quaternion" /> <description> Constructs a [Quaternion] as a copy of the given [Quaternion]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="arc_from" type="Vector3" /> <argument index="1" name="arc_to" type="Vector3" /> <description> </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="axis" type="Vector3" /> <argument index="1" name="angle" type="float" /> <description> Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="euler_yxz" type="Vector3" /> <description> </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="from" type="Basis" /> <description> Constructs a quaternion from the given [Basis]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -63,7 +63,9 @@ <description> Constructs a quaternion defined by the given values. </description> - </method> + </constructor> + </constructors> + <methods> <method name="angle_to" qualifiers="const"> <return type="float" /> <argument index="0" name="to" type="Quaternion" /> @@ -142,131 +144,133 @@ Returns a copy of the quaternion, normalized to unit length. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="slerp" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="to" type="Quaternion" /> + <argument index="1" name="weight" type="float" /> <description> + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. + [b]Note:[/b] Both quaternions must be normalized. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <method name="slerpni" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="to" type="Quaternion" /> + <argument index="1" name="weight" type="float" /> <description> + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. </description> </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + </methods> + <members> + <member name="w" type="float" setter="" getter="" default="1.0"> + W component of the quaternion (real part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="x" type="float" setter="" getter="" default="0.0"> + X component of the quaternion (imaginary [code]i[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="y" type="float" setter="" getter="" default="0.0"> + Y component of the quaternion (imaginary [code]j[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="z" type="float" setter="" getter="" default="0.0"> + Z component of the quaternion (imaginary [code]k[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + </members> + <constants> + <constant name="IDENTITY" value="Quaternion(0, 0, 0, 1)"> + The identity quaternion, representing no rotation. Equivalent to an identity [Basis] matrix. If a vector is transformed by an identity quaternion, it will not change. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + </description> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Quaternion" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Quaternion" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Quaternion" /> <description> </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="float" /> <argument index="0" name="index" type="int" /> <description> </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Quaternion" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Quaternion" /> - <description> - </description> - </method> - <method name="slerp" qualifiers="const"> + </operator> + <operator name="operator unary+"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. - [b]Note:[/b] Both quaternions must be normalized. </description> - </method> - <method name="slerpni" qualifiers="const"> + </operator> + <operator name="operator unary-"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. </description> - </method> - </methods> - <members> - <member name="w" type="float" setter="" getter="" default="1.0"> - W component of the quaternion (real part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="x" type="float" setter="" getter="" default="0.0"> - X component of the quaternion (imaginary [code]i[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="y" type="float" setter="" getter="" default="0.0"> - Y component of the quaternion (imaginary [code]j[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="z" type="float" setter="" getter="" default="0.0"> - Z component of the quaternion (imaginary [code]k[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - </members> - <constants> - <constant name="IDENTITY" value="Quaternion(0, 0, 0, 1)"> - The identity quaternion, representing no rotation. Equivalent to an identity [Basis] matrix. If a vector is transformed by an identity quaternion, it will not change. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index b4ba74f7e5..695b0933fa 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -8,71 +8,75 @@ </description> <tutorials> </tutorials> - <methods> - <method name="RID" qualifiers="constructor"> + <constructors> + <constructor name="RID"> <return type="RID" /> <description> Constructs an empty [RID] with the invalid ID [code]0[/code]. </description> - </method> - <method name="RID" qualifiers="constructor"> + </constructor> + <constructor name="RID"> <return type="RID" /> <argument index="0" name="from" type="RID" /> <description> Constructs a [RID] as a copy of the given [RID]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="get_id" qualifiers="const"> <return type="int" /> <description> Returns the ID of the referenced resource. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index a6bb81b589..01bec10ed8 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -13,36 +13,36 @@ <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> </tutorials> - <methods> - <method name="Rect2" qualifiers="constructor"> + <constructors> + <constructor name="Rect2"> <return type="Rect2" /> <description> Constructs a default-initialized [Rect2] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="from" type="Rect2" /> <description> Constructs a [Rect2] as a copy of the given [Rect2]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2] from a [Rect2i]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="position" type="Vector2" /> <argument index="1" name="size" type="Vector2" /> <description> Constructs a [Rect2] by position and size. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -51,7 +51,9 @@ <description> Constructs a [Rect2] by x, y, width, and height. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Rect2" /> <description> @@ -153,45 +155,47 @@ Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Rect2" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Rect2" /> <argument index="0" name="right" type="Transform2D" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Rect2" /> <description> </description> - </method> - </methods> - <members> - <member name="end" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 0ba013cade..fc27c64fa5 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -11,36 +11,36 @@ <link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> </tutorials> - <methods> - <method name="Rect2i" qualifiers="constructor"> + <constructors> + <constructor name="Rect2i"> <return type="Rect2i" /> <description> Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2i] as a copy of the given [Rect2i]. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="from" type="Rect2" /> <description> Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="position" type="Vector2i" /> <argument index="1" name="size" type="Vector2i" /> <description> Constructs a [Rect2i] by position and size. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> @@ -49,7 +49,9 @@ <description> Constructs a [Rect2i] by x, y, width, and height. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Rect2i" /> <description> @@ -144,39 +146,41 @@ Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Rect2i" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Rect2i" /> <description> </description> - </method> - </methods> - <members> - <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml index f503884192..b8680b99b3 100644 --- a/doc/classes/RigidDynamicBody2D.xml +++ b/doc/classes/RigidDynamicBody2D.xml @@ -82,10 +82,13 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps the body's [member angular_velocity]. If [code]-1[/code], the body will use the [b]Default Angular Damp[/b] defined in [b]Project > Project Settings > Physics > 2d[/b]. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b] or any value override set by an [Area2D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="RigidDynamicBody2D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity" default="0.0"> The body's rotational velocity. </member> @@ -135,10 +138,13 @@ The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. If set to [code]0[/code], inertia is automatically computed (default value). </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b] or any value override set by an [Area2D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="RigidDynamicBody2D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector2(0, 0)"> The body's linear velocity. </member> @@ -217,6 +223,12 @@ <constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode"> In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position. </constant> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> <constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode"> Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml index 6c8d190704..ba9acdf4bf 100644 --- a/doc/classes/RigidDynamicBody3D.xml +++ b/doc/classes/RigidDynamicBody3D.xml @@ -91,10 +91,13 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps RigidDynamicBody3D's rotational forces. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="RigidDynamicBody3D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)"> RigidDynamicBody3D's rotational velocity. </member> @@ -138,10 +141,13 @@ The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body on each axis. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. If set to [code]Vector3.ZERO[/code], inertia is automatically computed (default value). </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - The body's linear damp. Cannot be less than -1.0. If this value is different from -1.0, any linear damp derived from the world or areas will be overridden. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="RigidDynamicBody3D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)"> The body's linear velocity. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. </member> @@ -222,5 +228,11 @@ <constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode"> In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position. </constant> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> </constants> </class> diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index f78266a20c..79d6ba8768 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -7,28 +7,30 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Signal" qualifiers="constructor"> + <constructors> + <constructor name="Signal"> <return type="Signal" /> <description> Constructs a null [Signal] with no object nor signal name bound. </description> - </method> - <method name="Signal" qualifiers="constructor"> + </constructor> + <constructor name="Signal"> <return type="Signal" /> <argument index="0" name="from" type="Signal" /> <description> Constructs a [Signal] as a copy of the given [Signal]. </description> - </method> - <method name="Signal" qualifiers="constructor"> + </constructor> + <constructor name="Signal"> <return type="Signal" /> <argument index="0" name="object" type="Object" /> <argument index="1" name="signal" type="StringName" /> <description> Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="connect"> <return type="int" /> <argument index="0" name="callable" type="Callable" /> @@ -93,27 +95,29 @@ <description> </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Signal" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Signal" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index abb68e0d05..1190d90190 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -9,34 +9,36 @@ <tutorials> <link title="GDScript format strings">https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_format_string.html</link> </tutorials> - <methods> - <method name="String" qualifiers="constructor"> + <constructors> + <constructor name="String"> <return type="String" /> <description> Constructs an empty [String] ([code]""[/code]). </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="String" /> <description> Constructs a [String] as a copy of the given [String]. </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="NodePath" /> <description> Constructs a new String from the given [NodePath]. </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="StringName" /> <description> Constructs a new String from the given [StringName]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="begins_with" qualifiers="const"> <return type="bool" /> <argument index="0" name="text" type="String" /> @@ -443,82 +445,6 @@ <description> </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="StringName" /> - <description> - </description> - </method> - <method name="operator %" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="right" type="Variant" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="StringName" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="pad_decimals" qualifiers="const"> <return type="String" /> <argument index="0" name="digits" type="int" /> @@ -843,4 +769,82 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + <operator name="operator %"> + <return type="String" /> + <argument index="0" name="right" type="Variant" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="String" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="String" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 113195d91c..b32665a09f 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -8,60 +8,62 @@ </description> <tutorials> </tutorials> - <methods> - <method name="StringName" qualifiers="constructor"> + <constructors> + <constructor name="StringName"> <return type="StringName" /> <description> Constructs an empty [StringName]. </description> - </method> - <method name="StringName" qualifiers="constructor"> + </constructor> + <constructor name="StringName"> <return type="StringName" /> <argument index="0" name="from" type="StringName" /> <description> Constructs a [StringName] as a copy of the given [StringName]. </description> - </method> - <method name="StringName" qualifiers="constructor"> + </constructor> + <constructor name="StringName"> <return type="StringName" /> <argument index="0" name="from" type="String" /> <description> Creates a new [StringName] from the given [String]. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="String" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="StringName" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="String" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="StringName" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index d64752a00f..ab7632e08e 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -13,29 +13,29 @@ <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Transform2D" qualifiers="constructor"> + <constructors> + <constructor name="Transform2D"> <return type="Transform2D" /> <description> Constructs a default-initialized [Transform2D] set to [constant IDENTITY]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="from" type="Transform2D" /> <description> Constructs a [Transform2D] as a copy of the given [Transform2D]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="rotation" type="float" /> <argument index="1" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="rotation" type="float" /> <argument index="1" name="scale" type="Vector2" /> @@ -44,8 +44,8 @@ <description> Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="x_axis" type="Vector2" /> <argument index="1" name="y_axis" type="Vector2" /> @@ -53,7 +53,9 @@ <description> Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). </description> - </method> + </constructor> + </constructors> + <methods> <method name="affine_inverse" qualifiers="const"> <return type="Transform2D" /> <description> @@ -129,72 +131,6 @@ Operations take place in global space. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Rect2" /> - <argument index="0" name="right" type="Rect2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Transform2D" /> <description> @@ -267,4 +203,72 @@ The [Transform2D] that will flip something along the Y axis. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Rect2" /> + <argument index="0" name="right" type="Rect2" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 63a7746328..8c4965abb4 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -15,29 +15,29 @@ <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Transform3D" qualifiers="constructor"> + <constructors> + <constructor name="Transform3D"> <return type="Transform3D" /> <description> Constructs a default-initialized [Transform3D] set to [constant IDENTITY]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="from" type="Transform3D" /> <description> Constructs a [Transform3D] as a copy of the given [Transform3D]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="basis" type="Basis" /> <argument index="1" name="origin" type="Vector3" /> <description> Constructs a Transform3D from a [Basis] and [Vector3]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="x_axis" type="Vector3" /> <argument index="1" name="y_axis" type="Vector3" /> @@ -46,7 +46,9 @@ <description> Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). </description> - </method> + </constructor> + </constructors> + <methods> <method name="affine_inverse" qualifiers="const"> <return type="Transform3D" /> <description> @@ -83,66 +85,6 @@ The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="AABB" /> - <argument index="0" name="right" type="AABB" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Transform3D" /> <description> @@ -195,4 +137,66 @@ [Transform3D] with mirroring applied perpendicular to the XY plane. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="AABB" /> + <argument index="0" name="right" type="AABB" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 488a5aa340..05c83f0423 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -74,17 +74,17 @@ </method> <method name="interpolate_value"> <return type="Variant" /> - <argument index="0" name="trans_type" type="Variant" /> - <argument index="1" name="ease_type" type="Variant" /> + <argument index="0" name="initial_value" type="Variant" /> + <argument index="1" name="delta_value" type="Variant" /> <argument index="2" name="elapsed_time" type="float" /> - <argument index="3" name="initial_value" type="float" /> - <argument index="4" name="delta_value" type="int" enum="Tween.TransitionType" /> - <argument index="5" name="duration" type="int" enum="Tween.EaseType" /> + <argument index="3" name="duration" type="float" /> + <argument index="4" name="trans_type" type="int" enum="Tween.TransitionType" /> + <argument index="5" name="ease_type" type="int" enum="Tween.EaseType" /> <description> This method can be used for manual interpolation of a value, when you don't want [Tween] to do animating for you. It's similar to [method @GlobalScope.lerp], but with support for custom transition and easing. - [code]elapsed_time[/code] is the time in seconds that passed after the interping started and it's used to control the position of the interpolation. E.g. when it's equal to half of the [code]duration[/code], the interpolated value will be halfway between initial and final values. This value can also be greater than [code]duration[/code] or lower than 0, which will extrapolate the value. [code]initial_value[/code] is the starting value of the interpolation. [code]delta_value[/code] is the change of the value in the interpolation, i.e. it's equal to [code]final_value - initial_value[/code]. + [code]elapsed_time[/code] is the time in seconds that passed after the interpolation started and it's used to control the position of the interpolation. E.g. when it's equal to half of the [code]duration[/code], the interpolated value will be halfway between initial and final values. This value can also be greater than [code]duration[/code] or lower than 0, which will extrapolate the value. [code]duration[/code] is the total time of the interpolation. [b]Note:[/b] If [code]duration[/code] is equal to [code]0[/code], the method will always return the final value, regardless of [code]elapsed_time[/code] provided. </description> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 4035fb0ad2..eaaf41561a 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -16,35 +16,37 @@ <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link> </tutorials> - <methods> - <method name="Vector2" qualifiers="constructor"> + <constructors> + <constructor name="Vector2"> <return type="Vector2" /> <description> Constructs a default-initialized [Vector2] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="from" type="Vector2" /> <description> Constructs a [Vector2] as a copy of the given [Vector2]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="from" type="Vector2i" /> <description> Constructs a new [Vector2] from [Vector2i]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> <description> Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector2" /> <description> @@ -225,122 +227,6 @@ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Vector2" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Vector2" /> - <description> - </description> - </method> <method name="orthogonal" qualifiers="const"> <return type="Vector2" /> <description> @@ -455,4 +341,122 @@ Down unit vector. Y is down in 2D, so this vector points +Y. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator -"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + <operator name="operator unary+"> + <return type="Vector2" /> + <description> + </description> + </operator> + <operator name="operator unary-"> + <return type="Vector2" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index 52fd8c6780..71882e5b0c 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -13,35 +13,37 @@ <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> </tutorials> - <methods> - <method name="Vector2i" qualifiers="constructor"> + <constructors> + <constructor name="Vector2i"> <return type="Vector2i" /> <description> Constructs a default-initialized [Vector2i] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="from" type="Vector2i" /> <description> Constructs a [Vector2i] as a copy of the given [Vector2i]. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="from" type="Vector2" /> <description> Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> <description> Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector2i" /> <description> @@ -62,167 +64,169 @@ Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="sign" qualifiers="const"> + <return type="Vector2i" /> <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="x" type="int" setter="" getter="" default="0"> + The vector's X component. Also accessible by using the index position [code][0][/code]. + </member> + <member name="y" type="int" setter="" getter="" default="0"> + The vector's Y component. Also accessible by using the index position [code][1][/code]. + </member> + </members> + <constants> + <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. + </constant> + <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. + </constant> + <constant name="ZERO" value="Vector2i(0, 0)"> + Zero vector, a vector with all components set to [code]0[/code]. + </constant> + <constant name="ONE" value="Vector2i(1, 1)"> + One vector, a vector with all components set to [code]1[/code]. + </constant> + <constant name="LEFT" value="Vector2i(-1, 0)"> + Left unit vector. Represents the direction of left. + </constant> + <constant name="RIGHT" value="Vector2i(1, 0)"> + Right unit vector. Represents the direction of right. + </constant> + <constant name="UP" value="Vector2i(0, -1)"> + Up unit vector. Y is down in 2D, so this vector points -Y. + </constant> + <constant name="DOWN" value="Vector2i(0, 1)"> + Down unit vector. Y is down in 2D, so this vector points +Y. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="int" /> <argument index="0" name="index" type="int" /> <description> </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="Vector2i" /> <description> </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="Vector2i" /> <description> </description> - </method> - <method name="sign" qualifiers="const"> - <return type="Vector2i" /> - <description> - Returns the vector with each component set to one or negative one, depending on the signs of the components. - </description> - </method> - </methods> - <members> - <member name="x" type="int" setter="" getter="" default="0"> - The vector's X component. Also accessible by using the index position [code][0][/code]. - </member> - <member name="y" type="int" setter="" getter="" default="0"> - The vector's Y component. Also accessible by using the index position [code][1][/code]. - </member> - </members> - <constants> - <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. - </constant> - <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. - </constant> - <constant name="ZERO" value="Vector2i(0, 0)"> - Zero vector, a vector with all components set to [code]0[/code]. - </constant> - <constant name="ONE" value="Vector2i(1, 1)"> - One vector, a vector with all components set to [code]1[/code]. - </constant> - <constant name="LEFT" value="Vector2i(-1, 0)"> - Left unit vector. Represents the direction of left. - </constant> - <constant name="RIGHT" value="Vector2i(1, 0)"> - Right unit vector. Represents the direction of right. - </constant> - <constant name="UP" value="Vector2i(0, -1)"> - Up unit vector. Y is down in 2D, so this vector points -Y. - </constant> - <constant name="DOWN" value="Vector2i(0, 1)"> - Down unit vector. Y is down in 2D, so this vector points +Y. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 078ba1e1a4..a94cc0086f 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -16,28 +16,28 @@ <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link> </tutorials> - <methods> - <method name="Vector3" qualifiers="constructor"> + <constructors> + <constructor name="Vector3"> <return type="Vector3" /> <description> Constructs a default-initialized [Vector3] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="from" type="Vector3" /> <description> Constructs a [Vector3] as a copy of the given [Vector3]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="from" type="Vector3i" /> <description> Constructs a new [Vector3] from [Vector3i]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -45,7 +45,9 @@ <description> Returns a [Vector3] with the given components. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector3" /> <description> @@ -219,134 +221,6 @@ <description> </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Vector3" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Vector3" /> - <description> - </description> - </method> <method name="outer" qualifiers="const"> <return type="Basis" /> <argument index="0" name="with" type="Vector3" /> @@ -483,4 +357,134 @@ Back unit vector. Represents the local direction of back, and the global direction of south. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Basis" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator -"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + <operator name="operator unary+"> + <return type="Vector3" /> + <description> + </description> + </operator> + <operator name="operator unary-"> + <return type="Vector3" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index 2a7ee1ffb8..5cd458a2be 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -13,28 +13,28 @@ <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> </tutorials> - <methods> - <method name="Vector3i" qualifiers="constructor"> + <constructors> + <constructor name="Vector3i"> <return type="Vector3i" /> <description> Constructs a default-initialized [Vector3i] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="from" type="Vector3i" /> <description> Constructs a [Vector3i] as a copy of the given [Vector3i]. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="from" type="Vector3" /> <description> Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> @@ -42,7 +42,9 @@ <description> Returns a [Vector3i] with the given components. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector3i" /> <description> @@ -68,179 +70,181 @@ Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="sign" qualifiers="const"> + <return type="Vector3i" /> <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="x" type="int" setter="" getter="" default="0"> + The vector's X component. Also accessible by using the index position [code][0][/code]. + </member> + <member name="y" type="int" setter="" getter="" default="0"> + The vector's Y component. Also accessible by using the index position [code][1][/code]. + </member> + <member name="z" type="int" setter="" getter="" default="0"> + The vector's Z component. Also accessible by using the index position [code][2][/code]. + </member> + </members> + <constants> + <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. + </constant> + <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. + </constant> + <constant name="AXIS_Z" value="2"> + Enumerated value for the Z axis. + </constant> + <constant name="ZERO" value="Vector3i(0, 0, 0)"> + Zero vector, a vector with all components set to [code]0[/code]. + </constant> + <constant name="ONE" value="Vector3i(1, 1, 1)"> + One vector, a vector with all components set to [code]1[/code]. + </constant> + <constant name="LEFT" value="Vector3i(-1, 0, 0)"> + Left unit vector. Represents the local direction of left, and the global direction of west. + </constant> + <constant name="RIGHT" value="Vector3i(1, 0, 0)"> + Right unit vector. Represents the local direction of right, and the global direction of east. + </constant> + <constant name="UP" value="Vector3i(0, 1, 0)"> + Up unit vector. + </constant> + <constant name="DOWN" value="Vector3i(0, -1, 0)"> + Down unit vector. + </constant> + <constant name="FORWARD" value="Vector3i(0, 0, -1)"> + Forward unit vector. Represents the local direction of forward, and the global direction of north. + </constant> + <constant name="BACK" value="Vector3i(0, 0, 1)"> + Back unit vector. Represents the local direction of back, and the global direction of south. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="float" /> <description> </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="int" /> <argument index="0" name="index" type="int" /> <description> </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="Vector3i" /> <description> </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="Vector3i" /> <description> </description> - </method> - <method name="sign" qualifiers="const"> - <return type="Vector3i" /> - <description> - Returns the vector with each component set to one or negative one, depending on the signs of the components. - </description> - </method> - </methods> - <members> - <member name="x" type="int" setter="" getter="" default="0"> - The vector's X component. Also accessible by using the index position [code][0][/code]. - </member> - <member name="y" type="int" setter="" getter="" default="0"> - The vector's Y component. Also accessible by using the index position [code][1][/code]. - </member> - <member name="z" type="int" setter="" getter="" default="0"> - The vector's Z component. Also accessible by using the index position [code][2][/code]. - </member> - </members> - <constants> - <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. - </constant> - <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. - </constant> - <constant name="AXIS_Z" value="2"> - Enumerated value for the Z axis. - </constant> - <constant name="ZERO" value="Vector3i(0, 0, 0)"> - Zero vector, a vector with all components set to [code]0[/code]. - </constant> - <constant name="ONE" value="Vector3i(1, 1, 1)"> - One vector, a vector with all components set to [code]1[/code]. - </constant> - <constant name="LEFT" value="Vector3i(-1, 0, 0)"> - Left unit vector. Represents the local direction of left, and the global direction of west. - </constant> - <constant name="RIGHT" value="Vector3i(1, 0, 0)"> - Right unit vector. Represents the local direction of right, and the global direction of east. - </constant> - <constant name="UP" value="Vector3i(0, 1, 0)"> - Up unit vector. - </constant> - <constant name="DOWN" value="Vector3i(0, -1, 0)"> - Down unit vector. - </constant> - <constant name="FORWARD" value="Vector3i(0, 0, -1)"> - Forward unit vector. Represents the local direction of forward, and the global direction of north. - </constant> - <constant name="BACK" value="Vector3i(0, 0, 1)"> - Back unit vector. Represents the local direction of back, and the global direction of south. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 39e34a7b96..49f2d2dd7f 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -91,71 +91,74 @@ </description> <tutorials> </tutorials> - <methods> - <method name="bool" qualifiers="constructor"> + <constructors> + <constructor name="bool"> <return type="bool" /> <description> Constructs a default-initialized [bool] set to [code]false[/code]. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="bool" /> <description> Constructs a [bool] as a copy of the given [bool]. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="float" /> <description> Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="int" /> <description> Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> - Returns [code]true[/code] if left operand is [code]false[/code] and right operand is [code]true[/code]. + Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> + Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> - Returns [code]true[/code] if left operand is [code]true[/code] and right operand is [code]false[/code]. + Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code]. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index b45cdd2099..8231173bac 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -12,61 +12,70 @@ <link title="Wikipedia: Double-precision floating-point format">https://en.wikipedia.org/wiki/Double-precision_floating-point_format</link> <link title="Wikipedia: Single-precision floating-point format">https://en.wikipedia.org/wiki/Single-precision_floating-point_format</link> </tutorials> - <methods> - <method name="float" qualifiers="constructor"> + <constructors> + <constructor name="float"> <return type="float" /> <description> Constructs a default-initialized [float] set to [code]0.0[/code]. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="float" /> <description> Constructs a [float] as a copy of the given [float]. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="int" /> <description> Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if two floats are different from each other. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the integer has different value than the float. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Multiplies two [float]s. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + Multiplies each component of the [Quaternion] by the given [float]. + </description> + </operator> + <operator name="operator *"> <return type="Vector2" /> <argument index="0" name="right" type="Vector2" /> <description> @@ -75,8 +84,8 @@ print(2.5 * Vector2(1, 1)) # Vector2(2.5, 2.5) [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> @@ -85,29 +94,22 @@ print(2.0 * Vector2i(1, 1)) # Vector2i(2.0, 2.0) [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3" /> <argument index="0" name="right" type="Vector3" /> <description> Multiplies each component of the [Vector3] by the given [float]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> Multiplies each component of the [Vector3i] by the given [float]. </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - Multiplies each component of the [Quaternion] by the given [float]. - </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Color" /> <argument index="0" name="right" type="Color" /> <description> @@ -116,143 +118,143 @@ print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75) [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Multiplies a [float] and an [int]. The result is a [float]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Adds two floats. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Adds a [float] and an [int]. The result is a [float]. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Subtracts a float from a float. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Subtracts an [int] from a [float]. The result is a [float]. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Divides two floats. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Divides a [float] by an [int]. The result is a [float]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is less than the right one. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than the given [int]. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than or equal to the given [int]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if both floats are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the [float] and the given [int] are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than the right one. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than the given [int]. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than or equal to the right one. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than or equal to the given [int]. </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="float" /> <description> Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="float" /> <description> Returns the negative value of the [float]. If positive, turns the number negative. If negative, turns the number positive. With floats, the number zero can be either positive or negative. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index a75d11ba4a..94c2601e4a 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -38,54 +38,56 @@ </description> <tutorials> </tutorials> - <methods> - <method name="int" qualifiers="constructor"> + <constructors> + <constructor name="int"> <return type="int" /> <description> Constructs a default-initialized [int] set to [code]0[/code]. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="int" /> <description> Constructs an [int] as a copy of the given [int]. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="float" /> <description> Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if operands are different from each other. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if operands are different from each other. </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -96,8 +98,8 @@ print(12 % 2) # 2 [/codeblock] </description> - </method> - <method name="operator &" qualifiers="operator"> + </operator> + <operator name="operator &"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -114,98 +116,93 @@ do_stuff() [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + </description> + </operator> + <operator name="operator *"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> Multiplies two [int]s. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Multiplies an [int] and a [float]. The result is a [float]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2" /> <argument index="0" name="right" type="Vector2" /> <description> - Multiplies each component of the vector by the given integer. + Multiplies each component of the [Vector2] by the given [int]. [codeblock] print(2 * Vector2(1, 1)) # Vector2(2, 2) [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> - Multiplies each component of the integer vector by the given integer. + Multiplies each component of the [Vector2i] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3" /> <argument index="0" name="right" type="Vector3" /> <description> - Multiplies each component of the vector by the given integer. + Multiplies each component of the [Vector3] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> - Multiplies each component of the integer vector by the given integer. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - Multiplies each component of the quaternion by the given integer. + Multiplies each component of the [Vector3i] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> + </operator> + <operator name="operator +"> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> - Multiplies each component of the color by the given integer. - [codeblock] - print(2 * Color(0.5, 0.5, 0.5)) # Color(1, 1, 1) - [/codeblock] + Adds an [int] and a [float]. The result is a [float]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> Adds two integers. </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="right" type="float" /> - <description> - Adds an [int] to a [float]. The result is a [float]. - </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Subtracts a [float] from an [int]. The result is a [float]. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> Subtracts two integers. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> @@ -214,8 +211,8 @@ print(10 / 3.0) # 3.333... [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -225,22 +222,22 @@ print(10 / 3) # 3 [/codeblock] </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than the given [float]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than the right one. </description> - </method> - <method name="operator <<" qualifiers="operator"> + </operator> + <operator name="operator <<"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -250,69 +247,69 @@ print(10 << 4) # 160 [/codeblock] </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than or equal to the given [float]. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if the integer is equal to the given [float]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if both integers are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than the given [float]. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than the right one. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than or equal to the given [float]. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than or equal to the right one. </description> - </method> - <method name="operator >>" qualifiers="operator"> + </operator> + <operator name="operator >>"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -322,8 +319,8 @@ print(10 >> 2) # 2 [/codeblock] </description> - </method> - <method name="operator ^" qualifiers="operator"> + </operator> + <operator name="operator ^"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -333,20 +330,20 @@ print(4 ^ 7) # 3 [/codeblock] </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="int" /> <description> Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="int" /> <description> Returns the negated value of the [int]. If positive, turns the number negative. If negative, turns the number positive. If zero, does nothing. </description> - </method> - <method name="operator |" qualifiers="operator"> + </operator> + <operator name="operator |"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -363,8 +360,8 @@ flags |= 4 [/codeblock] </description> - </method> - <method name="operator ~" qualifiers="operator"> + </operator> + <operator name="operator ~"> <return type="int" /> <description> Returns the result of bitwise [code]NOT[/code] operation for the integer. It's effectively equal to [code]-int + 1[/code]. @@ -373,6 +370,6 @@ print(~7) # -6 [/codeblock] </description> - </method> - </methods> + </operator> + </operators> </class> |