godot/doc/classes/Vector3i.xml
2020-02-25 15:27:29 +01:00

73 lines
2.0 KiB
XML

<?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.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
</tutorials>
<methods>
<method name="Vector3i">
<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="Vector3i">
<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>
</methods>
<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.
</constant>
<constant name="ONE" value="Vector3i( 1, 1, 1 )">
One vector.
</constant>
<constant name="LEFT" value="Vector3i( -1, 0, 0 )">
Left unit vector.
</constant>
<constant name="RIGHT" value="Vector3i( 1, 0, 0 )">
Right unit vector.
</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.
</constant>
<constant name="BACK" value="Vector3i( 0, 0, 1 )">
Back unit vector.
</constant>
</constants>
</class>