A CFrame, short for Coordinate Frame, is a data type used to rotate and position 3D objects. As either an object property or a standalone unit, a CFrame contains global x-, y-, and z-coordinates as well as rotation data for each axis. In addition, CFrames contain helpful functions for working with objects in the 3D space.
Some examples of CFrame applications in a game might be:
- Finding a far-off target point for a projectile, like the position of an enemy targeted by a player's laser blaster.
- Moving the camera so that it focuses on specific NPCs as a player interacts with them.
- Placing a status indicator directly above a player's head to show if they are paralyzed, boosted, poisoned, etc.
You can create an empty CFrame at the default position of (0, 0, 0) by using CFrame.new(). To position a CFrame at a specific point, provide x-, y-, and z-coordinates as arguments to CFrame.new(). In the following example, the redBlock part's CFrame property changes to newCFrame, repositioning it to (-2, 2, 4).
local redBlock = workspace.RedBlock-- Create new CFramelocal newCFrame = CFrame.new(-2, 2, 4)-- Overwrite redBlock's current CFrame with new CFrameredBlock.CFrame = newCFrame
local redBlock = workspace.RedBlock-- Create new CFramelocal newVector3 = Vector3.new(-2, 2, 4)local newCFrame = CFrame.new(newVector3)-- Overwrite redBlock's current CFrame with new CFrameredBlock.CFrame = newCFrame
To create a rotated CFrame, use the CFrame.Angles() constructor, providing a rotation angle in radians for the desired axes. The parameters to CFrame.Angles() is in radians, not degrees. If you prefer degrees, use math.rad() to convert degrees to radians. In the following example, the redBlock part rotates 45 degrees counterclockwise on its y-axis.
local redBlock = workspace.RedBlock-- Create new rotated CFramelocal newCFrame = CFrame.Angles(0, math.rad(45), 0)-- Overwrite redBlock's current CFrame with new CFrameredBlock.CFrame = newCFrame
You can use CFrame.new() to point the front surface of a CFrame at a specific point in the world. In the following example, redBlock part positions at (0, 3, 0) and points its front surface, marked by the white circle, at the blueCube part.
local redBlock = workspace.RedBlocklocal blueCube = workspace.BlueCube-- Create a Vector3 for both the start position and target positionlocal startPosition = Vector3.new(0, 3, 0)local targetPosition = blueCube.Position-- Put the redBlock at 'startPosition' and point its front surface at 'targetPosition'redBlock.CFrame = CFrame.new(startPosition, targetPosition)
To offset an object by a specific number of studs from its current position, add or subtract a Vector3 to or from a new CFrame at the object's position. To get a properly-formatted Vector3 position of an object to use with CFrame.new(), as seen here, its Position property (redBlock.Position) is a convenient shortcut.
local redBlock = workspace.RedBlockredBlock.CFrame = CFrame.new(redBlock.Position) + Vector3.new(0, 1.25, 0)
You can use the same technique to offset an object from the position of another object. In the following example, a Vector3 adds to a new CFrame created at the blue cube's position instead of the block's position.
local redBlock = workspace.RedBlocklocal blueCube = workspace.BlueCuberedBlock.CFrame = CFrame.new(blueCube.Position) + Vector3.new(0, 2, 0)
The CFrame.new() and CFrame.Angles() constructors reposition or rotate an object at a specific orientation within the world, but you sometimes can't rely on a fixed world position and rotation angle. For example:
- Placing a floating treasure directly in front of a player who may be standing anywhere in the world, facing any direction.
- Making a magical genie appear directly above a player's right shoulder.
In these cases, use CFrame methods instead of their constructors.
The CFrame:ToWorldSpace() function transforms an object's CFrame — respecting its own local orientation — to a new world orientation. This makes it ideal for offsetting a part relative to itself or another object, regardless of how it's currently positioned/rotated.
In the following example, the redBlock part offsets 2 studs relative to the y-axis of the blue cube (the green arrow pointing through it) and not relative to the global y-axis pointing straight up.
local redBlock = workspace.RedBlocklocal blueCube = workspace.BlueCubelocal offsetCFrame = CFrame.new(0, 2, 0)redBlock.CFrame = blueCube.CFrame:ToWorldSpace(offsetCFrame)
You can also use CFrame:ToWorldSpace() to rotate an object relative to itself. In the following example, the redBlock part rotates 70 degrees counterclockwise on its y-axis and 20 degrees clockwise on its z-axis.
local redBlock = workspace.RedBlocklocal rotatedCFrame = CFrame.Angles(0, math.rad(70), math.rad(20))redBlock.CFrame = redBlock.CFrame:ToWorldSpace(rotatedCFrame)
You can make the front of an object face another object by supplying a Vector3 point as the second parameter of CFrame.new(). You can also use relative rotation to make any face of the object point toward a Vector3 point. The following example performs two consecutive CFrame operations:
- Point the front surface, marked by the white circle, at the target.
- Rotate the CFrame to make the top surface, marked by the black circle, point toward the target.
local redBlock = workspace.RedBlocklocal blueCube = workspace.BlueCube-- Create a Vector3 for the target positionlocal targetPosition = blueCube.Position-- Point the redBlock's front surface at 'targetPosition'redBlock.CFrame = CFrame.new(redBlock.Position, targetPosition)-- Now the redBlock's front surface (white circle) is pointing towards the blueCube-- Rotate redBlock's CFrame relative to itself so that its top surface (not front) points toward the targetlocal rotatedCFrame = CFrame.Angles(math.rad(-90), 0, 0)redBlock.CFrame = redBlock.CFrame:ToWorldSpace(rotatedCFrame)-- Now the redBlock's top surface (black circle) is pointing towards the blueCube (as seen in After below)
You can use linear interpolation, or lerp, to position a CFrame between two points. In the following example, the redBlock part repositions between the greenCube and cyanCube parts. The value of 0.7 places it 70% of the distance away from the green cube.
local redBlock = workspace.RedBlocklocal greenCube = workspace.GreenCubelocal cyanCube = workspace.CyanCuberedBlock.CFrame = greenCube.CFrame:Lerp(cyanCube.CFrame, 0.7)