2020-02-24 17:00:40 +01: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 17:16:10 +02: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 17:00:40 +01:00
</description>
<tutorials >
<link > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
</tutorials>
<methods >
<method name= "Vector2i" >
<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>
<method name= "Vector2i" >
<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-06-03 14:22:26 +02:00
<method name= "abs" >
<return type= "Vector2i" >
</return>
<description >
Returns a new vector with all components in absolute values (i.e. positive).
</description>
</method>
<method name= "aspect" >
<return type= "float" >
</return>
<description >
Returns the ratio of [member x] to [member y].
</description>
</method>
<method name= "sign" >
<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 17:00:40 +01:00
</methods>
2020-06-03 14:22:26 +02: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 17:00:40 +01: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>
<constant name= "ZERO" value= "Vector2i( 0, 0 )" >
Zero vector.
</constant>
<constant name= "ONE" value= "Vector2i( 1, 1 )" >
One vector.
</constant>
<constant name= "LEFT" value= "Vector2i( -1, 0 )" >
Left unit vector.
</constant>
<constant name= "RIGHT" value= "Vector2i( 1, 0 )" >
Right unit vector.
</constant>
<constant name= "UP" value= "Vector2i( 0, -1 )" >
Up unit vector.
</constant>
<constant name= "DOWN" value= "Vector2i( 0, 1 )" >
Down unit vector.
</constant>
</constants>
</class>
