1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Vector3i" version="4.0">
<brief_description>
Vector used for 3D math using integer coordinates.
</brief_description>
<description>
3-element structure that can be used to represent positions in 3D space or any other pair of numeric values.
It uses integer coordinates and is therefore preferable to [Vector3] when exact precision is required.
[b]Note:[/b] In a boolean context, a Vector3i will evaluate to [code]false[/code] if it's equal to [code]Vector3i(0, 0, 0)[/code]. Otherwise, a Vector3i will always evaluate to [code]true[/code].
</description>
<tutorials>
<link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
</tutorials>
<methods>
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<description>
Constructs a default-initialized [Vector3i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="from" type="Vector3i">
</argument>
<description>
Constructs a [Vector3i] as a copy of the given [Vector3i].
</description>
</method>
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<description>
Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Vector3i" qualifiers="constructor">
<return type="Vector3i">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
Returns a [Vector3i] with the given components.
</description>
</method>
<method name="abs" qualifiers="const">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="clamp" qualifiers="const">
<return type="Vector3i">
</return>
<argument index="0" name="min" type="Vector3i">
</argument>
<argument index="1" name="max" type="Vector3i">
</argument>
<description>
Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
</description>
</method>
<method name="max_axis" qualifiers="const">
<return type="int">
</return>
<description>
Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_X].
</description>
</method>
<method name="min_axis" qualifiers="const">
<return type="int">
</return>
<description>
Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</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="Vector3i">
</return>
<argument index="0" name="right" type="int">
</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="Vector3i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="int">
</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="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</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="Vector3i">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="Vector3i">
</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="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator <=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator >" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator >=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="operator unary+" qualifiers="operator">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="operator unary-" qualifiers="operator">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="sign" qualifiers="const">
<return type="Vector3i">
</return>
<description>
Returns the vector with each component set to one or negative one, depending on the signs of the components.
</description>
</method>
</methods>
<members>
<member name="x" type="int" setter="" getter="" default="0">
The vector's X component. Also accessible by using the index position [code][0][/code].
</member>
<member name="y" type="int" setter="" getter="" default="0">
The vector's Y component. Also accessible by using the index position [code][1][/code].
</member>
<member name="z" type="int" setter="" getter="" default="0">
The vector's Z component. Also accessible by using the index position [code][2][/code].
</member>
</members>
<constants>
<constant name="AXIS_X" value="0">
Enumerated value for the X axis.
</constant>
<constant name="AXIS_Y" value="1">
Enumerated value for the Y axis.
</constant>
<constant name="AXIS_Z" value="2">
Enumerated value for the Z axis.
</constant>
<constant name="ZERO" value="Vector3i(0, 0, 0)">
Zero vector, a vector with all components set to [code]0[/code].
</constant>
<constant name="ONE" value="Vector3i(1, 1, 1)">
One vector, a vector with all components set to [code]1[/code].
</constant>
<constant name="LEFT" value="Vector3i(-1, 0, 0)">
Left unit vector. Represents the local direction of left, and the global direction of west.
</constant>
<constant name="RIGHT" value="Vector3i(1, 0, 0)">
Right unit vector. Represents the local direction of right, and the global direction of east.
</constant>
<constant name="UP" value="Vector3i(0, 1, 0)">
Up unit vector.
</constant>
<constant name="DOWN" value="Vector3i(0, -1, 0)">
Down unit vector.
</constant>
<constant name="FORWARD" value="Vector3i(0, 0, -1)">
Forward unit vector. Represents the local direction of forward, and the global direction of north.
</constant>
<constant name="BACK" value="Vector3i(0, 0, 1)">
Back unit vector. Represents the local direction of back, and the global direction of south.
</constant>
</constants>
</class>
|