godot/doc/classes/Vector2i.xml
2020-11-10 15:00:50 +01:00

257 lines
7.6 KiB
XML

<?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.
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].
</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="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<description>
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector2i" qualifiers="constructor">
<return type="Vector2i">
</return>
<argument index="0" name="from" type="Vector2i">
</argument>
<description>
Constructs a [Vector2i] as a copy of the given [Vector2i].
</description>
</method>
<method name="Vector2i" qualifiers="constructor">
<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>
<method name="Vector2i" qualifiers="constructor">
<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="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="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>
<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>
<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 &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" 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 &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" 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>
<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>
</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>
</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="ZERO" value="Vector2i( 0, 0 )">
Zero vector, a vector with all components set to [code]0[/code].
</constant>
<constant name="ONE" value="Vector2i( 1, 1 )">
One vector, a vector with all components set to [code]1[/code].
</constant>
<constant name="LEFT" value="Vector2i( -1, 0 )">
Left unit vector. Represents the direction of left.
</constant>
<constant name="RIGHT" value="Vector2i( 1, 0 )">
Right unit vector. Represents the direction of right.
</constant>
<constant name="UP" value="Vector2i( 0, -1 )">
Up unit vector. Y is down in 2D, so this vector points -Y.
</constant>
<constant name="DOWN" value="Vector2i( 0, 1 )">
Down unit vector. Y is down in 2D, so this vector points +Y.
</constant>
</constants>
</class>