7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
219 lines
7.5 KiB
XML
219 lines
7.5 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" />
|
|
<description>
|
|
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
|
|
</description>
|
|
</method>
|
|
<method name="Vector2i" qualifiers="constructor">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="from" type="Vector2i" />
|
|
<description>
|
|
Constructs a [Vector2i] as a copy of the given [Vector2i].
|
|
</description>
|
|
</method>
|
|
<method name="Vector2i" qualifiers="constructor">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="from" type="Vector2" />
|
|
<description>
|
|
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
|
|
</description>
|
|
</method>
|
|
<method name="Vector2i" qualifiers="constructor">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="x" type="int" />
|
|
<argument index="1" name="y" type="int" />
|
|
<description>
|
|
Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code].
|
|
</description>
|
|
</method>
|
|
<method name="abs" qualifiers="const">
|
|
<return type="Vector2i" />
|
|
<description>
|
|
Returns a new vector with all components in absolute values (i.e. positive).
|
|
</description>
|
|
</method>
|
|
<method name="aspect" qualifiers="const">
|
|
<return type="float" />
|
|
<description>
|
|
Returns the ratio of [member x] to [member y].
|
|
</description>
|
|
</method>
|
|
<method name="clamp" qualifiers="const">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="min" type="Vector2i" />
|
|
<argument index="1" name="max" type="Vector2i" />
|
|
<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="operator !=" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator %" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator %" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator *" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator *" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="float" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator *" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator +" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator -" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator /" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator /" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="float" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator /" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<argument index="0" name="right" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator <" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator <=" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator ==" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator >" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator >=" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator []" qualifiers="operator">
|
|
<return type="int" />
|
|
<argument index="0" name="index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator unary+" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator unary-" qualifiers="operator">
|
|
<return type="Vector2i" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="sign" qualifiers="const">
|
|
<return type="Vector2i" />
|
|
<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>
|