Version: 2019.2
LanguageEnglish
  • C#

Vector3Int

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Representation of 3D vectors and points using integers.

This structure is used in some places to represent 3D positions and vectors that don't require the precision of floating-point.

Static Properties

downShorthand for writing Vector3Int (0, -1, 0).
leftShorthand for writing Vector3Int (-1, 0, 0).
oneShorthand for writing Vector3Int (1, 1, 1).
rightShorthand for writing Vector3Int (1, 0, 0).
upShorthand for writing Vector3Int (0, 1, 0).
zeroShorthand for writing Vector3Int (0, 0, 0).

Properties

magnitudeReturns the length of this vector (Read Only).
sqrMagnitudeReturns the squared length of this vector (Read Only).
this[int]Access the x, y or z component using [0], [1] or [2] respectively.
xX component of the vector.
yY component of the vector.
zZ component of the vector.

Public Methods

ClampClamps the Vector3Int to the bounds given by min and max.
EqualsReturns true if the objects are equal.
GetHashCodeGets the hash code for the Vector3Int.
SetSet x, y and z components of an existing Vector3Int.
ToStringReturns a nicely formatted string for this vector.

Static Methods

CeilToIntConverts a Vector3 to a Vector3Int by doing a Ceiling to each value.
DistanceReturns the distance between a and b.
FloorToIntConverts a Vector3 to a Vector3Int by doing a Floor to each value.
MaxReturns a vector that is made from the largest components of two vectors.
MinReturns a vector that is made from the smallest components of two vectors.
RoundToIntConverts a Vector3 to a Vector3Int by doing a Round to each value.
ScaleMultiplies two vectors component-wise.

Operators

operator -Subtracts one vector from another.
operator !=Returns true if vectors different.
operator *Multiplies a vector by a number.
operator +Adds two vectors.
operator ==Returns true if the vectors are equal.
Unknown operatorConverts a Vector3Int to a Vector2Int.
Vector3Converts a Vector3Int to a Vector3.