summaryrefslogtreecommitdiff
path: root/doc/classes/Vector2i.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-22 12:36:35 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-22 12:36:35 +0100
commit876ea3e143047e09cbc8fa106c4769b5003857fa (patch)
tree099724d59355c88386ea4d2b5716c8063e071714 /doc/classes/Vector2i.xml
parent0b2dc0f017c4495e7b3fbf5c5c173cf9ad61e0d8 (diff)
parentedfb504efe0a9296561db4a84836603be6dbc274 (diff)
Merge pull request #68579 from jtnicholl/float_doc
Document that `Vector#` types are 32-bit by default and `Vector#i` are always 32-bit
Diffstat (limited to 'doc/classes/Vector2i.xml')
-rw-r--r--doc/classes/Vector2i.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml
index eab880e57f..fd02e3c530 100644
--- a/doc/classes/Vector2i.xml
+++ b/doc/classes/Vector2i.xml
@@ -5,7 +5,7 @@
</brief_description>
<description>
2-element structure that can be used to represent positions in 2D space or any other pair of numeric values.
- It uses integer coordinates and is therefore preferable to [Vector2] when exact precision is required.
+ It uses integer coordinates and is therefore preferable to [Vector2] when exact precision is required. Note that the values are limited to 32 bits, and unlike [Vector2] this cannot be configured with an engine build option. Use [int] or [PackedInt64Array] if 64-bit values are needed.
[b]Note:[/b] In a boolean context, a Vector2i will evaluate to [code]false[/code] if it's equal to [code]Vector2i(0, 0)[/code]. Otherwise, a Vector2i will always evaluate to [code]true[/code].
</description>
<tutorials>