GetPivot

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

This function gets the pivot of a PVInstance. This is often used with PVInstance/PivotTo to move a model.

Model|Models and BasePart|BaseParts are both PVInstance|PVInstances (“Position Velocity Instances”) and so both have this function.

Returns

Return Type	Summary
Return Type CFrame	Summary

Code Samples

Simple Character Teleportation

This code sample is a simple teleport script that moves your character 10 studs forwards in the direction you’re currently facing when you press the F key. It does so by getting the current pivot with PVInstance/GetPivot and calling PVInstance|PivotTo to move the character forwards.

			
				Simple Character Teleportation

				Expected Output
			
				Expand
				
			-- This code should be placed in a LocalScript under StarterPlayerScripts
local Players = game:GetService("Players")
local ContextActionService = game:GetService("ContextActionService")

local function doTeleport()
	local player = Players.LocalPlayer
	local character = player.Character
	if character and character.Parent then
		-- Move the character 10 studs forwards in the direction they're facing
		local currentPivot = character:GetPivot()
		character:PivotTo(currentPivot * CFrame.new(0, 0, -10))
	end
end

ContextActionService:BindAction("Teleport", doTeleport, true, Enum.KeyCode.F)
		
				Copy Code
			
				Light Theme