CFrame

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

The 3D position of the CFrame.

A copy of the CFrame with no translation.

The X coordinate of the position.

The Y coordinate of the position.

The Z coordinate of the position.

The forward-direction component of the CFrame object's orientation, equivalent to the negated ZVector or the negated third column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.LookVector)     --> (-0, -0, -1)
print(-cf.ZVector)       --> (-0, -0, -1)
print(-R02, -R12, -R22)  --> (-0 -0 -1)

Adding a CFrame object's LookVector to itself produces a CFrame moved forward in whichever direction it's facing by 1 unit.

The right-direction component of the CFrame object's orientation. Equivalent to XVector or the first column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.RightVector)  --> (1, 0, 0)
print(cf.XVector)      --> (1, 0, 0)
print(R00, R10, R20)   --> (1 0 0)

The up-direction component of the CFrame object's orientation. Equivalent to YVector or the second column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.UpVector)    --> (0, 1, 0)
print(cf.YVector)     --> (0, 1, 0)
print(R01, R11, R21)  --> (0 1 0)

The X component of the CFrame object's orientation. Equivalent to RightVector or the first column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.XVector)      --> (1, 0, 0)
print(cf.RightVector)  --> (1, 0, 0)
print(R00, R10, R20)   --> (1 0 0)

The Y component of the CFrame object's orientation. Equivalent to UpVector or the second column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.YVector)     --> (0, 1, 0)
print(cf.UpVector)    --> (0, 1, 0)
print(R01, R11, R21)  --> (0 1 0)

The Z component of the CFrame object's orientation. Equivalent to the negated LookVector or the third column of the rotation matrix.

local cf = CFrame.new(0, 0, 0)
local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents()

print(cf.ZVector)      --> (0, 0, 1)
print(-cf.LookVector)  --> (0, 0, 1)
print(R02, R12, R22)   --> (0 0 1)

Returns the inverse of the CFrame.

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

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

Receives one or more CFrame objects and returns them transformed from object to world space. Equivalent to:

CFrame * cf

Receives one or more CFrame objects and returns them transformed from world to object space. Equivalent to:

CFrame:Inverse() * cf

Receives one or more Vector3 objects and returns them transformed from object to world space. Equivalent to:

CFrame * v3

Receives one or more Vector3 objects and returns them transformed from world to object space. Equivalent to:

CFrame:Inverse() * v3

Receives one or more Vector3 objects and returns them rotated from object to world space. Equivalent to:

(CFrame - CFrame.Position) * v3

Receives one or more Vector3 objects and returns them rotated from world to object space. Equivalent to:

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

Returns the values x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, and R22, where x y z represent the position of the CFrame and R00‑R22 represent its 3×3 rotation matrix.

Returns approximate angles that could be used to generate the CFrame using the optional Enum.RotationOrder. If you don't provide order, the method uses Enum.RotationOrder.XYZ.

Returns approximate angles that could be used to generate the CFrame using Enum.RotationOrder.XYZ.

Returns approximate angles that could be used to generate the CFrame using Enum.RotationOrder.YXZ.

Equivalent to CFrame:ToEulerAnglesYXZ().

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

Equivalent to CFrame:GetComponents().

Returns true if the other CFrame is sufficiently close to this CFrame in both position and rotation. The epsilon value is used to control the tolerance for this similarity; this value is optional and should be a small positive value if provided. The similarity for position is component-wise while rotation uses a fast approximation of the angle difference.

Returns the angle, in radians, between the orientation of one CFrame and another. This function does not take the position of either CFrame into account and only looks at the relative orientation.