Returns a new `Datatype.Vector3` using the given x, y, and z components.

Vector3.new

Returns a new `Datatype.Vector3` from the given x, y, and z components.

Returns a new `Datatype.Vector3` in the given direction.

Vector3.FromNormalId

normal

Returns a new `Datatype.Vector3` for the given axis.

Vector3.FromAxis

axis

The `Datatype.Vector3` data type represents a vector in 3D space, typically
usually used as a point in 3D space or the dimensions of a rectangular prism.
`Datatype.Vector3` supports basic component-based arithmetic operations (sum,
difference, product, and quotient) and these operations can be applied on the
left or right hand side to either another `Datatype.Vector3` or a number. It
also features methods for common vector operations, such as
`Datatype.Vector3:Cross()|Cross()` and `Datatype.Vector3:Dot()|Dot()`.

Some example usages of `Datatype.Vector3` are the
`Class.BasePart.Position|Position`, `Class.BasePart.Rotation|Rotation`, and
`Class.BasePart.Size|Size` of parts, for example:

```lua
local part = workspace.Part
part.Position = part.Position + Vector3.new(5, 2, 10)  -- Move part by (5, 2, 10)
```

`Datatype.Vector3` is also commonly used when constructing more complex 3D
data types such as `Datatype.CFrame`. Many of these data types' methods will
use a `Datatype.Vector3` within their parameters, such as
`Datatype.CFrame:PointToObjectSpace()`.

#### Math Operations

The following math operations are valid for the `Datatype.Vector3` data type:

<table>
  <thead>
    <tr>
      <td>Operation</td>
      <td>Description</td>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>+</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component of the second added to the corresponding component of the first.</td>
    </tr>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>-</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component of the second subtracted from the corresponding component of the first.</td>
    </tr>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>*</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component of the second multiplied by the corresponding component of the first.</td>
    </tr>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>/</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component of the first divided by the corresponding component of the second.</td>
    </tr>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>*</code>&nbsp;<code>number</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component multiplied by the number.</td>
    </tr>
    <tr>
      <td><code>Datatype.Vector3</code>&nbsp;<code>/</code>&nbsp;<code>number</code></td>
      <td>Produces a <code>Datatype.Vector3</code> with each component divided by the number.</td>
    </tr>
  </tbody>
</table>


Produces a `Datatype.Vector3` with each component of the second added to
the corresponding component of the first.


Produces a `Datatype.Vector3` with each component of the second subtracted
from the corresponding component of the first.


Produces a `Datatype.Vector3` with each component of the second multiplied
by the corresponding component of the first.


Produces a `Datatype.Vector3` with each component of the first divided by
the corresponding component of the second.


Produces a `Datatype.Vector3` with each component multiplied by the
number.


Produces a `Datatype.Vector3` with each component divided by the number.


Returns the cross product of the two vectors.


Vector3:Cross

other

Returns the angle in radians between the two vectors. If an axis is
provided, it determines the sign of the angle.


Vector3:Angle

Returns a scalar dot product of the two vectors.


Vector3:Dot

Returns `true` if the X, Y, and Z components of the other
`Datatype.Vector3` are within epsilon units of each corresponding
component of this `Datatype.Vector3`.


Vector3:FuzzyEq

epsilon

Returns a `Datatype.Vector3` linearly interpolated between this
`Datatype.Vector3` and the given `goal` `Datatype.Vector3` by the fraction
`alpha`.

Note: the `alpha` value is **not** limited to the range [0, 1].


Vector3:Lerp

goal

alpha

Returns a `Datatype.Vector3` linearly interpolated between this
`Datatype.Vector3` and the given goal by the given alpha.


Returns a `Datatype.Vector3` with each component as the highest among the
respective components of both provided `Datatype.Vector3` objects.

```lua
local a = Vector3.new(1, 2, 1)
local b = Vector3.new(2, 1, 2)

print(a:Max(b))  --> Vector3.new(2, 2, 2)
```


Vector3:Max

vector

Returns a `Datatype.Vector3` with each component as the highest among the
respective components of both provided `Datatype.Vector3` objects.


Returns a `Datatype.Vector3` with each component as the lowest among the
respective components of both provided `Datatype.Vector3` objects.

```lua
local a = Vector3.new(1, 2, 1)
local b = Vector3.new(2, 1, 2)

print(a:Min(b))  --> Vector3.new(1, 1, 1)
```


Vector3:Min

Returns a `Datatype.Vector3` with each component as the lowest among the
respective components of both provided `Datatype.Vector3` objects.


Vector3

A `Datatype.Vector3` with a magnitude of zero.

This API member is a **constant**, and must be accessed through the
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
object.

```lua
print(Vector3.zero) --> 0, 0, 0
```


Vector3.zero

A `Datatype.Vector3` with a magnitude of zero.


A `Datatype.Vector3` with a value of 1 on every axis.

This API member is a **constant**, and must be accessed through the
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
object.

```lua
print(Vector3.one)  --> 1, 1, 1
```


Vector3.one

A `Datatype.Vector3` with a value of 1 on every axis.


A `Datatype.Vector3` with a value of 1 on the X axis.

This API member is a **constant**, and must be accessed through the
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
object.

```lua
print(Vector3.xAxis)  --> 1, 0, 0
```


Vector3.xAxis

A `Datatype.Vector3` with a value of 1 on the X axis.


A `Datatype.Vector3` with a value of 1 on the Y axis.

This API member is a **constant**, and must be accessed through the
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
object.

```lua
print(Vector3.yAxis)  --> 0, 1, 0
```


Vector3.yAxis

A `Datatype.Vector3` with a value of 1 on the Y axis.


A `Datatype.Vector3` with a value of 1 on the Z axis.

This API member is a **constant**, and must be accessed through the
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
object.

```lua
print(Vector3.zAxis)  --> 0, 0, 1
```


Vector3.zAxis

A `Datatype.Vector3` with a value of 1 on the Z axis.


Vector3.X

Vector3.Y

Vector3.Z

Vector3.Magnitude

A normalized copy of the `Datatype.Vector3` - one that has the same
direction as the original but a magnitude of 1.


Vector3.Unit

Represents a 3D value with a direction and magnitude.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

Vector3

Summary

Constructors

Properties

Methods

Math Operations

Constructors

new

Parameters

FromNormalId

Parameters

FromAxis

Parameters

Properties

zero

one

xAxis

yAxis

zAxis

X

Y

Z

Magnitude

Unit

Methods

Cross

Parameters

Returns

Angle

Parameters

Returns

Dot

Parameters

Returns

FuzzyEq

Parameters

Returns

Lerp

Parameters

Returns

Max

Parameters

Returns

Min

Parameters

Returns

Math Operations