godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #44951 from KoBeWi/documint 

Complete the docs for primitive types
This commit is contained in:
Rémi Verschelde 2021-03-31 09:27:13 +02:00 committed by GitHub
parent 2182f5e15c 7dfa13c944
commit e49f88b312
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 147 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/bool.xml
View File

@ -132,6 +132,7 @@
<argument index="0" name="right" type="bool">
</argument>
<description>
Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code].
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
@ -140,6 +141,7 @@
<argument index="0" name="right" type="bool">
</argument>
<description>
Returns [code]true[/code] if left operand is [code]false[/code] and right operand is [code]true[/code].
</description>
</method>
<method name="operator ==" qualifiers="operator">
@ -148,6 +150,7 @@
<argument index="0" name="right" type="bool">
</argument>
<description>
Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code].
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
@ -156,6 +159,7 @@
<argument index="0" name="right" type="bool">
</argument>
<description>
Returns [code]true[/code] if left operand is [code]true[/code] and right operand is [code]false[/code].
</description>
</method>
</methods>

45
doc/classes/float.xml
View File

@ -49,6 +49,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if two floats are different from each other.
</description>
</method>
<method name="operator !=" qualifiers="operator">
@ -57,6 +58,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if the integer has different value than the float.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -65,6 +67,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Multiplies two [float]s.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -73,6 +76,10 @@
<argument index="0" name="right" type="Vector2">
</argument>
<description>
Multiplies each component of the [Vector2] by the given [float].
[codeblock]
print(2.5 * Vector2(1, 1)) # Vector2(2.5, 2.5)
[/codeblock]
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -81,6 +88,10 @@
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
Multiplies each component of the [Vector2i] by the given [float].
[codeblock]
print(2.0 * Vector2i(1, 1)) # Vector2i(2.0, 2.0)
[/codeblock]
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -89,6 +100,7 @@
<argument index="0" name="right" type="Vector3">
</argument>
<description>
Multiplies each component of the [Vector3] by the given [float].
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -97,6 +109,7 @@
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
Multiplies each component of the [Vector3i] by the given [float].
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -105,6 +118,7 @@
<argument index="0" name="right" type="Quat">
</argument>
<description>
Multiplies each component of the [Quat] by the given [float].
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -113,6 +127,10 @@
<argument index="0" name="right" type="Color">
</argument>
<description>
Multiplies each component of the [Color] by the given [float].
[codeblock]
print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75)
[/codeblock]
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -121,12 +139,17 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Multiplies a [float] and an [int]. The result is a [float].
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<description>
Unary plus operator. Doesn't have any effect.
[codeblock]
var a = +2.5 # a is 2.5.
[/codeblock]
</description>
</method>
<method name="operator +" qualifiers="operator">
@ -135,6 +158,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Adds two floats.
</description>
</method>
<method name="operator +" qualifiers="operator">
@ -143,12 +167,18 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Adds a [float] and an [int]. The result is a [float].
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<description>
Unary minus operator. Negates the number.
[codeblock]
var a = -2.5 # a is -2.5.
print(-a) # 2.5
[/codeblock]
</description>
</method>
<method name="operator -" qualifiers="operator">
@ -157,6 +187,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Subtracts a float from a float.
</description>
</method>
<method name="operator -" qualifiers="operator">
@ -165,6 +196,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Subtracts an [int] from a [float]. The result is a [float].
</description>
</method>
<method name="operator /" qualifiers="operator">
@ -173,6 +205,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Divides two floats.
</description>
</method>
<method name="operator /" qualifiers="operator">
@ -181,6 +214,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Divides a [float] by an [int]. The result is a [float].
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
@ -189,6 +223,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] the left float is less than the right one.
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
@ -197,6 +232,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if this [float] is less than the given [int].
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
@ -205,6 +241,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] the left integer is less than or equal to the right one.
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
@ -213,6 +250,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if this [float] is less than or equal to the given [int].
</description>
</method>
<method name="operator ==" qualifiers="operator">
@ -221,6 +259,8 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if both floats are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable.
</description>
</method>
<method name="operator ==" qualifiers="operator">
@ -229,6 +269,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if the [float] and the given [int] are equal.
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
@ -237,6 +278,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] the left float is greater than the right one.
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
@ -245,6 +287,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if this [float] is greater than the given [int].
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
@ -253,6 +296,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] the left float is greater than or equal to the right one.
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
@ -261,6 +305,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if this [float] is greater than or equal to the given [int].
</description>
</method>
</methods>

98
doc/classes/int.xml
View File

@ -79,6 +79,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if operands are different from each other.
</description>
</method>
<method name="operator !=" qualifiers="operator">
@ -87,6 +88,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if operands are different from each other.
</description>
</method>
<method name="operator %" qualifiers="operator">
@ -95,6 +97,12 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns the result of the modulo operator for two integers, i.e. the remainder after dividing both numbers.
[codeblock]
print(5 % 2) # 1
print(12 % 4) # 0
print(12 % 2) # 2
[/codeblock]
</description>
</method>
<method name="operator &amp;" qualifiers="operator">
@ -103,6 +111,18 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns the result of bitwise [code]AND[/code] operation for two integers.
[codeblock]
print(3 &amp; 1) # 1
print(11 &amp; 3) # 3
[/codeblock]
It's useful to retrieve binary flags from a variable.
[codeblock]
var flags = 5
# Do something if the first bit is enabled.
if flags &amp; 1:
do_stuff()
[/codeblock]
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -111,6 +131,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Multiplies an [int] and a [float]. The result is a [float].
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -119,6 +140,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Multiplies two [int]s.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -127,6 +149,10 @@
<argument index="0" name="right" type="Vector2">
</argument>
<description>
Multiplies each component of the vector by the given integer.
[codeblock]
print(2 * Vector2(1, 1)) # Vector2(2, 2)
[/codeblock]
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -135,6 +161,7 @@
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
Multiplies each component of the integer vector by the given integer.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -143,6 +170,7 @@
<argument index="0" name="right" type="Vector3">
</argument>
<description>
Multiplies each component of the vector by the given integer.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -151,6 +179,7 @@
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
Multiplies each component of the integer vector by the given integer.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -159,6 +188,7 @@
<argument index="0" name="right" type="Quat">
</argument>
<description>
Multiplies each component of the quaternion by the given integer.
</description>
</method>
<method name="operator *" qualifiers="operator">
@ -167,12 +197,20 @@
<argument index="0" name="right" type="Color">
</argument>
<description>
Multiplies each component of the color by the given integer.
[codeblock]
print(2 * Color(0.5, 0.5, 0.5)) # Color(1, 1, 1)
[/codeblock]
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="int">
</return>
<description>
Unary plus operator. Doesn't have any effect.
[codeblock]
var a = +1 # a is 1.
[/codeblock]
</description>
</method>
<method name="operator +" qualifiers="operator">
@ -181,6 +219,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Adds an [int] to a [float]. The result is a [float].
</description>
</method>
<method name="operator +" qualifiers="operator">
@ -189,12 +228,18 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Adds two integers.
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="int">
</return>
<description>
Unary minus operator. Negates the number.
[codeblock]
var a = -1 # a is -1.
print(-a) # 1
[/codeblock]
</description>
</method>
<method name="operator -" qualifiers="operator">
@ -203,6 +248,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Subtracts a [float] from an [int]. The result is a [float].
</description>
</method>
<method name="operator -" qualifiers="operator">
@ -211,6 +257,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Subtracts two integers.
</description>
</method>
<method name="operator /" qualifiers="operator">
@ -219,6 +266,10 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Divides an [int] by a [float]. The result is a [float].
[codeblock]
print(10 / 3.0) # 3.333...
[/codeblock]
</description>
</method>
<method name="operator /" qualifiers="operator">
@ -227,6 +278,11 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Divides two integers. The decimal part of the result is discarded (truncated).
[codeblock]
print(10 / 2) # 5
print(10 / 3) # 3
[/codeblock]
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
@ -235,6 +291,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if this [int] is less than the given [float].
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
@ -243,6 +300,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] the left integer is less than the right one.
</description>
</method>
<method name="operator &lt;&lt;" qualifiers="operator">
@ -251,6 +309,11 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2.
[codeblock]
print(10 &lt;&lt; 1) # 20
print(10 &lt;&lt; 4) # 160
[/codeblock]
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
@ -259,6 +322,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if this [int] is less than or equal to the given [float].
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
@ -267,6 +331,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] the left integer is less than or equal to the right one.
</description>
</method>
<method name="operator ==" qualifiers="operator">
@ -275,6 +340,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if the integer is equal to the given [float].
</description>
</method>
<method name="operator ==" qualifiers="operator">
@ -283,6 +349,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] if both integers are equal.
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
@ -291,6 +358,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if this [int] is greater than the given [float].
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
@ -299,6 +367,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] the left integer is greater than the right one.
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
@ -307,6 +376,7 @@
<argument index="0" name="right" type="float">
</argument>
<description>
Returns [code]true[/code] if this [int] is greater than or equal to the given [float].
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
@ -315,6 +385,7 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns [code]true[/code] the left integer is greater than or equal to the right one.
</description>
</method>
<method name="operator &gt;&gt;" qualifiers="operator">
@ -323,6 +394,11 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2.
[codeblock]
print(10 &gt;&gt; 1) # 5
print(10 &gt;&gt; 2) # 2
[/codeblock]
</description>
</method>
<method name="operator ^" qualifiers="operator">
@ -331,6 +407,11 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns the result of bitwise [code]XOR[/code] operation for two integers.
[codeblock]
print(5 ^ 1) # 4
print(4 ^ 7) # 3
[/codeblock]
</description>
</method>
<method name="operator |" qualifiers="operator">
@ -339,12 +420,29 @@
<argument index="0" name="right" type="int">
</argument>
<description>
Returns the result of bitwise [code]OR[/code] operation for two integers.
[codeblock]
print(2 | 4) # 6
print(1 | 3) # 3
[/codeblock]
It's useful to store binary flags in a variable.
[codeblock]
var flags = 0
# Turn first and third bit on.
flags |= 1
flags |= 4
[/codeblock]
</description>
</method>
<method name="operator ~" qualifiers="operator">
<return type="int">
</return>
<description>
Returns the result of bitwise [code]NOT[/code] operation for the integer. It's effectively equal to [code]-int + 1[/code].
[codeblock]
print(~4) # -3
print(~7) # -6
[/codeblock]
</description>
</method>
</methods>