godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/int.xml

338 lines
8.9 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="int" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Integer built-in type.
</brief_description>
<description>
Fix VariantWriter overflow on 64-bit int Integers in Godot are signed 64-bit ints (int64_t), but var2str used int behind the scenes and would thus overflow after 2^31. Also properly documented the actual bounds of int and the behaviour when overflowing them.
2019-02-21 10:21:41 +00:00
Signed 64-bit integer type.
It can take values in the interval [code][-2^63, 2^63 - 1][/code], i.e. [code][-9223372036854775808, 9223372036854775807][/code]. Exceeding those bounds will wrap around.
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
[int] is a [Variant] type, and will thus be used when assigning an integer value to a [Variant]. It can also be enforced with the [code]: int[/code] type hint.
Fix VariantWriter overflow on 64-bit int Integers in Godot are signed 64-bit ints (int64_t), but var2str used int behind the scenes and would thus overflow after 2^31. Also properly documented the actual bounds of int and the behaviour when overflowing them.
2019-02-21 10:21:41 +00:00
[codeblock]
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 17:41:49 +00:00
var my_variant = 0 # int, value 0.
my_variant += 4.2 # float, value 4.2.
var my_int: int = 1 # int, value 1.
my_int = 4.2 # int, value 4, the right value is implicitly cast to int.
my_int = int("6.7") # int, value 6, the String is explicitly cast with int.
Fix VariantWriter overflow on 64-bit int Integers in Godot are signed 64-bit ints (int64_t), but var2str used int behind the scenes and would thus overflow after 2^31. Also properly documented the actual bounds of int and the behaviour when overflowing them.
2019-02-21 10:21:41 +00:00
var max_int = 9223372036854775807
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 17:41:49 +00:00
print(max_int) # 9223372036854775807, OK.
Fix VariantWriter overflow on 64-bit int Integers in Godot are signed 64-bit ints (int64_t), but var2str used int behind the scenes and would thus overflow after 2^31. Also properly documented the actual bounds of int and the behaviour when overflowing them.
2019-02-21 10:21:41 +00:00
max_int += 1
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 17:41:49 +00:00
print(max_int) # -9223372036854775808, we overflowed and wrapped around.
Fix VariantWriter overflow on 64-bit int Integers in Godot are signed 64-bit ints (int64_t), but var2str used int behind the scenes and would thus overflow after 2^31. Also properly documented the actual bounds of int and the behaviour when overflowing them.
2019-02-21 10:21:41 +00:00
[/codeblock]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="int" qualifiers="constructor">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="int">
</return>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a default-initialized [int] set to [code]0[/code].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="int" qualifiers="constructor">
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<return type="int">
</return>
<argument index="0" name="from" type="int">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
Constructs an [int] as a copy of the given [int].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="int" qualifiers="constructor">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="int">
</return>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<argument index="0" name="from" type="bool">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="int" qualifiers="constructor">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="int">
</return>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<argument index="0" name="from" type="float">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
<constants>
</constants>
</class>