diff options
Diffstat (limited to 'doc/classes/int.xml')
| -rw-r--r-- | doc/classes/int.xml | 222 |
1 files changed, 74 insertions, 148 deletions
diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 95918c9007..84a01aa0d0 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -40,62 +40,49 @@ </tutorials> <methods> <method name="int" qualifiers="constructor"> - <return type="int"> - </return> + <return type="int" /> <description> Constructs a default-initialized [int] set to [code]0[/code]. </description> </method> <method name="int" qualifiers="constructor"> - <return type="int"> - </return> - <argument index="0" name="from" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="from" type="int" /> <description> Constructs an [int] as a copy of the given [int]. </description> </method> <method name="int" qualifiers="constructor"> - <return type="int"> - </return> - <argument index="0" name="from" type="bool"> - </argument> + <return type="int" /> + <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. </description> </method> <method name="int" qualifiers="constructor"> - <return type="int"> - </return> - <argument index="0" name="from" type="float"> - </argument> + <return type="int" /> + <argument index="0" name="from" type="float" /> <description> Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. </description> </method> <method name="operator !=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if operands are different from each other. </description> </method> <method name="operator !=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if operands are different from each other. </description> </method> <method name="operator %" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <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. [codeblock] @@ -106,10 +93,8 @@ </description> </method> <method name="operator &" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]AND[/code] operation for two integers. [codeblock] @@ -126,28 +111,22 @@ </description> </method> <method name="operator *" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Multiplies two [int]s. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="float"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> Multiplies an [int] and a [float]. The result is a [float]. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector2"> - </return> - <argument index="0" name="right" type="Vector2"> - </argument> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> <description> Multiplies each component of the vector by the given integer. [codeblock] @@ -156,46 +135,36 @@ </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector2i"> - </return> - <argument index="0" name="right" type="Vector2i"> - </argument> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> <description> Multiplies each component of the integer vector by the given integer. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector3"> - </return> - <argument index="0" name="right" type="Vector3"> - </argument> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> <description> Multiplies each component of the vector by the given integer. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> Multiplies each component of the integer vector by the given integer. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Quaternion"> - </return> - <argument index="0" name="right" type="Quaternion"> - </argument> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> <description> Multiplies each component of the quaternion by the given integer. </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Color"> - </return> - <argument index="0" name="right" type="Color"> - </argument> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> <description> Multiplies each component of the color by the given integer. [codeblock] @@ -204,46 +173,36 @@ </description> </method> <method name="operator +" qualifiers="operator"> - <return type="float"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> Adds an [int] to a [float]. The result is a [float]. </description> </method> <method name="operator +" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Adds two integers. </description> </method> <method name="operator -" qualifiers="operator"> - <return type="float"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> Subtracts a [float] from an [int]. The result is a [float]. </description> </method> <method name="operator -" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Subtracts two integers. </description> </method> <method name="operator /" qualifiers="operator"> - <return type="float"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> Divides an [int] by a [float]. The result is a [float]. [codeblock] @@ -252,10 +211,8 @@ </description> </method> <method name="operator /" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Divides two integers. The decimal part of the result is discarded (truncated). [codeblock] @@ -265,28 +222,22 @@ </description> </method> <method name="operator <" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than the given [float]. </description> </method> <method name="operator <" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than the right one. </description> </method> <method name="operator <<" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2. [codeblock] @@ -296,82 +247,64 @@ </description> </method> <method name="operator <=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than or equal to the given [float]. </description> </method> <method name="operator <=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> </method> <method name="operator ==" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if the integer is equal to the given [float]. </description> </method> <method name="operator ==" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if both integers are equal. </description> </method> <method name="operator >" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than the given [float]. </description> </method> <method name="operator >" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than the right one. </description> </method> <method name="operator >=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than or equal to the given [float]. </description> </method> <method name="operator >=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than or equal to the right one. </description> </method> <method name="operator >>" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2. [codeblock] @@ -381,10 +314,8 @@ </description> </method> <method name="operator ^" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]XOR[/code] operation for two integers. [codeblock] @@ -394,22 +325,18 @@ </description> </method> <method name="operator unary+" qualifiers="operator"> - <return type="int"> - </return> + <return type="int" /> <description> </description> </method> <method name="operator unary-" qualifiers="operator"> - <return type="int"> - </return> + <return type="int" /> <description> </description> </method> <method name="operator |" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]OR[/code] operation for two integers. [codeblock] @@ -426,8 +353,7 @@ </description> </method> <method name="operator ~" qualifiers="operator"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the result of bitwise [code]NOT[/code] operation for the integer. It's effectively equal to [code]-int + 1[/code]. [codeblock] |