Vector3Int
Representation of 3D vectors and points using integers.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Implements: IEquatable<Vector3Int>, IFormattable
public struct Vector3Int : IEquatable<Vector3Int>, IFormattable
Remarks
This structure is used in some places to represent 3D positions and vectors that don't require the precision of floating-point.
Constructors
Constructor | Description |
|---|---|
| Vector3Int(System.Int32,System.Int32) | Initializes and returns an instance of a new Vector3Int with x and y components and sets |
| Vector3Int(System.Int32,System.Int32,System.Int32) | Initializes and returns an instance of a new Vector3Int with x, y, z components. |
Properties
Property | Description |
|---|---|
| this[] | Access the |
| magnitude | Returns the length of this vector (Read Only). |
| sqrMagnitude | Returns the squared length of this vector (Read Only). |
| x | X component of the vector. |
| y | Y component of the vector. |
| z | Z component of the vector. |
Static Properties
Property | Description |
|---|---|
| back | The unit vector in the negative z direction |
| down | Shorthand for writing |
| forward | Shorthand for writing |
| left | Shorthand for writing |
| one | Shorthand for writing |
| right | Shorthand for writing |
| up | Shorthand for writing |
| zero | Shorthand for writing |
Methods
Method | Description |
|---|---|
| Clamp | Clamps the |
| Equals | Determines if an object is equal to this vector. |
| GetHashCode | Gets the hash code for the |
| Scale | Multiplies every component of this vector by the same component of |
| Set | Set x, y and z components of an existing Vector3Int. |
| ToString | Formats this vector as a string. |
Static Methods
Method | Description |
|---|---|
| CeilToInt | Converts a Vector3 to a Vector3Int by doing a Ceiling to each value. |
| Distance | Calculates the distance between two given vectors. |
| FloorToInt | Converts a given Vector3 into a |
| Max | Creates a vector that is made from the largest components of two vectors. |
| Min | Creates a vector that is made from the smallest components of two vectors. |
| RoundToInt | Converts a Vector3 to a Vector3Int by doing a Round to each value. |
| Scale | Multiplies two vectors component-wise. |
Operators
Operator | Description |
|---|---|
| operator + | Adds two vectors. |
| operator / | Divides a vector by a number. |
| operator == | Returns true if the vectors are equal. |
| Vector2Int | Converts a Vector3Int into a Vector2Int. |
| Vector3Int | Converts an int3 to Vector3Int. |
| int3 | Converts a Vector3Int to int3. |
| Vector3 | Converts a Vector3Int to a Vector3. |
| operator != | Returns true if the vectors are different. |
| operator * | Multiplies a vector by a number. |
| operator - | Subtracts one vector from another. |