2020-02-24 16:00:40 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "Vector2i" version= "4.0" >
<brief_description >
Vector used for 2D math using integer coordinates.
</brief_description>
<description >
2-element structure that can be used to represent positions in 2D space or any other pair of numeric values.
2020-06-21 15:16:10 +00:00
It uses integer coordinates and is therefore preferable to [Vector2] when exact precision is required.
[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].
2020-02-24 16:00:40 +00:00
</description>
<tutorials >
2020-08-05 12:43:40 +00:00
<link title= "Math tutorial index" > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2020-10-01 08:34:47 +00:00
<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>
2020-02-24 16:00:40 +00:00
</tutorials>
<methods >
2020-11-10 13:16:20 +00:00
<method name= "Vector2i" qualifiers= "constructor" >
2020-02-24 16:00:40 +00:00
<return type= "Vector2i" >
</return>
2020-11-09 16:46:03 +00:00
<description >
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2i" qualifiers= "constructor" >
2020-11-09 16:46:03 +00:00
<return type= "Vector2i" >
</return>
<argument index= "0" name= "from" type= "Vector2i" >
2020-02-24 16:00:40 +00:00
</argument>
<description >
2020-11-09 16:46:03 +00:00
Constructs a [Vector2i] as a copy of the given [Vector2i].
2020-02-24 16:00:40 +00:00
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2i" qualifiers= "constructor" >
2020-02-24 16:00:40 +00:00
<return type= "Vector2i" >
</return>
<argument index= "0" name= "from" type= "Vector2" >
</argument>
<description >
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2i" qualifiers= "constructor" >
2020-11-09 16:46:03 +00:00
<return type= "Vector2i" >
</return>
<argument index= "0" name= "x" type= "int" >
</argument>
<argument index= "1" name= "y" type= "int" >
</argument>
<description >
Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code].
</description>
</method>
2021-03-18 13:44:42 +00:00
<method name= "abs" qualifiers= "const" >
2020-06-03 12:22:26 +00:00
<return type= "Vector2i" >
</return>
<description >
Returns a new vector with all components in absolute values (i.e. positive).
</description>
</method>
2021-03-18 13:44:42 +00:00
<method name= "aspect" qualifiers= "const" >
2020-06-03 12:22:26 +00:00
<return type= "float" >
</return>
<description >
Returns the ratio of [member x] to [member y].
</description>
</method>
2021-02-01 05:10:52 +00:00
<method name= "clamp" qualifiers= "const" >
<return type= "Vector2i" >
</return>
<argument index= "0" name= "min" type= "Vector2i" >
</argument>
<argument index= "1" name= "max" type= "Vector2i" >
</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>
2020-11-10 13:16:20 +00:00
<method name= "operator !=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</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= "Vector2i" >
</return>
<argument index= "0" name= "right" type= "int" >
</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= "Vector2i" >
</return>
<argument index= "0" name= "right" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
<return type= "Vector2i" >
</return>
<argument index= "0" name= "right" type= "int" >
</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= "Vector2i" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</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= "Vector2i" >
</return>
<argument index= "0" name= "right" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "operator /" qualifiers= "operator" >
<return type= "Vector2i" >
</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= "Vector2i" >
</argument>
<description >
</description>
</method>
<method name= "operator <=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</argument>
<description >
</description>
</method>
<method name= "operator ==" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</argument>
<description >
</description>
</method>
<method name= "operator >" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</argument>
<description >
</description>
</method>
<method name= "operator >=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2i" >
</argument>
<description >
</description>
</method>
<method name= "operator []" qualifiers= "operator" >
<return type= "int" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
2021-06-19 15:58:49 +00:00
<method name= "operator unary+" qualifiers= "operator" >
<return type= "Vector2i" >
</return>
<description >
</description>
</method>
<method name= "operator unary-" qualifiers= "operator" >
<return type= "Vector2i" >
</return>
<description >
</description>
</method>
2021-03-18 13:44:42 +00:00
<method name= "sign" qualifiers= "const" >
2020-06-03 12:22:26 +00:00
<return type= "Vector2i" >
</return>
<description >
Returns the vector with each component set to one or negative one, depending on the signs of the components.
</description>
</method>
2020-02-24 16:00:40 +00:00
</methods>
2020-06-03 12:22:26 +00:00
<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>
</members>
2020-02-24 16:00:40 +00:00
<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>
2019-09-24 17:45:03 +00:00
<constant name= "ZERO" value= "Vector2i(0, 0)" >
2020-07-21 18:07:00 +00:00
Zero vector, a vector with all components set to [code]0[/code].
2020-02-24 16:00:40 +00:00
</constant>
2019-09-24 17:45:03 +00:00
<constant name= "ONE" value= "Vector2i(1, 1)" >
2020-07-21 18:07:00 +00:00
One vector, a vector with all components set to [code]1[/code].
2020-02-24 16:00:40 +00:00
</constant>
2019-09-24 17:45:03 +00:00
<constant name= "LEFT" value= "Vector2i(-1, 0)" >
2020-07-21 18:07:00 +00:00
Left unit vector. Represents the direction of left.
2020-02-24 16:00:40 +00:00
</constant>
2019-09-24 17:45:03 +00:00
<constant name= "RIGHT" value= "Vector2i(1, 0)" >
2020-07-21 18:07:00 +00:00
Right unit vector. Represents the direction of right.
2020-02-24 16:00:40 +00:00
</constant>
2019-09-24 17:45:03 +00:00
<constant name= "UP" value= "Vector2i(0, -1)" >
2020-07-21 18:07:00 +00:00
Up unit vector. Y is down in 2D, so this vector points -Y.
2020-02-24 16:00:40 +00:00
</constant>
2019-09-24 17:45:03 +00:00
<constant name= "DOWN" value= "Vector2i(0, 1)" >
2020-07-21 18:07:00 +00:00
Down unit vector. Y is down in 2D, so this vector points +Y.
2020-02-24 16:00:40 +00:00
</constant>
</constants>
</class>
