Creates a blank identity `Datatype.CFrame`.

CFrame.new

Returns a blank identity `Datatype.CFrame`.

Returns a `Datatype.CFrame` with no rotation with the position of the provided
`Datatype.Vector3`.

Returns a new `Datatype.CFrame` located at `pos` and facing towards `lookAt`,
assuming that (0,&nbsp;1,&nbsp;0) is considered "up" in world space.

This constructor overload has been replaced by `Datatype.CFrame.lookAt()` which
accomplishes a similar goal. It remains for the sake of backward
compatibility.

At high pitch angles (around 82 degrees), you may experience numerical
instability. If this is an issue, or if you require a different "up" vector,
it's recommended you use `Datatype.CFrame.fromMatrix()` to more accurately
construct the `Datatype.CFrame`. Additionally, if `lookAt` is directly above `pos`
(pitch angle of 90 degrees) the "up" vector switches to the X axis.

lookAt

Returns a `Datatype.CFrame` with the position of the first `Datatype.Vector3` and an orientation
pointed toward the second.

Returns a `Datatype.CFrame` with a position comprised of the provided X, Y, and Z components.

Returns a `Datatype.CFrame` from position (`x`,&nbsp;`y`,&nbsp;`z`) and
quaternion (`qX`,&nbsp;`qY`,&nbsp;`qZ`,&nbsp;`qW`).

Creates a `Datatype.CFrame` from position (`x`,&nbsp;`y`,&nbsp;`z`) with an orientation specified by
the rotation matrix:

`[[R00 R01 R02] [R10 R11 R12] [R20 R21 R22]]`

Returns a `Datatype.CFrame` from position (`x`,&nbsp;`y`,&nbsp;`z`) with an orientation specified by
the rotation matrix.

Returns a new `Datatype.CFrame` with the position of `at` and facing towards `lookAt`,
optionally specifying the upward direction with default of (0,&nbsp;1,&nbsp;0).

This constructor replaces the `CFrame.new(Vector3, Vector3)` constructor
which accomplished a similar task, and this constructor lets you specify the
`up` vector, using the same default as the old constructor.

CFrame.lookAt

Returns a `Datatype.CFrame` with the position of the first Vector3 and an
orientation pointed toward the second.

Returns a rotated `Datatype.CFrame` using angles (`rx`,&nbsp;`ry`,&nbsp;`rz`) in radians. Rotations
are applied in Z,&nbsp;Y,&nbsp;X order.

CFrame.fromEulerAnglesXYZ

Returns a rotated `Datatype.CFrame` using angles (`rx`,&nbsp;`ry`,&nbsp;`rz`) in radians. Rotations
are applied in Z,&nbsp;X,&nbsp;Y order.

CFrame.fromEulerAnglesYXZ

Equivalent to `Datatype.CFrame.fromEulerAnglesXYZ()`.

CFrame.Angles

Equivalent to `Datatype.CFrame.fromEulerAnglesYXZ()`.

CFrame.fromOrientation

Returns a rotated `Datatype.CFrame` from a unit `Datatype.Vector3` and a rotation in radians.

CFrame.fromAxisAngle

Returns a `Datatype.CFrame` from a translation and the columns of a rotation
matrix. If `vZ` is excluded, the third column is calculated as
`vX:Cross(vY).Unit`.

CFrame.fromMatrix

Returns a `Datatype.CFrame` from a translation and the columns of a rotation matrix.

The `Datatype.CFrame` data type, short for **coordinate frame**, describes a
3D position and orientation. It is made up of a **positional** component and a
**rotational** component. It includes essential arithmetic operations for
working with 3D data on Roblox.

```lua
-- Create a CFrame at a certain position and Euler rotation (XYZ).
local cf = CFrame.new(0, 5, 0) * CFrame.fromEulerAnglesXYZ(math.rad(45), 0, 0)
```

For an introduction to the `Datatype.CFrame` data type, see
[CFrames](/building-and-visuals/studio-modeling/cframes).

#### Positional Component

The positional component is available as a `Datatype.Vector3`. In addition,
the components of a `Datatype.CFrame` object's position are also available in
the `Datatype.CFrame.X|X`, `Datatype.CFrame.Y|Y` and `Datatype.CFrame.Z|Z`
properties like a `Datatype.Vector3`.

#### Rotational Component

`Datatype.CFrame` stores 3D rotation data in a 3&times;3 **rotation
matrix**. These values are returned by the `Datatype.CFrame:GetComponents()`
function after the `x`, `y` and `z` positional values. This matrix is used
internally when doing calculations involving rotations, using **radians** as
their unit (for conversion from one to the other, use `Library.math.rad()` or
`Library.math.deg()`).

The table below represents the components of a `Datatype.CFrame` object's
rotation matrix and their relationship with the available vector properties
such as `Datatype.CFrame.LookVector|LookVector` and
`Datatype.CFrame.RightVector|RightVector`. Although the individual components
of the rotation matrix are rarely useful by themselves, the vector properties
which derive from them are much more useful.

<table>
  <thead>
    <tr>
      <td></td>
      <td>RightVector</td>
      <td>UpVector</td>
      <td>&ndash;LookVector<sup>&dagger;</sup></td>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><b>XVector</b></td>
      <td>R00</td>
      <td>R01</td>
      <td>R02</td>
    </tr>
    <tr>
      <td><b>YVector</b></td>
      <td>R10</td>
      <td>R11</td>
      <td>R12</td>
    </tr>
    <tr>
      <td><b>ZVector</b></td>
      <td>R20</td>
      <td>R21</td>
      <td>R22</td>
    </tr>
  </tbody>
</table>

<sup>&dagger;</sup> Unlike `Datatype.CFrame.RightVector|RightVector` and
`Datatype.CFrame.UpVector|UpVector`, `Datatype.CFrame.LookVector|LookVector`
represents the **negated** right/third column components.

#### Math Operations

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

<table>
  <thead>
    <tr>
      <td>Operation</td>
      <td>Description</td>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>Datatype.CFrame</code>&nbsp;<code>*</code>&nbsp;<code>Datatype.CFrame</code></td>
      <td>Produces a new <code>Datatype.CFrame</code> representing the composition of the two <code>Datatype.CFrame|CFrames</code>.</td>
    </tr>
    <tr>
      <td><code>Datatype.CFrame</code>&nbsp;<code>*</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.Vector3</code> transformed from object to world coordinates.</td>
    </tr>
    <tr>
      <td><code>Datatype.CFrame</code>&nbsp;<code>+</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.CFrame</code> translated in world space by the <code>Datatype.Vector3</code>.</td>
    </tr>
    <tr>
      <td><code>Datatype.CFrame</code>&nbsp;<code>-</code>&nbsp;<code>Datatype.Vector3</code></td>
      <td>Produces a <code>Datatype.CFrame</code> translated in world space by the negative <code>Datatype.Vector3</code>.</td>
    </tr>
  </tbody>
</table>


Produces a new `Datatype.CFrame` representing the composition of the two `Datatype.CFrame|CFrames`.


Produces a `Datatype.Vector3` transformed from object to world coordinates.


Produces a `Datatype.CFrame` translated in world space by the `Datatype.Vector3`.


Produces a `Datatype.CFrame` translated in world space by the negative `Datatype.Vector3`.


Returns the inverse of the `Datatype.CFrame`.


CFrame:Inverse

Returns a `Datatype.CFrame` interpolated between itself and `goal` by the
fraction `alpha`.


CFrame:Lerp

goal

alpha

Returns an orthonormalized copy of the `Datatype.CFrame`. The `Class.BasePart.CFrame`
property automatically applies orthonormalization, but other APIs which
take `Datatype.CFrame|CFrames` do not, so this method is occasionally necessary when
incrementally updating a `Datatype.CFrame` and using it with them.


CFrame:Orthonormalize

Returns an orthonormalized copy of the `Datatype.CFrame`.


Returns a `Datatype.CFrame` transformed from object to world space. Equivalent to:

`CFrame * cf`


CFrame:ToWorldSpace

Returns a `Datatype.CFrame` transformed from object to world space.


Returns a `Datatype.CFrame` transformed from world to object space. Equivalent to:

`CFrame:Inverse() * cf`


CFrame:ToObjectSpace

Returns a `Datatype.CFrame` transformed from world to object space.


Returns a `Datatype.Vector3` transformed from object to world space. Equivalent to:

`CFrame * v3`


CFrame:PointToWorldSpace

Returns a `Datatype.Vector3` transformed from object to world space.


Returns a `Datatype.Vector3` transformed from world to object space. Equivalent to:

`CFrame:Inverse() * v3`


CFrame:PointToObjectSpace

Returns a `Datatype.Vector3` transformed from world to object space.


Returns a `Datatype.Vector3` rotated from object to world space. Equivalent to:

`(CFrame - CFrame.Position) * v3`


CFrame:VectorToWorldSpace

Returns a `Datatype.Vector3` rotated from object to world space.


Returns a `Datatype.Vector3` rotated from world to object space. Equivalent to:

`(CFrame:Inverse() - CFrame:Inverse().Position) * v3`


CFrame:VectorToObjectSpace

Returns a `Datatype.Vector3` rotated from world to object space.


Returns the values `x`, `y`, `z`, `R00`, `R01`, `R02`, `R10`, `R11`, `R12`, `R20`, `R21`, `R22`
where `R00`-`R22` represent the 3&times;3 rotation matrix of the `Datatype.CFrame`, and `x` `y` `z`
represent its position.


CFrame:GetComponents

Returns approximate angles that could be used to generate the `Datatype.CFrame` if
angles were applied in Z,&nbsp;Y,&nbsp;X order.


CFrame:ToEulerAnglesXYZ

Returns approximate angles that could be used to generate the `Datatype.CFrame` if
angles were applied in Z,&nbsp;X,&nbsp;Y order.


CFrame:ToEulerAnglesYXZ

CFrame:ToOrientation

Returns a tuple of a `Datatype.Vector3` and a number which represent the rotation of
the `Datatype.CFrame` in the axis-angle representation.


CFrame:ToAxisAngle

Equivalent to `Datatype.CFrame:GetComponents()`.


CFrame:components

CFrame

An identity `Datatype.CFrame` with no translation or rotation. This
property is a **constant** and must be accessed globally as opposed to
through an individual `Datatype.CFrame` object.

```lua
print(CFrame.identity)  --> 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1
```


CFrame.identity

An identity `Datatype.CFrame` with no translation or rotation.


The 3D position of the `Datatype.CFrame`.


CFrame.Position

A copy of the `Datatype.CFrame` with no translation.


CFrame.Rotation

CFrame.X

CFrame.Y

CFrame.Z

The forward-direction component of the `Datatype.CFrame` object's orientation. Equivalent
to:

`Vector3.new(-r20, -r21, -r22)`

Adding a `Datatype.CFrame` object's `Datatype.CFrame.LookVector` to itself produces a `Datatype.CFrame` moved
forward in whichever direction the `Datatype.CFrame` is facing by 1 unit:

```lua
cf = cf + cf.LookVector * n  -- Move CFrame forward "n" units
```


CFrame.LookVector

The forward-direction component of the `Datatype.CFrame` object's orientation.


The right-direction component of the `Datatype.CFrame` object's orientation. Equivalent to
the first/left column of the rotation matrix, or:

`Vector3.new(r00, r01, r02)`


CFrame.RightVector

The right-direction component of the `Datatype.CFrame` object's orientation.


The up-direction component of the `Datatype.CFrame` object's orientation. Equivalent to the
second/middle column of the rotation matrix, or:

`Vector3.new(r10, r11, r12)`


CFrame.UpVector

The up-direction component of the `Datatype.CFrame` object's orientation.


Equivalent to the first row of the rotation matrix, or:

`Vector3.new(r00, r01, r02)`


CFrame.XVector

Equivalent to the first row of the rotation matrix.


Equivalent to the second/middle row of the rotation matrix, or:

`Vector3.new(r10, r11, r12)`


CFrame.YVector

Equivalent to the second/middle row of the rotation matrix.


Equivalent to the third/bottom row of the rotation matrix, or:

`Vector3.new(r20, r21, r22)`


CFrame.ZVector

Equivalent to the third/bottom row of the rotation matrix.


A data type that represents both a 3D position and orientation.


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}

Unable to add to inventory

The code sample {title} has been added to your Inventory.

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.

CFrame

Summary

Constructors

Properties

Methods

Math Operations

Constructors

new

new

Parameters

new

Parameters

new

Parameters

new

Parameters

new

Parameters

lookAt

Parameters

fromEulerAnglesXYZ

Parameters

fromEulerAnglesYXZ

Parameters

Angles

Parameters

fromOrientation

Parameters

fromAxisAngle

Parameters

fromMatrix

Parameters

Properties

identity

Position

Rotation

X

Y

Z

LookVector

RightVector

UpVector

XVector

YVector

ZVector

Methods

Inverse

Returns

Lerp

Parameters

Returns

Orthonormalize

Returns

ToWorldSpace

Parameters

Returns

ToObjectSpace

Parameters

Returns

PointToWorldSpace

Parameters

Returns

PointToObjectSpace

Parameters

Returns

VectorToWorldSpace

Parameters

Returns

VectorToObjectSpace

Parameters

Returns

GetComponents

Returns

ToEulerAnglesXYZ

Returns

ToEulerAnglesYXZ

Returns

ToOrientation

Returns

ToAxisAngle