Merge pull request #53452 from aaronfranke/who-let-the-docs-out

This commit is contained in:
Rémi Verschelde 2021-10-31 23:18:32 +01:00 committed by GitHub
commit 1dd742777a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
40 changed files with 2511 additions and 2232 deletions

View file

@ -140,7 +140,9 @@ public:
String brief_description;
String description;
Vector<TutorialDoc> tutorials;
Vector<MethodDoc> constructors;
Vector<MethodDoc> methods;
Vector<MethodDoc> operators;
Vector<MethodDoc> signals;
Vector<ConstantDoc> constants;
Map<String, String> enums;

View file

@ -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,34 +195,6 @@
Returns a larger [AABB] that contains both this [AABB] and [code]with[/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="AABB" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
<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="AABB" />
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
@ -234,4 +208,34 @@
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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 &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &lt;=" 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 &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &gt;=" 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 &lt;">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<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 &gt;">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<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>

View file

@ -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>

View file

@ -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>

View file

@ -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,23 +37,47 @@
[/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" />
<description>
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) # Similar to `Color8(51, 255, 178, 255)`
[/gdscript]
[csharp]
var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
[/csharp]
[/codeblocks]
</description>
</constructor>
<constructor name="Color">
<return type="Color" />
<argument index="0" name="r" type="float" />
<argument index="1" name="g" type="float" />
@ -77,24 +94,9 @@
[/csharp]
[/codeblocks]
</description>
</method>
<method name="Color" qualifiers="constructor">
<return type="Color" />
<argument index="0" name="r" type="float" />
<argument index="1" name="g" type="float" />
<argument index="2" name="b" type="float" />
<description>
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) # Similar to `Color8(51, 255, 178, 255)`
[/gdscript]
[csharp]
var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
[/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>

View file

@ -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,34 +290,6 @@
Returns the list of keys in the [Dictionary].
</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="Dictionary" />
<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="Dictionary" />
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Variant" />
<argument index="0" name="key" type="Variant" />
<description>
</description>
</method>
<method name="size" qualifiers="const">
<return type="int" />
<description>
@ -329,4 +303,34 @@
</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="Dictionary" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Dictionary" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="Variant" />
<argument index="0" name="key" type="Variant" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="NodePath" />
<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="NodePath" />
<description>
</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="NodePath" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="NodePath" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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">
<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.
</description>
</method>
<method name="Plane" qualifiers="constructor">
<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.
</description>
</method>
<method name="Plane" qualifiers="constructor">
</constructor>
<constructor name="Plane">
<return type="Plane" />
<argument index="0" name="normal" type="Vector3" />
<description>
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 from the origin.
</description>
</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 on the plane.
</description>
</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>

View file

@ -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,92 +144,6 @@
Returns a copy of the quaternion, normalized to unit length.
</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="Quaternion" />
<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="Quaternion" />
<argument index="0" name="right" type="Quaternion" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="Quaternion" />
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="Quaternion" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Quaternion" />
<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="Quaternion" />
<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="Quaternion" />
<description>
</description>
</method>
<method name="operator unary-" qualifiers="operator">
<return type="Quaternion" />
<description>
</description>
</method>
<method name="slerp" qualifiers="const">
<return type="Quaternion" />
<argument index="0" name="to" type="Quaternion" />
@ -269,4 +185,92 @@
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>
</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>
</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>
</operator>
<operator name="operator *">
<return type="Quaternion" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator +">
<return type="Quaternion" />
<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>
</operator>
<operator name="operator /">
<return type="Quaternion" />
<argument index="0" name="right" type="float" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Quaternion" />
<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="Quaternion" />
<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="Quaternion" />
<description>
</description>
</operator>
<operator name="operator unary-">
<return type="Quaternion" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<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="RID" />
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</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="RID" />
<description>
</description>
</operator>
<operator name="operator &lt;">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</operator>
<operator name="operator &gt;">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<return type="bool" />
<argument index="0" name="right" type="RID" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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,34 +155,6 @@
Returns a larger [Rect2] that contains this [Rect2] and [code]b[/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="Rect2" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Rect2" />
<argument index="0" name="right" type="Transform2D" />
<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="Rect2" />
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector2" setter="" getter="" default="Vector2(0, 0)">
@ -194,4 +168,34 @@
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Rect2" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Rect2" />
<argument index="0" name="right" type="Transform2D" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Rect2" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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,28 +146,6 @@
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/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="Rect2i" />
<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="Rect2i" />
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
@ -179,4 +159,28 @@
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Signal" />
<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="Signal" />
<description>
</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="Signal" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Signal" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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 &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="String" />
<description>
</description>
</method>
<method name="operator &lt;=" 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 &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="String" />
<description>
</description>
</method>
<method name="operator &gt;=" 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 &lt;">
<return type="bool" />
<argument index="0" name="right" type="String" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<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 &gt;">
<return type="bool" />
<argument index="0" name="right" type="String" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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 &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2" />
<description>
</description>
</method>
<method name="operator &lt;=" 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 &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2" />
<description>
</description>
</method>
<method name="operator &gt;=" 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 &lt;">
<return type="bool" />
<argument index="0" name="right" type="Vector2" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<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 &gt;">
<return type="bool" />
<argument index="0" name="right" type="Vector2" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<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>

View file

@ -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,128 +64,6 @@
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" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<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="Vector2i" />
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="operator unary+" qualifiers="operator">
<return type="Vector2i" />
<description>
</description>
</method>
<method name="operator unary-" qualifiers="operator">
<return type="Vector2i" />
<description>
</description>
</method>
<method name="sign" qualifiers="const">
<return type="Vector2i" />
<description>
@ -225,4 +105,128 @@
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>
</operator>
<operator name="operator %">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator %">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator +">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator -">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator &lt;">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator &gt;">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="int" />
<argument index="0" name="index" type="int" />
<description>
</description>
</operator>
<operator name="operator unary+">
<return type="Vector2i" />
<description>
</description>
</operator>
<operator name="operator unary-">
<return type="Vector2i" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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 &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</method>
<method name="operator &lt;=" 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 &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</method>
<method name="operator &gt;=" 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 &lt;">
<return type="bool" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<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 &gt;">
<return type="bool" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<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>

View file

@ -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,128 +70,6 @@
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" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<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="Vector3i" />
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="operator unary+" qualifiers="operator">
<return type="Vector3i" />
<description>
</description>
</method>
<method name="operator unary-" qualifiers="operator">
<return type="Vector3i" />
<description>
</description>
</method>
<method name="sign" qualifiers="const">
<return type="Vector3i" />
<description>
@ -243,4 +123,128 @@
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>
</operator>
<operator name="operator %">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator %">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector3i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator +">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator -">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector3i" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector3i" />
<argument index="0" name="right" type="float" />
<description>
</description>
</operator>
<operator name="operator /">
<return type="Vector3i" />
<argument index="0" name="right" type="int" />
<description>
</description>
</operator>
<operator name="operator &lt;">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator &gt;">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<return type="bool" />
<argument index="0" name="right" type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="int" />
<argument index="0" name="index" type="int" />
<description>
</description>
</operator>
<operator name="operator unary+">
<return type="Vector3i" />
<description>
</description>
</operator>
<operator name="operator unary-">
<return type="Vector3i" />
<description>
</description>
</operator>
</operators>
</class>

View file

@ -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 &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<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 &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<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>

View file

@ -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 &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<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 &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<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 &lt;=" qualifiers="operator">
</operator>
<operator name="operator &lt;=">
<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 &lt;=" qualifiers="operator">
</operator>
<operator name="operator &lt;=">
<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 &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<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 &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<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 &gt;=" qualifiers="operator">
</operator>
<operator name="operator &gt;=">
<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 &gt;=" qualifiers="operator">
</operator>
<operator name="operator &gt;=">
<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>

View file

@ -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 &amp;" qualifiers="operator">
</operator>
<operator name="operator &amp;">
<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.
Multiplies each component of the [Vector3i] by the given [int].
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quaternion" />
<argument index="0" name="right" type="Quaternion" />
</operator>
<operator name="operator +">
<return type="float" />
<argument index="0" name="right" type="float" />
<description>
Multiplies each component of the quaternion by the given integer.
Adds an [int] and a [float]. The result is a [float].
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color" />
<argument index="0" name="right" type="Color" />
<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]
</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 &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<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 &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<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 &lt;&lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;&lt;">
<return type="int" />
<argument index="0" name="right" type="int" />
<description>
@ -250,69 +247,69 @@
print(10 &lt;&lt; 4) # 160
[/codeblock]
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
</operator>
<operator name="operator &lt;=">
<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 &lt;=" qualifiers="operator">
</operator>
<operator name="operator &lt;=">
<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 &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<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 &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<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 &gt;=" qualifiers="operator">
</operator>
<operator name="operator &gt;=">
<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 &gt;=" qualifiers="operator">
</operator>
<operator name="operator &gt;=">
<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 &gt;&gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;&gt;">
<return type="int" />
<argument index="0" name="right" type="int" />
<description>
@ -322,8 +319,8 @@
print(10 &gt;&gt; 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>

View file

@ -57,25 +57,21 @@ void DocTools::merge_from(const DocTools &p_data) {
c.brief_description = cf.brief_description;
c.tutorials = cf.tutorials;
for (int i = 0; i < c.methods.size(); i++) {
DocData::MethodDoc &m = c.methods.write[i];
for (int i = 0; i < c.constructors.size(); i++) {
DocData::MethodDoc &m = c.constructors.write[i];
for (int j = 0; j < cf.methods.size(); j++) {
if (cf.methods[j].name != m.name) {
for (int j = 0; j < cf.constructors.size(); j++) {
if (cf.constructors[j].name != m.name) {
continue;
}
const char *operator_prefix = "operator "; // Operators use a space at the end, making this prefix an invalid identifier (and differentiating from methods).
if (cf.methods[j].name == c.name || cf.methods[j].name.begins_with(operator_prefix)) {
// Since constructors and operators can repeat, we need to check the type of
{
// Since constructors can repeat, we need to check the type of
// the arguments so we make sure they are different.
if (cf.methods[j].arguments.size() != m.arguments.size()) {
if (cf.constructors[j].arguments.size() != m.arguments.size()) {
continue;
}
int arg_count = cf.methods[j].arguments.size();
int arg_count = cf.constructors[j].arguments.size();
Vector<bool> arg_used;
arg_used.resize(arg_count);
for (int l = 0; l < arg_count; ++l) {
@ -85,7 +81,7 @@ void DocTools::merge_from(const DocTools &p_data) {
// have to check one by one so we make sure we have an exact match
for (int k = 0; k < arg_count; ++k) {
for (int l = 0; l < arg_count; ++l) {
if (cf.methods[j].arguments[k].type == m.arguments[l].type && !arg_used[l]) {
if (cf.constructors[j].arguments[k].type == m.arguments[l].type && !arg_used[l]) {
arg_used.write[l] = true;
break;
}
@ -102,6 +98,21 @@ void DocTools::merge_from(const DocTools &p_data) {
}
}
const DocData::MethodDoc &mf = cf.constructors[j];
m.description = mf.description;
break;
}
}
for (int i = 0; i < c.methods.size(); i++) {
DocData::MethodDoc &m = c.methods.write[i];
for (int j = 0; j < cf.methods.size(); j++) {
if (cf.methods[j].name != m.name) {
continue;
}
const DocData::MethodDoc &mf = cf.methods[j];
m.description = mf.description;
@ -165,6 +176,54 @@ void DocTools::merge_from(const DocTools &p_data) {
}
}
for (int i = 0; i < c.operators.size(); i++) {
DocData::MethodDoc &m = c.operators.write[i];
for (int j = 0; j < cf.operators.size(); j++) {
if (cf.operators[j].name != m.name) {
continue;
}
{
// Since operators can repeat, we need to check the type of
// the arguments so we make sure they are different.
if (cf.operators[j].arguments.size() != m.arguments.size()) {
continue;
}
int arg_count = cf.operators[j].arguments.size();
Vector<bool> arg_used;
arg_used.resize(arg_count);
for (int l = 0; l < arg_count; ++l) {
arg_used.write[l] = false;
}
// also there is no guarantee that argument ordering will match, so we
// have to check one by one so we make sure we have an exact match
for (int k = 0; k < arg_count; ++k) {
for (int l = 0; l < arg_count; ++l) {
if (cf.operators[j].arguments[k].type == m.arguments[l].type && !arg_used[l]) {
arg_used.write[l] = true;
break;
}
}
}
bool not_the_same = false;
for (int l = 0; l < arg_count; ++l) {
if (!arg_used[l]) { // at least one of the arguments was different
not_the_same = true;
}
}
if (not_the_same) {
continue;
}
}
const DocData::MethodDoc &mf = cf.operators[j];
m.description = mf.description;
break;
}
}
#ifndef MODULE_MONO_ENABLED
// The Mono module defines some properties that we want to keep when
// re-generating docs with a non-Mono build, to prevent pointless diffs
@ -650,11 +709,6 @@ void DocTools::generate(bool p_basic_types) {
DocData::MethodDoc method;
method.name = mi.name;
if (method.name == cname) {
method.qualifiers = "constructor";
} else if (method.name.begins_with("operator")) {
method.qualifiers = "operator";
}
for (int j = 0; j < mi.arguments.size(); j++) {
PropertyInfo arginfo = mi.arguments[j];
@ -694,7 +748,13 @@ void DocTools::generate(bool p_basic_types) {
method.qualifiers += "static";
}
c.methods.push_back(method);
if (method.name == cname) {
c.constructors.push_back(method);
} else if (method.name.begins_with("operator")) {
c.operators.push_back(method);
} else {
c.methods.push_back(method);
}
}
List<PropertyInfo> properties;
@ -916,7 +976,7 @@ static Error _parse_methods(Ref<XMLParser> &parser, Vector<DocData::MethodDoc> &
methods.push_back(method);
} else {
ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, "Invalid tag in doc file: " + parser->get_node_name() + ".");
ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, "Invalid tag in doc file: " + parser->get_node_name() + ", expected " + element + ".");
}
} else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == section) {
@ -1044,10 +1104,15 @@ Error DocTools::_load(Ref<XMLParser> parser) {
break; // End of <tutorials>.
}
}
} else if (name2 == "constructors") {
Error err2 = _parse_methods(parser, c.constructors);
ERR_FAIL_COND_V(err2, err2);
} else if (name2 == "methods") {
Error err2 = _parse_methods(parser, c.methods);
ERR_FAIL_COND_V(err2, err2);
} else if (name2 == "operators") {
Error err2 = _parse_methods(parser, c.operators);
ERR_FAIL_COND_V(err2, err2);
} else if (name2 == "signals") {
Error err2 = _parse_methods(parser, c.signals);
ERR_FAIL_COND_V(err2, err2);
@ -1269,6 +1334,8 @@ Error DocTools::save_classes(const String &p_default_path, const Map<String, Str
}
_write_string(f, 1, "</tutorials>");
_write_method_doc(f, "constructor", c.constructors);
_write_method_doc(f, "method", c.methods);
if (!c.properties.is_empty()) {
@ -1344,6 +1411,8 @@ Error DocTools::save_classes(const String &p_default_path, const Map<String, Str
_write_string(f, 1, "</theme_items>");
}
_write_method_doc(f, "operator", c.operators);
_write_string(f, 0, "</class>");
}

View file

@ -330,6 +330,153 @@ Error EditorHelp::_goto_desc(const String &p_class, int p_vscr) {
return OK;
}
void EditorHelp::_update_method_list(const Vector<DocData::MethodDoc> p_methods, bool &r_method_descrpitons) {
Ref<Font> doc_code_font = get_theme_font(SNAME("doc_source"), SNAME("EditorFonts"));
class_desc->pop();
class_desc->pop();
class_desc->add_newline();
class_desc->push_font(doc_code_font);
class_desc->push_indent(1);
class_desc->push_table(2);
class_desc->set_table_column_expand(1, true);
bool any_previous = false;
for (int pass = 0; pass < 2; pass++) {
Vector<DocData::MethodDoc> m;
for (int i = 0; i < p_methods.size(); i++) {
const String &q = p_methods[i].qualifiers;
if ((pass == 0 && q.find("virtual") != -1) || (pass == 1 && q.find("virtual") == -1)) {
m.push_back(p_methods[i]);
}
}
if (any_previous && !m.is_empty()) {
class_desc->push_cell();
class_desc->pop(); //cell
class_desc->push_cell();
class_desc->pop(); //cell
}
String group_prefix;
for (int i = 0; i < m.size(); i++) {
const String new_prefix = m[i].name.substr(0, 3);
bool is_new_group = false;
if (i < m.size() - 1 && new_prefix == m[i + 1].name.substr(0, 3) && new_prefix != group_prefix) {
is_new_group = i > 0;
group_prefix = new_prefix;
} else if (group_prefix != "" && new_prefix != group_prefix) {
is_new_group = true;
group_prefix = "";
}
if (is_new_group && pass == 1) {
class_desc->push_cell();
class_desc->pop(); //cell
class_desc->push_cell();
class_desc->pop(); //cell
}
if (m[i].description != "" || m[i].errors_returned.size() > 0) {
r_method_descrpitons = true;
}
_add_method(m[i], true);
}
any_previous = !m.is_empty();
}
class_desc->pop(); //table
class_desc->pop();
class_desc->pop(); // font
class_desc->add_newline();
class_desc->add_newline();
}
void EditorHelp::_update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, const String &p_method_type) {
Ref<Font> doc_font = get_theme_font(SNAME("doc"), SNAME("EditorFonts"));
Ref<Font> doc_bold_font = get_theme_font(SNAME("doc_bold"), SNAME("EditorFonts"));
Ref<Font> doc_code_font = get_theme_font(SNAME("doc_source"), SNAME("EditorFonts"));
String link_color_text = title_color.to_html(false);
class_desc->pop();
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
for (int pass = 0; pass < 2; pass++) {
Vector<DocData::MethodDoc> methods_filtered;
for (int i = 0; i < p_methods.size(); i++) {
const String &q = p_methods[i].qualifiers;
if ((pass == 0 && q.find("virtual") != -1) || (pass == 1 && q.find("virtual") == -1)) {
methods_filtered.push_back(p_methods[i]);
}
}
for (int i = 0; i < methods_filtered.size(); i++) {
class_desc->push_font(doc_code_font);
_add_method(methods_filtered[i], false);
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
class_desc->push_color(text_color);
class_desc->push_font(doc_font);
class_desc->push_indent(1);
if (methods_filtered[i].errors_returned.size()) {
class_desc->append_text(TTR("Error codes returned:"));
class_desc->add_newline();
class_desc->push_list(0, RichTextLabel::LIST_DOTS, false);
for (int j = 0; j < methods_filtered[i].errors_returned.size(); j++) {
if (j > 0) {
class_desc->add_newline();
}
int val = methods_filtered[i].errors_returned[j];
String text = itos(val);
for (int k = 0; k < CoreConstants::get_global_constant_count(); k++) {
if (CoreConstants::get_global_constant_value(k) == val && CoreConstants::get_global_constant_enum(k) == SNAME("Error")) {
text = CoreConstants::get_global_constant_name(k);
break;
}
}
class_desc->push_bold();
class_desc->append_text(text);
class_desc->pop();
}
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
}
if (!methods_filtered[i].description.strip_edges().is_empty()) {
_add_text(DTR(methods_filtered[i].description));
} else {
class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
class_desc->add_text(" ");
class_desc->push_color(comment_color);
if (p_classdoc.is_script_doc) {
class_desc->append_text(TTR("There is currently no description for this " + p_method_type + "."));
} else {
class_desc->append_text(TTR("There is currently no description for this " + p_method_type + ". Please help us by [color=$color][url=$url]contributing one[/url][/color]!").replace("$url", CONTRIBUTE_URL).replace("$color", link_color_text));
}
class_desc->pop();
}
class_desc->pop();
class_desc->pop();
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
class_desc->add_newline();
}
}
}
void EditorHelp::_update_doc() {
if (!doc->class_list.has(edited_class)) {
return;
@ -622,7 +769,9 @@ void EditorHelp::_update_doc() {
}
// Methods overview
bool method_descr = false;
bool constructor_descriptions = false;
bool method_descriptions = false;
bool operator_descriptions = false;
bool sort_methods = EditorSettings::get_singleton()->get("text_editor/help/sort_functions_alphabetically");
Vector<DocData::MethodDoc> methods;
@ -640,81 +789,43 @@ void EditorHelp::_update_doc() {
methods.push_back(cd.methods[i]);
}
if (methods.size()) {
if (!cd.constructors.is_empty()) {
if (sort_methods) {
cd.constructors.sort();
}
section_line.push_back(Pair<String, int>(TTR("Constructors"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Constructors"));
_update_method_list(cd.constructors, constructor_descriptions);
}
if (!methods.is_empty()) {
if (sort_methods) {
methods.sort();
}
section_line.push_back(Pair<String, int>(TTR("Methods"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Methods"));
class_desc->pop();
class_desc->pop();
_update_method_list(methods, method_descriptions);
}
class_desc->add_newline();
class_desc->push_font(doc_code_font);
class_desc->push_indent(1);
class_desc->push_table(2);
class_desc->set_table_column_expand(1, true);
bool any_previous = false;
for (int pass = 0; pass < 2; pass++) {
Vector<DocData::MethodDoc> m;
for (int i = 0; i < methods.size(); i++) {
const String &q = methods[i].qualifiers;
if ((pass == 0 && q.find("virtual") != -1) || (pass == 1 && q.find("virtual") == -1)) {
m.push_back(methods[i]);
}
}
if (any_previous && !m.is_empty()) {
class_desc->push_cell();
class_desc->pop(); //cell
class_desc->push_cell();
class_desc->pop(); //cell
}
String group_prefix;
for (int i = 0; i < m.size(); i++) {
const String new_prefix = m[i].name.substr(0, 3);
bool is_new_group = false;
if (i < m.size() - 1 && new_prefix == m[i + 1].name.substr(0, 3) && new_prefix != group_prefix) {
is_new_group = i > 0;
group_prefix = new_prefix;
} else if (group_prefix != "" && new_prefix != group_prefix) {
is_new_group = true;
group_prefix = "";
}
if (is_new_group && pass == 1) {
class_desc->push_cell();
class_desc->pop(); //cell
class_desc->push_cell();
class_desc->pop(); //cell
}
if (m[i].description != "" || m[i].errors_returned.size() > 0) {
method_descr = true;
}
_add_method(m[i], true);
}
any_previous = !m.is_empty();
if (!cd.operators.is_empty()) {
if (sort_methods) {
cd.operators.sort();
}
class_desc->pop(); //table
class_desc->pop();
class_desc->pop(); // font
class_desc->add_newline();
class_desc->add_newline();
section_line.push_back(Pair<String, int>(TTR("Operators"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Operators"));
_update_method_list(cd.operators, operator_descriptions);
}
// Theme properties
if (cd.theme_properties.size()) {
if (!cd.theme_properties.is_empty()) {
section_line.push_back(Pair<String, int>(TTR("Theme Properties"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
@ -775,7 +886,7 @@ void EditorHelp::_update_doc() {
}
// Signals
if (cd.signals.size()) {
if (!cd.signals.is_empty()) {
if (sort_methods) {
cd.signals.sort();
}
@ -844,7 +955,7 @@ void EditorHelp::_update_doc() {
}
// Constants and enums
if (cd.constants.size()) {
if (!cd.constants.is_empty()) {
Map<String, Vector<DocData::ConstantDoc>> enums;
Vector<DocData::ConstantDoc> constants;
@ -1195,86 +1306,31 @@ void EditorHelp::_update_doc() {
}
}
// Constructor descriptions
if (constructor_descriptions) {
section_line.push_back(Pair<String, int>(TTR("Constructor Descriptions"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Constructor Descriptions"));
_update_method_descriptions(cd, cd.constructors, "constructor");
}
// Method descriptions
if (method_descr) {
if (method_descriptions) {
section_line.push_back(Pair<String, int>(TTR("Method Descriptions"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Method Descriptions"));
class_desc->pop();
class_desc->pop();
_update_method_descriptions(cd, methods, "method");
}
class_desc->add_newline();
class_desc->add_newline();
for (int pass = 0; pass < 2; pass++) {
Vector<DocData::MethodDoc> methods_filtered;
for (int i = 0; i < methods.size(); i++) {
const String &q = methods[i].qualifiers;
if ((pass == 0 && q.find("virtual") != -1) || (pass == 1 && q.find("virtual") == -1)) {
methods_filtered.push_back(methods[i]);
}
}
for (int i = 0; i < methods_filtered.size(); i++) {
class_desc->push_font(doc_code_font);
_add_method(methods_filtered[i], false);
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
class_desc->push_color(text_color);
class_desc->push_font(doc_font);
class_desc->push_indent(1);
if (methods_filtered[i].errors_returned.size()) {
class_desc->append_text(TTR("Error codes returned:"));
class_desc->add_newline();
class_desc->push_list(0, RichTextLabel::LIST_DOTS, false);
for (int j = 0; j < methods_filtered[i].errors_returned.size(); j++) {
if (j > 0) {
class_desc->add_newline();
}
int val = methods_filtered[i].errors_returned[j];
String text = itos(val);
for (int k = 0; k < CoreConstants::get_global_constant_count(); k++) {
if (CoreConstants::get_global_constant_value(k) == val && CoreConstants::get_global_constant_enum(k) == SNAME("Error")) {
text = CoreConstants::get_global_constant_name(k);
break;
}
}
class_desc->push_bold();
class_desc->append_text(text);
class_desc->pop();
}
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
}
if (!methods_filtered[i].description.strip_edges().is_empty()) {
_add_text(DTR(methods_filtered[i].description));
} else {
class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
class_desc->add_text(" ");
class_desc->push_color(comment_color);
if (cd.is_script_doc) {
class_desc->append_text(TTR("There is currently no description for this method."));
} else {
class_desc->append_text(TTR("There is currently no description for this method. Please help us by [color=$color][url=$url]contributing one[/url][/color]!").replace("$url", CONTRIBUTE_URL).replace("$color", link_color_text));
}
class_desc->pop();
}
class_desc->pop();
class_desc->pop();
class_desc->pop();
class_desc->add_newline();
class_desc->add_newline();
class_desc->add_newline();
}
}
// Operator descriptions
if (operator_descriptions) {
section_line.push_back(Pair<String, int>(TTR("Operator Descriptions"), class_desc->get_line_count() - 2));
class_desc->push_color(title_color);
class_desc->push_font(doc_title_font);
class_desc->add_text(TTR("Operator Descriptions"));
_update_method_descriptions(cd, cd.operators, "operator");
}
scroll_locked = false;
}

View file

@ -152,6 +152,8 @@ class EditorHelp : public VBoxContainer {
Error _goto_desc(const String &p_class, int p_vscr = -1);
//void _update_history_buttons();
void _update_method_list(const Vector<DocData::MethodDoc> p_methods, bool &r_method_descrpitons);
void _update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, const String &p_method_type);
void _update_doc();
void _request_help(const String &p_string);

View file

@ -226,7 +226,9 @@ EditorHelpSearch::EditorHelpSearch() {
filter_combo->add_item(TTR("Display All"), SEARCH_ALL);
filter_combo->add_separator();
filter_combo->add_item(TTR("Classes Only"), SEARCH_CLASSES);
filter_combo->add_item(TTR("Constructors Only"), SEARCH_CONSTRUCTORS);
filter_combo->add_item(TTR("Methods Only"), SEARCH_METHODS);
filter_combo->add_item(TTR("Operators Only"), SEARCH_OPERATORS);
filter_combo->add_item(TTR("Signals Only"), SEARCH_SIGNALS);
filter_combo->add_item(TTR("Constants Only"), SEARCH_CONSTANTS);
filter_combo->add_item(TTR("Properties Only"), SEARCH_PROPERTIES);
@ -334,6 +336,17 @@ bool EditorHelpSearch::Runner::_phase_match_classes() {
// Match members if the term is long enough.
if (term.length() > 1) {
if (search_flags & SEARCH_CONSTRUCTORS) {
for (int i = 0; i < class_doc.constructors.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.constructors[i].name : class_doc.constructors[i].name.to_lower();
if (method_name.find(term) > -1 ||
(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
match.constructors.push_back(const_cast<DocData::MethodDoc *>(&class_doc.constructors[i]));
}
}
}
if (search_flags & SEARCH_METHODS) {
for (int i = 0; i < class_doc.methods.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.methods[i].name : class_doc.methods[i].name.to_lower();
@ -345,6 +358,17 @@ bool EditorHelpSearch::Runner::_phase_match_classes() {
}
}
}
if (search_flags & SEARCH_OPERATORS) {
for (int i = 0; i < class_doc.operators.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.operators[i].name : class_doc.operators[i].name.to_lower();
if (method_name.find(term) > -1 ||
(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
match.operators.push_back(const_cast<DocData::MethodDoc *>(&class_doc.operators[i]));
}
}
}
if (search_flags & SEARCH_SIGNALS) {
for (int i = 0; i < class_doc.signals.size(); i++) {
if (_match_string(term, class_doc.signals[i].name)) {

View file

@ -43,12 +43,14 @@ class EditorHelpSearch : public ConfirmationDialog {
enum SearchFlags {
SEARCH_CLASSES = 1 << 0,
SEARCH_METHODS = 1 << 1,
SEARCH_SIGNALS = 1 << 2,
SEARCH_CONSTANTS = 1 << 3,
SEARCH_PROPERTIES = 1 << 4,
SEARCH_THEME_ITEMS = 1 << 5,
SEARCH_ALL = SEARCH_CLASSES | SEARCH_METHODS | SEARCH_SIGNALS | SEARCH_CONSTANTS | SEARCH_PROPERTIES | SEARCH_THEME_ITEMS,
SEARCH_CONSTRUCTORS = 1 << 1,
SEARCH_METHODS = 1 << 2,
SEARCH_OPERATORS = 1 << 3,
SEARCH_SIGNALS = 1 << 4,
SEARCH_CONSTANTS = 1 << 5,
SEARCH_PROPERTIES = 1 << 6,
SEARCH_THEME_ITEMS = 1 << 7,
SEARCH_ALL = SEARCH_CLASSES | SEARCH_CONSTRUCTORS | SEARCH_METHODS | SEARCH_OPERATORS | SEARCH_SIGNALS | SEARCH_CONSTANTS | SEARCH_PROPERTIES | SEARCH_THEME_ITEMS,
SEARCH_CASE_SENSITIVE = 1 << 29,
SEARCH_SHOW_HIERARCHY = 1 << 30
};
@ -99,7 +101,9 @@ class EditorHelpSearch::Runner : public RefCounted {
struct ClassMatch {
DocData::ClassDoc *doc;
bool name = false;
Vector<DocData::MethodDoc *> constructors;
Vector<DocData::MethodDoc *> methods;
Vector<DocData::MethodDoc *> operators;
Vector<DocData::MethodDoc *> signals;
Vector<DocData::ConstantDoc *> constants;
Vector<DocData::PropertyDoc *> properties;

View file

@ -338,7 +338,9 @@ Error GDScriptWorkspace::initialize() {
}
Vector<DocData::MethodDoc> methods_signals;
methods_signals.append_array(class_data.constructors);
methods_signals.append_array(class_data.methods);
methods_signals.append_array(class_data.operators);
const int signal_start_idx = methods_signals.size();
methods_signals.append_array(class_data.signals);