asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #43437 from akien-mga/doc-operators

Browse source 
doc: Add template to document Variant operators, fixups to #43419
This commit is contained in:
Rémi Verschelde 2020-11-10 15:58:36 +01:00 committed by GitHub
commit 9397a5a272
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
36 changed files with 2286 additions and 373 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
doc/classes/AABB.xml
View file

@ -14,14 +14,14 @@
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="AABB">
<method name="AABB" qualifiers="constructor">
<return type="AABB">
</return>
<description>
Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="AABB">
<method name="AABB" qualifiers="constructor">
<return type="AABB">
</return>
<argument index="0" name="from" type="AABB">
@ -30,7 +30,7 @@
Constructs an [AABB] as a copy of the given [AABB].
</description>
</method>
<method name="AABB">
<method name="AABB" qualifiers="constructor">
<return type="AABB">
</return>
<argument index="0" name="position" type="Vector3">
@ -231,6 +231,30 @@
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="AABB">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="AABB">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="AABB">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )">

86
doc/classes/Array.xml
View file

@ -44,14 +44,14 @@
<tutorials>
</tutorials>
<methods>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<description>
Constructs an empty [Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="Array">
@ -60,7 +60,7 @@
Constructs an [Array] as a copy of the given [Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedByteArray">
@ -69,7 +69,7 @@
Constructs an array from a [PackedByteArray].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedColorArray">
@ -78,7 +78,7 @@
Constructs an array from a [PackedColorArray].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedFloat32Array">
@ -87,7 +87,7 @@
Constructs an array from a [PackedFloat32Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
@ -96,7 +96,7 @@
Constructs an array from a [PackedFloat64Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedInt32Array">
@ -105,7 +105,7 @@
Constructs an array from a [PackedInt32Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedInt64Array">
@ -114,7 +114,7 @@
Constructs an array from a [PackedInt64Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedStringArray">
@ -123,7 +123,7 @@
Constructs an array from a [PackedStringArray].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector2Array">
@ -132,7 +132,7 @@
Constructs an array from a [PackedVector2Array].
</description>
</method>
<method name="Array">
<method name="Array" qualifiers="constructor">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector3Array">
@ -352,6 +352,70 @@
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">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Array">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="pop_back">
<return type="Variant">
</return>

52
doc/classes/Basis.xml
View file

@ -19,14 +19,14 @@
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Basis">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<description>
Constructs a default-initialized [Basis] set to [constant IDENTITY].
</description>
</method>
<method name="Basis">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<argument index="0" name="from" type="Basis">
@ -35,7 +35,7 @@
Constructs a [Basis] as a copy of the given [Basis].
</description>
</method>
<method name="Basis">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<argument index="0" name="axis" type="Vector3">
@ -46,7 +46,7 @@
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">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<argument index="0" name="euler" type="Vector3">
@ -56,7 +56,7 @@
Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles.
</description>
</method>
<method name="Basis">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<argument index="0" name="from" type="Quat">
@ -65,7 +65,7 @@
Constructs a pure rotation basis matrix from the given quaternion.
</description>
</method>
<method name="Basis">
<method name="Basis" qualifiers="constructor">
<return type="Basis">
</return>
<argument index="0" name="x_axis" type="Vector3">
@ -131,6 +131,46 @@
Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Basis">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Basis">
</return>
<argument index="0" name="right" type="Basis">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Basis">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="orthonormalized">
<return type="Basis">
</return>

22
doc/classes/Callable.xml
View file

@ -36,14 +36,14 @@
<tutorials>
</tutorials>
<methods>
<method name="Callable">
<method name="Callable" qualifiers="constructor">
<return type="Callable">
</return>
<description>
Constructs a null [Callable] with no object nor method bound.
</description>
</method>
<method name="Callable">
<method name="Callable" qualifiers="constructor">
<return type="Callable">
</return>
<argument index="0" name="from" type="Callable">
@ -52,7 +52,7 @@
Constructs a [Callable] as a copy of the given [Callable].
</description>
</method>
<method name="Callable">
<method name="Callable" qualifiers="constructor">
<return type="Callable">
</return>
<argument index="0" name="object" type="Object">
@ -128,6 +128,22 @@
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Callable">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Callable">
</argument>
<description>
</description>
</method>
<method name="unbind">
<return type="Callable">
</return>

102
doc/classes/Color.xml
View file

@ -16,14 +16,14 @@
<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link>
</tutorials>
<methods>
<method name="Color">
<method name="Color" qualifiers="constructor">
<return type="Color">
</return>
<description>
Constructs a default-initialized [Color] with all components set to [code]0[/code].
</description>
</method>
<method name="Color">
<method name="Color" qualifiers="constructor">
<return type="Color">
</return>
<argument index="0" name="from" type="Color">
@ -32,7 +32,7 @@
Constructs a [Color] as a copy of the given [Color].
</description>
</method>
<method name="Color">
<method name="Color" qualifiers="constructor">
<return type="Color">
</return>
<argument index="0" name="from" type="Color">
@ -51,7 +51,7 @@
[/codeblocks]
</description>
</method>
<method name="Color">
<method name="Color" qualifiers="constructor">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
@ -74,7 +74,7 @@
[/codeblocks]
</description>
</method>
<method name="Color">
<method name="Color" qualifiers="constructor">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
@ -203,6 +203,98 @@
[/codeblocks]
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Color">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Color">
</return>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="to_abgr32">
<return type="int">
</return>

28
doc/classes/Dictionary.xml
View file

@ -171,14 +171,14 @@
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
</tutorials>
<methods>
<method name="Dictionary">
<method name="Dictionary" qualifiers="constructor">
<return type="Dictionary">
</return>
<description>
Constructs an empty [Dictionary].
</description>
</method>
<method name="Dictionary">
<method name="Dictionary" qualifiers="constructor">
<return type="Dictionary">
</return>
<argument index="0" name="from" type="Dictionary">
@ -294,6 +294,30 @@
Returns the list of keys in the [Dictionary].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Variant">
</return>
<argument index="0" name="key" type="Variant">
</argument>
<description>
</description>
</method>
<method name="size">
<return type="int">
</return>

22
doc/classes/NodePath.xml
View file

@ -25,14 +25,14 @@
<link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link>
</tutorials>
<methods>
<method name="NodePath">
<method name="NodePath" qualifiers="constructor">
<return type="NodePath">
</return>
<description>
Constructs an empty [NodePath].
</description>
</method>
<method name="NodePath">
<method name="NodePath" qualifiers="constructor">
<return type="NodePath">
</return>
<argument index="0" name="from" type="NodePath">
@ -41,7 +41,7 @@
Constructs a [NodePath] as a copy of the given [NodePath].
</description>
</method>
<method name="NodePath">
<method name="NodePath" qualifiers="constructor">
<return type="NodePath">
</return>
<argument index="0" name="from" type="String">
@ -150,6 +150,22 @@
Returns [code]true[/code] if the node path is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="NodePath">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedByteArray.xml
View file

@ -10,14 +10,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedByteArray">
<method name="PackedByteArray" qualifiers="constructor">
<return type="PackedByteArray">
</return>
<description>
Constructs an empty [PackedByteArray].
</description>
</method>
<method name="PackedByteArray">
<method name="PackedByteArray" qualifiers="constructor">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="PackedByteArray">
@ -26,7 +26,7 @@
Constructs a [PackedByteArray] as a copy of the given [PackedByteArray].
</description>
</method>
<method name="PackedByteArray">
<method name="PackedByteArray" qualifiers="constructor">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="Array">
@ -159,6 +159,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedByteArray">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedByteArray">
</return>
<argument index="0" name="right" type="PackedByteArray">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedByteArray">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

38
doc/classes/PackedColorArray.xml
View file

@ -10,14 +10,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedColorArray">
<method name="PackedColorArray" qualifiers="constructor">
<return type="PackedColorArray">
</return>
<description>
Constructs an empty [PackedColorArray].
</description>
</method>
<method name="PackedColorArray">
<method name="PackedColorArray" qualifiers="constructor">
<return type="PackedColorArray">
</return>
<argument index="0" name="from" type="PackedColorArray">
@ -26,7 +26,7 @@
Constructs a [PackedColorArray] as a copy of the given [PackedColorArray].
</description>
</method>
<method name="PackedColorArray">
<method name="PackedColorArray" qualifiers="constructor">
<return type="PackedColorArray">
</return>
<argument index="0" name="from" type="Array">
@ -87,6 +87,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedColorArray">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedColorArray">
</return>
<argument index="0" name="right" type="PackedColorArray">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedColorArray">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

30
doc/classes/PackedFloat32Array.xml
View file

@ -11,14 +11,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedFloat32Array">
<method name="PackedFloat32Array" qualifiers="constructor">
<return type="PackedFloat32Array">
</return>
<description>
Constructs an empty [PackedFloat32Array].
</description>
</method>
<method name="PackedFloat32Array">
<method name="PackedFloat32Array" qualifiers="constructor">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="from" type="PackedFloat32Array">
@ -27,7 +27,7 @@
Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array].
</description>
</method>
<method name="PackedFloat32Array">
<method name="PackedFloat32Array" qualifiers="constructor">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,30 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedFloat32Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="right" type="PackedFloat32Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedFloat32Array">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

38
doc/classes/PackedFloat64Array.xml
View file

@ -11,14 +11,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedFloat64Array">
<method name="PackedFloat64Array" qualifiers="constructor">
<return type="PackedFloat64Array">
</return>
<description>
Constructs an empty [PackedFloat64Array].
</description>
</method>
<method name="PackedFloat64Array">
<method name="PackedFloat64Array" qualifiers="constructor">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
@ -27,7 +27,7 @@
Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array].
</description>
</method>
<method name="PackedFloat64Array">
<method name="PackedFloat64Array" qualifiers="constructor">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedFloat64Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="right" type="PackedFloat64Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedFloat64Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

38
doc/classes/PackedInt32Array.xml
View file

@ -11,14 +11,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedInt32Array">
<method name="PackedInt32Array" qualifiers="constructor">
<return type="PackedInt32Array">
</return>
<description>
Constructs an empty [PackedInt32Array].
</description>
</method>
<method name="PackedInt32Array">
<method name="PackedInt32Array" qualifiers="constructor">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="PackedInt32Array">
@ -27,7 +27,7 @@
Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array].
</description>
</method>
<method name="PackedInt32Array">
<method name="PackedInt32Array" qualifiers="constructor">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedInt32Array">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

38
doc/classes/PackedInt64Array.xml
View file

@ -11,14 +11,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedInt64Array">
<method name="PackedInt64Array" qualifiers="constructor">
<return type="PackedInt64Array">
</return>
<description>
Constructs an empty [PackedInt64Array].
</description>
</method>
<method name="PackedInt64Array">
<method name="PackedInt64Array" qualifiers="constructor">
<return type="PackedInt64Array">
</return>
<argument index="0" name="from" type="PackedInt64Array">
@ -27,7 +27,7 @@
Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array].
</description>
</method>
<method name="PackedInt64Array">
<method name="PackedInt64Array" qualifiers="constructor">
<return type="PackedInt64Array">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt64Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedInt64Array">
</return>
<argument index="0" name="right" type="PackedInt64Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt64Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

38
doc/classes/PackedStringArray.xml
View file

@ -11,14 +11,14 @@
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
</tutorials>
<methods>
<method name="PackedStringArray">
<method name="PackedStringArray" qualifiers="constructor">
<return type="PackedStringArray">
</return>
<description>
Constructs an empty [PackedStringArray].
</description>
</method>
<method name="PackedStringArray">
<method name="PackedStringArray" qualifiers="constructor">
<return type="PackedStringArray">
</return>
<argument index="0" name="from" type="PackedStringArray">
@ -27,7 +27,7 @@
Constructs a [PackedStringArray] as a copy of the given [PackedStringArray].
</description>
</method>
<method name="PackedStringArray">
<method name="PackedStringArray" qualifiers="constructor">
<return type="PackedStringArray">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,38 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedStringArray">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedStringArray">
</return>
<argument index="0" name="right" type="PackedStringArray">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedStringArray">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="String">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

46
doc/classes/PackedVector2Array.xml
View file

@ -11,14 +11,14 @@
<link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link>
</tutorials>
<methods>
<method name="PackedVector2Array">
<method name="PackedVector2Array" qualifiers="constructor">
<return type="PackedVector2Array">
</return>
<description>
Constructs an empty [PackedVector2Array].
</description>
</method>
<method name="PackedVector2Array">
<method name="PackedVector2Array" qualifiers="constructor">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="PackedVector2Array">
@ -27,7 +27,7 @@
Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array].
</description>
</method>
<method name="PackedVector2Array">
<method name="PackedVector2Array" qualifiers="constructor">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Array">
@ -88,6 +88,46 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedVector2Array">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector2Array">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedVector2Array">
</return>
<argument index="0" name="right" type="PackedVector2Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedVector2Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

46
doc/classes/PackedVector3Array.xml
View file

@ -10,14 +10,14 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedVector3Array">
<method name="PackedVector3Array" qualifiers="constructor">
<return type="PackedVector3Array">
</return>
<description>
Constructs an empty [PackedVector3Array].
</description>
</method>
<method name="PackedVector3Array">
<method name="PackedVector3Array" qualifiers="constructor">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="PackedVector3Array">
@ -26,7 +26,7 @@
Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array].
</description>
</method>
<method name="PackedVector3Array">
<method name="PackedVector3Array" qualifiers="constructor">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Array">
@ -87,6 +87,46 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedVector3Array">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector3Array">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedVector3Array">
</return>
<argument index="0" name="right" type="PackedVector3Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedVector3Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

40
doc/classes/Plane.xml
View file

@ -10,14 +10,14 @@
<link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
</tutorials>
<methods>
<method name="Plane">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<description>
Constructs a default-initialized [Plane] with all components set to [code]0[/code].
</description>
</method>
<method name="Plane">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="from" type="Plane">
@ -26,7 +26,7 @@
Constructs a [Plane] as a copy of the given [Plane].
</description>
</method>
<method name="Plane">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="a" type="float">
@ -41,7 +41,7 @@
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">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="normal" type="Vector3">
@ -52,7 +52,7 @@
Creates a plane from the normal and the plane's distance to the origin.
</description>
</method>
<method name="Plane">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="point" type="Vector3">
@ -63,7 +63,7 @@
Creates a plane from the given position and a plane normal.
</description>
</method>
<method name="Plane">
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="point1" type="Vector3">
@ -161,6 +161,34 @@
Returns a copy of the plane, normalized.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Plane">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Plane">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Plane">
</return>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Plane">
</argument>
<description>
</description>
</method>
<method name="project">
<return type="Vector3">
</return>

106
doc/classes/Quat.xml
View file

@ -13,14 +13,14 @@
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
</tutorials>
<methods>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<description>
Constructs a default-initialized quaternion with all components set to [code]0[/code].
</description>
</method>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="from" type="Quat">
@ -29,7 +29,7 @@
Constructs a [Quat] as a copy of the given [Quat].
</description>
</method>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="arc_from" type="Vector3">
@ -39,7 +39,7 @@
<description>
</description>
</method>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="axis" type="Vector3">
@ -50,7 +50,7 @@
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="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="euler" type="Vector3">
@ -59,7 +59,7 @@
Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle).
</description>
</method>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="from" type="Basis">
@ -68,7 +68,7 @@
Constructs a quaternion from the given [Basis].
</description>
</method>
<method name="Quat">
<method name="Quat" qualifiers="constructor">
<return type="Quat">
</return>
<argument index="0" name="x" type="float">
@ -158,6 +158,98 @@
Returns a copy of the quaternion, normalized to unit length.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Quat">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Quat">
</return>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="slerp">
<return type="Quat">
</return>

52
doc/classes/RID.xml
View file

@ -9,14 +9,14 @@
<tutorials>
</tutorials>
<methods>
<method name="RID">
<method name="RID" qualifiers="constructor">
<return type="RID">
</return>
<description>
Constructs an empty [RID] with the invalid ID [code]0[/code].
</description>
</method>
<method name="RID">
<method name="RID" qualifiers="constructor">
<return type="RID">
</return>
<argument index="0" name="from" type="RID">
@ -32,6 +32,54 @@
Returns the ID of the referenced resource.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

34
doc/classes/Rect2.xml
View file

@ -14,14 +14,14 @@
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="Rect2">
<method name="Rect2" qualifiers="constructor">
<return type="Rect2">
</return>
<description>
Constructs a default-initialized [Rect2] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="Rect2">
<method name="Rect2" qualifiers="constructor">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2">
@ -30,7 +30,7 @@
Constructs a [Rect2] as a copy of the given [Rect2].
</description>
</method>
<method name="Rect2">
<method name="Rect2" qualifiers="constructor">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2i">
@ -39,7 +39,7 @@
Constructs a [Rect2] from a [Rect2i].
</description>
</method>
<method name="Rect2">
<method name="Rect2" qualifiers="constructor">
<return type="Rect2">
</return>
<argument index="0" name="position" type="Vector2">
@ -50,7 +50,7 @@
Constructs a [Rect2] by position and size.
</description>
</method>
<method name="Rect2">
<method name="Rect2" qualifiers="constructor">
<return type="Rect2">
</return>
<argument index="0" name="x" type="float">
@ -187,6 +187,30 @@
Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Rect2">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Rect2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">

26
doc/classes/Rect2i.xml
View file

@ -12,14 +12,14 @@
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
</tutorials>
<methods>
<method name="Rect2i">
<method name="Rect2i" qualifiers="constructor">
<return type="Rect2i">
</return>
<description>
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="Rect2i">
<method name="Rect2i" qualifiers="constructor">
<return type="Rect2i">
</return>
<argument index="0" name="from" type="Rect2i">
@ -28,7 +28,7 @@
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
</method>
<method name="Rect2i">
<method name="Rect2i" qualifiers="constructor">
<return type="Rect2i">
</return>
<argument index="0" name="from" type="Rect2">
@ -37,7 +37,7 @@
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Rect2i">
<method name="Rect2i" qualifiers="constructor">
<return type="Rect2i">
</return>
<argument index="0" name="position" type="Vector2i">
@ -48,7 +48,7 @@
Constructs a [Rect2i] by position and size.
</description>
</method>
<method name="Rect2i">
<method name="Rect2i" qualifiers="constructor">
<return type="Rect2i">
</return>
<argument index="0" name="x" type="int">
@ -174,6 +174,22 @@
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Rect2i">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Rect2i">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector2i" setter="" getter="" default="Vector2i( 0, 0 )">

22
doc/classes/Signal.xml
View file

@ -8,14 +8,14 @@
<tutorials>
</tutorials>
<methods>
<method name="Signal">
<method name="Signal" qualifiers="constructor">
<return type="Signal">
</return>
<description>
Constructs a null [Signal] with no object nor signal name bound.
</description>
</method>
<method name="Signal">
<method name="Signal" qualifiers="constructor">
<return type="Signal">
</return>
<argument index="0" name="from" type="Signal">
@ -24,7 +24,7 @@
Constructs a [Signal] as a copy of the given [Signal].
</description>
</method>
<method name="Signal">
<method name="Signal" qualifiers="constructor">
<return type="Signal">
</return>
<argument index="0" name="object" type="Object">
@ -107,6 +107,22 @@
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Signal">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Signal">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

88
doc/classes/String.xml
View file

@ -10,14 +10,14 @@
<link title="GDScript format strings">https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_format_string.html</link>
</tutorials>
<methods>
<method name="String">
<method name="String" qualifiers="constructor">
<return type="String">
</return>
<description>
Constructs an empty [String] ([code]""[/code]).
</description>
</method>
<method name="String">
<method name="String" qualifiers="constructor">
<return type="String">
</return>
<argument index="0" name="from" type="String">
@ -26,7 +26,7 @@
Constructs a [String] as a copy of the given [String].
</description>
</method>
<method name="String">
<method name="String" qualifiers="constructor">
<return type="String">
</return>
<argument index="0" name="from" type="NodePath">
@ -35,7 +35,7 @@
Constructs a new String from the given [NodePath].
</description>
</method>
<method name="String">
<method name="String" qualifiers="constructor">
<return type="String">
</return>
<argument index="0" name="from" type="StringName">
@ -466,6 +466,86 @@
To get a boolean result from a string comparison, use the [code]==[/code] operator instead. See also [method casecmp_to] and [method naturalnocasecmp_to].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="StringName">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="String">
</return>
<argument index="0" name="right" type="Variant">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="String">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="StringName">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="ord_at">
<return type="int">
</return>

38
doc/classes/StringName.xml
View file

@ -9,14 +9,14 @@
<tutorials>
</tutorials>
<methods>
<method name="StringName">
<method name="StringName" qualifiers="constructor">
<return type="StringName">
</return>
<description>
Constructs an empty [StringName].
</description>
</method>
<method name="StringName">
<method name="StringName" qualifiers="constructor">
<return type="StringName">
</return>
<argument index="0" name="from" type="StringName">
@ -25,7 +25,7 @@
Constructs a [StringName] as a copy of the given [StringName].
</description>
</method>
<method name="StringName">
<method name="StringName" qualifiers="constructor">
<return type="StringName">
</return>
<argument index="0" name="from" type="String">
@ -34,6 +34,38 @@
Creates a new [StringName] from the given [String].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="StringName">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="String">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="StringName">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

56
doc/classes/Transform.xml
View file

@ -16,14 +16,14 @@
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Transform">
<method name="Transform" qualifiers="constructor">
<return type="Transform">
</return>
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
</description>
</method>
<method name="Transform">
<method name="Transform" qualifiers="constructor">
<return type="Transform">
</return>
<argument index="0" name="from" type="Transform">
@ -32,7 +32,7 @@
Constructs a [Transform] as a copy of the given [Transform].
</description>
</method>
<method name="Transform">
<method name="Transform" qualifiers="constructor">
<return type="Transform">
</return>
<argument index="0" name="basis" type="Basis">
@ -43,7 +43,7 @@
Constructs a Transform from a [Basis] and [Vector3].
</description>
</method>
<method name="Transform">
<method name="Transform" qualifiers="constructor">
<return type="Transform">
</return>
<argument index="0" name="x_axis" type="Vector3">
@ -105,6 +105,54 @@
Operations take place in global space.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector3Array">
</return>
<argument index="0" name="right" type="PackedVector3Array">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="AABB">
</return>
<argument index="0" name="right" type="AABB">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="orthonormalized">
<return type="Transform">
</return>

64
doc/classes/Transform2D.xml
View file

@ -14,14 +14,14 @@
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Transform2D">
<method name="Transform2D" qualifiers="constructor">
<return type="Transform2D">
</return>
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
</description>
</method>
<method name="Transform2D">
<method name="Transform2D" qualifiers="constructor">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform2D">
@ -30,7 +30,7 @@
Constructs a [Transform2D] as a copy of the given [Transform2D].
</description>
</method>
<method name="Transform2D">
<method name="Transform2D" qualifiers="constructor">
<return type="Transform2D">
</return>
<argument index="0" name="rotation" type="float">
@ -41,7 +41,7 @@
Constructs the transform from a given angle (in radians) and position.
</description>
</method>
<method name="Transform2D">
<method name="Transform2D" qualifiers="constructor">
<return type="Transform2D">
</return>
<argument index="0" name="x_axis" type="Vector2">
@ -129,6 +129,62 @@
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Rect2">
</return>
<argument index="0" name="right" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform2D">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector2Array">
</return>
<argument index="0" name="right" type="PackedVector2Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="orthonormalized">
<return type="Transform2D">
</return>

148
doc/classes/Vector2.xml
View file

@ -17,14 +17,14 @@
<link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
</tutorials>
<methods>
<method name="Vector2">
<method name="Vector2" qualifiers="constructor">
<return type="Vector2">
</return>
<description>
Constructs a default-initialized [Vector2] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector2">
<method name="Vector2" qualifiers="constructor">
<return type="Vector2">
</return>
<argument index="0" name="from" type="Vector2">
@ -33,7 +33,7 @@
Constructs a [Vector2] as a copy of the given [Vector2].
</description>
</method>
<method name="Vector2">
<method name="Vector2" qualifiers="constructor">
<return type="Vector2">
</return>
<argument index="0" name="from" type="Vector2i">
@ -42,7 +42,7 @@
Constructs a new [Vector2] from [Vector2i].
</description>
</method>
<method name="Vector2">
<method name="Vector2" qualifiers="constructor">
<return type="Vector2">
</return>
<argument index="0" name="x" type="float">
@ -250,6 +250,146 @@
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Transform2D">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="posmod">
<return type="Vector2">
</return>

156
doc/classes/Vector2i.xml
View file

@ -14,14 +14,14 @@
<link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
</tutorials>
<methods>
<method name="Vector2i">
<method name="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<description>
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector2i">
<method name="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<argument index="0" name="from" type="Vector2i">
@ -30,7 +30,7 @@
Constructs a [Vector2i] as a copy of the given [Vector2i].
</description>
</method>
<method name="Vector2i">
<method name="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<argument index="0" name="from" type="Vector2">
@ -39,7 +39,7 @@
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Vector2i">
<method name="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<argument index="0" name="x" type="int">
@ -64,6 +64,154 @@
Returns the ratio of [member x] to [member y].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector2i">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector2i">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="sign">
<return type="Vector2i">
</return>

164
doc/classes/Vector3.xml
View file

@ -17,14 +17,14 @@
<link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link>
</tutorials>
<methods>
<method name="Vector3">
<method name="Vector3" qualifiers="constructor">
<return type="Vector3">
</return>
<description>
Constructs a default-initialized [Vector3] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector3">
<method name="Vector3" qualifiers="constructor">
<return type="Vector3">
</return>
<argument index="0" name="from" type="Vector3">
@ -33,7 +33,7 @@
Constructs a [Vector3] as a copy of the given [Vector3].
</description>
</method>
<method name="Vector3">
<method name="Vector3" qualifiers="constructor">
<return type="Vector3">
</return>
<argument index="0" name="from" type="Vector3i">
@ -42,7 +42,7 @@
Constructs a new [Vector3] from [Vector3i].
</description>
</method>
<method name="Vector3">
<method name="Vector3" qualifiers="constructor">
<return type="Vector3">
</return>
<argument index="0" name="x" type="float">
@ -239,6 +239,162 @@
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Basis">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Transform">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="outer">
<return type="Basis">
</return>

156
doc/classes/Vector3i.xml
View file

@ -14,14 +14,14 @@
<link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
</tutorials>
<methods>
<method name="Vector3i">
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<description>
Constructs a default-initialized [Vector3i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector3i">
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="from" type="Vector3i">
@ -30,7 +30,7 @@
Constructs a [Vector3i] as a copy of the given [Vector3i].
</description>
</method>
<method name="Vector3i">
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="from" type="Vector3">
@ -39,7 +39,7 @@
Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Vector3i">
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="x" type="int">
@ -72,6 +72,154 @@
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">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="sign">
<return type="Vector3i">
</return>

40
doc/classes/bool.xml
View file

@ -91,14 +91,14 @@
<tutorials>
</tutorials>
<methods>
<method name="bool">
<method name="bool" qualifiers="constructor">
<return type="bool">
</return>
<description>
Constructs a default-initialized [bool] set to [code]false[/code].
</description>
</method>
<method name="bool">
<method name="bool" qualifiers="constructor">
<return type="bool">
</return>
<argument index="0" name="from" type="bool">
@ -107,7 +107,7 @@
Constructs a [bool] as a copy of the given [bool].
</description>
</method>
<method name="bool">
<method name="bool" qualifiers="constructor">
<return type="bool">
</return>
<argument index="0" name="from" type="float">
@ -116,7 +116,7 @@
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">
<method name="bool" qualifiers="constructor">
<return type="bool">
</return>
<argument index="0" name="from" type="int">
@ -125,6 +125,38 @@
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">
<return type="bool">
</return>
<argument index="0" name="right" type="bool">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="bool">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="bool">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

228
doc/classes/float.xml
View file

@ -9,14 +9,14 @@
<tutorials>
</tutorials>
<methods>
<method name="float">
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<description>
Constructs a default-initialized [float] set to [code]0.0[/code].
</description>
</method>
<method name="float">
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="float">
@ -25,7 +25,7 @@
Constructs a [float] as a copy of the given [float].
</description>
</method>
<method name="float">
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="bool">
@ -34,7 +34,7 @@
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">
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="int">
@ -43,6 +43,226 @@
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">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

282
doc/classes/int.xml
View file

@ -23,14 +23,14 @@
<tutorials>
</tutorials>
<methods>
<method name="int">
<method name="int" qualifiers="constructor">
<return type="int">
</return>
<description>
Constructs a default-initialized [int] set to [code]0[/code].
</description>
</method>
<method name="int">
<method name="int" qualifiers="constructor">
<return type="int">
</return>
<argument index="0" name="from" type="int">
@ -39,7 +39,7 @@
Constructs an [int] as a copy of the given [int].
</description>
</method>
<method name="int">
<method name="int" qualifiers="constructor">
<return type="int">
</return>
<argument index="0" name="from" type="bool">
@ -48,7 +48,7 @@
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">
<method name="int" qualifiers="constructor">
<return type="int">
</return>
<argument index="0" name="from" type="float">
@ -57,6 +57,280 @@
Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator %" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &amp;" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="int">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="int">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;&lt;" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;&gt;" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ^" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator |" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ~" qualifiers="operator">
<return type="int">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

237
doc/tools/doc_merge.py
View file

@ -1,237 +0,0 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import xml.etree.ElementTree as ET
tree = ET.parse(sys.argv[1])
old_doc = tree.getroot()
tree = ET.parse(sys.argv[2])
new_doc = tree.getroot()
f = file(sys.argv[3], "wb")
tab = 0
old_classes = {}
def write_string(_f, text, newline=True):
for t in range(tab):
_f.write("\t")
_f.write(text)
if newline:
_f.write("\n")
def escape(ret):
ret = ret.replace("&", "&amp;")
ret = ret.replace("<", "&gt;")
ret = ret.replace(">", "&lt;")
ret = ret.replace("'", "&apos;")
ret = ret.replace('"', "&quot;")
return ret
def inc_tab():
global tab
tab += 1
def dec_tab():
global tab
tab -= 1
write_string(f, '<?xml version="1.0" encoding="UTF-8" ?>')
write_string(f, '<doc version="' + new_doc.attrib["version"] + '">')
def get_tag(node, name):
tag = ""
if name in node.attrib:
tag = " " + name + '="' + escape(node.attrib[name]) + '" '
return tag
def find_method_descr(old_class, name):
methods = old_class.find("methods")
if methods != None and len(list(methods)) > 0:
for m in list(methods):
if m.attrib["name"] == name:
description = m.find("description")
if description != None and description.text.strip() != "":
return description.text
return None
def find_signal_descr(old_class, name):
signals = old_class.find("signals")
if signals != None and len(list(signals)) > 0:
for m in list(signals):
if m.attrib["name"] == name:
description = m.find("description")
if description != None and description.text.strip() != "":
return description.text
return None
def find_constant_descr(old_class, name):
if old_class is None:
return None
constants = old_class.find("constants")
if constants != None and len(list(constants)) > 0:
for m in list(constants):
if m.attrib["name"] == name:
if m.text.strip() != "":
return m.text
return None
def write_class(c):
class_name = c.attrib["name"]
print("Parsing Class: " + class_name)
if class_name in old_classes:
old_class = old_classes[class_name]
else:
old_class = None
category = get_tag(c, "category")
inherits = get_tag(c, "inherits")
write_string(f, '<class name="' + class_name + '" ' + category + inherits + ">")
inc_tab()
write_string(f, "<brief_description>")
if old_class != None:
old_brief_descr = old_class.find("brief_description")
if old_brief_descr != None:
write_string(f, escape(old_brief_descr.text.strip()))
write_string(f, "</brief_description>")
write_string(f, "<description>")
if old_class != None:
old_descr = old_class.find("description")
if old_descr != None:
write_string(f, escape(old_descr.text.strip()))
write_string(f, "</description>")
methods = c.find("methods")
if methods != None and len(list(methods)) > 0:
write_string(f, "<methods>")
inc_tab()
for m in list(methods):
qualifiers = get_tag(m, "qualifiers")
write_string(f, '<method name="' + escape(m.attrib["name"]) + '" ' + qualifiers + ">")
inc_tab()
for a in list(m):
if a.tag == "return":
typ = get_tag(a, "type")
write_string(f, "<return" + typ + ">")
write_string(f, "</return>")
elif a.tag == "argument":
default = get_tag(a, "default")
write_string(
f,
'<argument index="'
+ a.attrib["index"]
+ '" name="'
+ escape(a.attrib["name"])
+ '" type="'
+ a.attrib["type"]
+ '"'
+ default
+ ">",
)
write_string(f, "</argument>")
write_string(f, "<description>")
if old_class != None:
old_method_descr = find_method_descr(old_class, m.attrib["name"])
if old_method_descr:
write_string(f, escape(escape(old_method_descr.strip())))
write_string(f, "</description>")
dec_tab()
write_string(f, "</method>")
dec_tab()
write_string(f, "</methods>")
signals = c.find("signals")
if signals != None and len(list(signals)) > 0:
write_string(f, "<signals>")
inc_tab()
for m in list(signals):
write_string(f, '<signal name="' + escape(m.attrib["name"]) + '">')
inc_tab()
for a in list(m):
if a.tag == "argument":
write_string(
f,
'<argument index="'
+ a.attrib["index"]
+ '" name="'
+ escape(a.attrib["name"])
+ '" type="'
+ a.attrib["type"]
+ '">',
)
write_string(f, "</argument>")
write_string(f, "<description>")
if old_class != None:
old_signal_descr = find_signal_descr(old_class, m.attrib["name"])
if old_signal_descr:
write_string(f, escape(old_signal_descr.strip()))
write_string(f, "</description>")
dec_tab()
write_string(f, "</signal>")
dec_tab()
write_string(f, "</signals>")
constants = c.find("constants")
if constants != None and len(list(constants)) > 0:
write_string(f, "<constants>")
inc_tab()
for m in list(constants):
write_string(f, '<constant name="' + escape(m.attrib["name"]) + '" value="' + m.attrib["value"] + '">')
old_constant_descr = find_constant_descr(old_class, m.attrib["name"])
if old_constant_descr:
write_string(f, escape(old_constant_descr.strip()))
write_string(f, "</constant>")
dec_tab()
write_string(f, "</constants>")
dec_tab()
write_string(f, "</class>")
for c in list(old_doc):
old_classes[c.attrib["name"]] = c
for c in list(new_doc):
write_class(c)
write_string(f, "</doc>\n")

2
doc/tools/makerst.py
View file

@ -1042,6 +1042,8 @@ def make_footer(): # type: () -> str
".. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`\n"
".. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`\n"
".. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`\n"
".. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`\n"
".. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`\n"
)
# fmt: on

28
editor/doc_data.cpp
View file

@ -569,12 +569,15 @@ void DocData::generate(bool p_basic_types) {
method_list.sort();
Variant::get_constructor_list(Variant::Type(i), &method_list);
for (int j = 0; j < Variant::OP_AND; j++) { //showing above 'and' is pretty confusing and there are a lot of variations
for (int j = 0; j < Variant::OP_AND; j++) { // Showing above 'and' is pretty confusing and there are a lot of variations.
for (int k = 0; k < Variant::VARIANT_MAX; k++) {
Variant::Type rt = Variant::get_operator_return_type(Variant::Operator(j), Variant::Type(i), Variant::Type(k));
if (rt != Variant::NIL) {
//has operator
if (rt != Variant::NIL) { // Has operator.
// Skip String % operator as it's registered separately for each Variant arg type,
// we'll add it manually below.
if (i == Variant::STRING && Variant::Operator(j) == Variant::OP_MODULE) {
continue;
}
MethodInfo mi;
mi.name = "operator " + Variant::get_operator_name(Variant::Operator(j));
mi.return_val.type = rt;
@ -589,6 +592,21 @@ void DocData::generate(bool p_basic_types) {
}
}
if (i == Variant::STRING) {
// We skipped % operator above, and we register it manually once for Variant arg type here.
MethodInfo mi;
mi.name = "operator %";
mi.return_val.type = Variant::STRING;
PropertyInfo arg;
arg.name = "right";
arg.type = Variant::NIL;
arg.usage = PROPERTY_USAGE_NIL_IS_VARIANT;
mi.arguments.push_back(arg);
method_list.push_back(mi);
}
if (Variant::is_keyed(Variant::Type(i))) {
MethodInfo mi;
mi.name = "operator []";
@ -1147,7 +1165,7 @@ Error DocData::save_classes(const String &p_default_path, const Map<String, Stri
qualifiers += " qualifiers=\"" + m.qualifiers.xml_escape() + "\"";
}
_write_string(f, 2, "<method name=\"" + m.name + "\"" + qualifiers + ">");
_write_string(f, 2, "<method name=\"" + m.name.xml_escape() + "\"" + qualifiers + ">");
if (m.return_type != "") {
String enum_text;