CFrame | Documentation - Roblox Creator Hub

Engine Data Type

CFrame

Summary

Constructors

new()

new(pos: Vector3)

new(pos: Vector3,lookAt: Vector3)

new(x: number,y: number,z: number)

new(x: number,y: number,z: number,qX: number,qY: number,qZ: number,qW: number)

new(x: number,y: number,z: number,R00: number,R01: number,R02: number,R10: number,R11: number,R12: number,R20: number,R21: number,R22: number)

lookAt(at: Vector3,lookAt: Vector3,up: Vector3)

lookAlong(at: Vector3,direction: Vector3,up: Vector3)

fromRotationBetweenVectors(from: Vector3,to: Vector3)

fromEulerAngles(rx: number,ry: number,rz: number,order: Enum.RotationOrder)

fromEulerAnglesXYZ(rx: number,ry: number,rz: number)

fromEulerAnglesYXZ(rx: number,ry: number,rz: number)

Angles(rx: number,ry: number,rz: number)

fromOrientation(rx: number,ry: number,rz: number)

fromAxisAngle(v: Vector3,r: number)

fromMatrix(pos: Vector3,vX: Vector3,vY: Vector3,vZ: Vector3)

Properties

Methods

Lerp(goal: CFrame,alpha: number):CFrame

Orthonormalize():CFrame

ToWorldSpace(...: Tuple<CFrame>):Tuple<CFrame>

ToObjectSpace(...: Tuple<CFrame>):Tuple<CFrame>

PointToWorldSpace(...: Tuple<Vector3>):Tuple<Vector3>

PointToObjectSpace(...: Tuple<Vector3>):Tuple<Vector3>

VectorToWorldSpace(...: Tuple<Vector3>):Tuple<Vector3>

VectorToObjectSpace(...: Tuple<Vector3>):Tuple<Vector3>

GetComponents():Tuple

ToEulerAngles(order: Enum.RotationOrder):number,number,number

ToEulerAnglesXYZ():number,number,number

ToEulerAnglesYXZ():number,number,number

ToOrientation():number,number,number

ToAxisAngle():Vector3,number

components():Tuple

FuzzyEq(other: CFrame,epsilon: number):boolean

AngleBetween(other: CFrame):number

Math Operations

API Reference

Constructors

new

CFrame.new()

new

CFrame.new(pos:Vector3)

Parameters

pos:Vector3

new

CFrame.new(

pos:Vector3, lookAt:Vector3)

Parameters

pos:Vector3

lookAt:Vector3

new

CFrame.new(

x:number, y:number, z:number)

Parameters

x:number

y:number

z:number

new

CFrame.new(

x:number, y:number, z:number, qX:number, qY:number, qZ:number, qW:number)

Parameters

x:number

y:number

z:number

qX:number

qY:number

qZ:number

qW:number

new

CFrame.new(

x:number, y:number, z:number, R00:number, R01:number, R02:number, R10:number, R11:number, R12:number, R20:number, R21:number, R22:number)

Parameters

x:number

y:number

z:number

R00:number

R01:number

R02:number

R10:number

R11:number

R12:number

R20:number

R21:number

R22:number

lookAt

CFrame.lookAt(

at:Vector3, lookAt:Vector3, up:Vector3)

Parameters

at:Vector3

lookAt:Vector3

up:Vector3

Default Value: Vector3.yAxis

lookAlong

CFrame.lookAlong(

at:Vector3, direction:Vector3, up:Vector3)

Parameters

at:Vector3

direction:Vector3

up:Vector3

Default Value: Vector3.yAxis

fromRotationBetweenVectors

CFrame.fromRotationBetweenVectors(

from:Vector3, to:Vector3)

Parameters

from:Vector3

to:Vector3

fromEulerAngles

CFrame.fromEulerAngles(

rx:number, ry:number, rz:number, order:Enum.RotationOrder)

Parameters

rx:number

ry:number

rz:number

order:Enum.RotationOrder

Default Value: Enum.RotationOrder.XYZ

fromEulerAnglesXYZ

CFrame.fromEulerAnglesXYZ(

rx:number, ry:number, rz:number)

Parameters

rx:number

ry:number

rz:number

fromEulerAnglesYXZ

CFrame.fromEulerAnglesYXZ(

rx:number, ry:number, rz:number)

Parameters

rx:number

ry:number

rz:number

Angles

CFrame.Angles(

rx:number, ry:number, rz:number)

Parameters

rx:number

ry:number

rz:number

fromOrientation

CFrame.fromOrientation(

rx:number, ry:number, rz:number)

Parameters

rx:number

ry:number

rz:number

fromAxisAngle

CFrame.fromAxisAngle(

v:Vector3, r:number)

Parameters

v:Vector3

r:number

fromMatrix

CFrame.fromMatrix(

pos:Vector3, vX:Vector3, vY:Vector3, vZ:Vector3)

Parameters

pos:Vector3

vX:Vector3

vY:Vector3

vZ:Vector3

Properties

identity

CFrame.identity:CFrame

Position

CFrame.Position:Vector3

Rotation

CFrame.Rotation:CFrame

CFrame.X:number

CFrame.Y:number

CFrame.Z:number

LookVector

CFrame.LookVector:Vector3

RightVector

CFrame.RightVector:Vector3

UpVector

CFrame.UpVector:Vector3

XVector

CFrame.XVector:Vector3

YVector

CFrame.YVector:Vector3

ZVector

CFrame.ZVector:Vector3

Methods

Inverse

CFrame:Inverse():CFrame

Returns

CFrame

Lerp

CFrame:Lerp(

goal:CFrame, alpha:number

):CFrame

Parameters

goal:CFrame

alpha:number

Returns

CFrame

Orthonormalize

CFrame:Orthonormalize():CFrame

Returns

CFrame

ToWorldSpace

CFrame:ToWorldSpace(...:Tuple<CFrame>):Tuple<CFrame>

Parameters

...:Tuple<CFrame>

Returns

Tuple<CFrame>

ToObjectSpace

CFrame:ToObjectSpace(...:Tuple<CFrame>):Tuple<CFrame>

Parameters

...:Tuple<CFrame>

Returns

Tuple<CFrame>

PointToWorldSpace

CFrame:PointToWorldSpace(...:Tuple<Vector3>):Tuple<Vector3>

Parameters

...:Tuple<Vector3>

Returns

Tuple<Vector3>

PointToObjectSpace

CFrame:PointToObjectSpace(...:Tuple<Vector3>):Tuple<Vector3>

Parameters

...:Tuple<Vector3>

Returns

Tuple<Vector3>

VectorToWorldSpace

CFrame:VectorToWorldSpace(...:Tuple<Vector3>):Tuple<Vector3>

Parameters

...:Tuple<Vector3>

Returns

Tuple<Vector3>

VectorToObjectSpace

CFrame:VectorToObjectSpace(...:Tuple<Vector3>):Tuple<Vector3>

Parameters

...:Tuple<Vector3>

Returns

Tuple<Vector3>

GetComponents

CFrame:GetComponents():Tuple

Returns

Tuple

ToEulerAngles

CFrame:ToEulerAngles(order:Enum.RotationOrder):number,number,number

Parameters

order:Enum.RotationOrder

Default Value: Enum.RotationOrder.XYZ

Returns

number, number, number

ToEulerAnglesXYZ

CFrame:ToEulerAnglesXYZ():number,number,number

Returns

number, number, number

ToEulerAnglesYXZ

CFrame:ToEulerAnglesYXZ():number,number,number

Returns

number, number, number

ToOrientation

CFrame:ToOrientation():number,number,number

Returns

number, number, number

ToAxisAngle

CFrame:ToAxisAngle():Vector3,number

Returns

Vector3, number

components

CFrame:components():Tuple

Returns

Tuple

FuzzyEq

CFrame:FuzzyEq(

other:CFrame, epsilon:number

):boolean

Parameters

other:CFrame

epsilon:number

Default Value: 0.00001 (1e-5)

Returns

boolean

AngleBetween

CFrame:AngleBetween(other:CFrame):number

Parameters

other:CFrame

Returns

number

Math Operations

CFrame * CFrame

CFrame * CFrame : CFrame

CFrame * Vector3

CFrame * Vector3 : Vector3

CFrame + Vector3

CFrame + Vector3 : CFrame

CFrame - Vector3

CFrame - Vector3 : CFrame