diff options
Diffstat (limited to 'doc/classes/int.xml')
| -rw-r--r-- | doc/classes/int.xml | 53 |
1 files changed, 26 insertions, 27 deletions
diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 94c2601e4a..609291b69c 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="int" version="4.0"> +<class name="int" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Integer built-in type. </brief_description> @@ -70,11 +70,6 @@ <operators> <operator name="operator !="> <return type="bool" /> - <description> - </description> - </operator> - <operator name="operator !="> - <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if operands are different from each other. @@ -91,11 +86,11 @@ <return type="int" /> <argument index="0" name="right" type="int" /> <description> - Returns the result of the modulo operator for two integers, i.e. the remainder after dividing both numbers. + Returns the remainder after dividing two integers. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] print(5 % 2) # 1 print(12 % 4) # 0 - print(12 % 2) # 2 + print(-5 % 3) # -2 [/codeblock] </description> </operator> @@ -121,26 +116,14 @@ <return type="Color" /> <argument index="0" name="right" type="Color" /> <description> + Multiplies each component of the [Color] by the given [int]. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> - </description> - </operator> - <operator name="operator *"> - <return type="int" /> - <argument index="0" name="right" type="int" /> - <description> - Multiplies two [int]s. - </description> - </operator> - <operator name="operator *"> - <return type="float" /> - <argument index="0" name="right" type="float" /> - <description> - Multiplies an [int] and a [float]. The result is a [float]. + Multiplies each component of the [Quaternion] by the given [int]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator *"> @@ -174,6 +157,27 @@ Multiplies each component of the [Vector3i] by the given [int]. </description> </operator> + <operator name="operator *"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies an [int] and a [float]. The result is a [float]. + </description> + </operator> + <operator name="operator *"> + <return type="int" /> + <argument index="0" name="right" type="int" /> + <description> + Multiplies two [int]s. + </description> + </operator> + <operator name="operator +"> + <return type="String" /> + <argument index="0" name="right" type="String" /> + <description> + Adds Unicode character with code [int] to the [String]. + </description> + </operator> <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="float" /> @@ -264,11 +268,6 @@ </operator> <operator name="operator =="> <return type="bool" /> - <description> - </description> - </operator> - <operator name="operator =="> - <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if the integer is equal to the given [float]. |