CFrame
A position and a rotation in 3D.
Move points and directions between spaces, and read its axes and angles.
Constructors
Up and coming: the native runtime gives these. Today a program reads a CFrame from an attribute, and shot check refuses CFrame.new in a System project.
| Name | Arguments | Returns | Description |
|---|---|---|---|
| CFrame.new | (x: number?, y: number?, z: number?) | CFrame | |
| CFrame.lookAt | (at: Vector3, target: Vector3, up: Vector3?) | CFrame | |
| CFrame.Angles | (rx: number, ry: number, rz: number) | CFrame |
Constants
| Name | Type | Description |
|---|---|---|
| CFrame.identity | CFrame |
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| LookVector | Vector3 | ||
| Position | Vector3 | ||
| RightVector | Vector3 | ||
| Rotation | CFrame | ||
| UpVector | Vector3 | ||
| X | number | ||
| XVector | Vector3 | ||
| Y | number | ||
| YVector | Vector3 | ||
| Z | number | ||
| ZVector | Vector3 |
Methods
| Name | Arguments | Returns | Description |
|---|---|---|---|
| FuzzyEq | (other: CFrame, epsilon: number?) | boolean | |
| GetComponents | () | (number, number, number, number, number, number, number, number, number, number, number, number) | |
| Inverse | () | CFrame | |
| Lerp | (goal: CFrame, alpha: number) | CFrame | |
| Orthonormalize | () | CFrame | |
| PointToObjectSpace | (...: Vector3) | ...Vector3 | |
| PointToWorldSpace | (...: Vector3) | ...Vector3 | |
| ToAxisAngle | () | (Vector3, number) | |
| ToEulerAnglesXYZ | () | (number, number, number) | |
| ToEulerAnglesYXZ | () | (number, number, number) | |
| ToObjectSpace | (...: CFrame) | ...CFrame | |
| ToOrientation | () | (number, number, number) | |
| ToWorldSpace | (...: CFrame) | ...CFrame | |
| VectorToObjectSpace | (...: Vector3) | ...Vector3 | |
| VectorToWorldSpace | (...: Vector3) | ...Vector3 |