Teleporting Within a Place

5 min

Teleporting a player’s character to a different coordinate point — while maintaining the character’s structural makeup — is achieved by moving the character’s Humanoid/RootPart|RootPart. This article outlines a module-based approach with adjustable parameters.

This article focuses on moving players within the same articles/games and places|place. To teleport players between places/levels in a multi-place game, see articles/Teleporting Between Places|Teleporting Between Places.

Teleport Module

Basic teleport functionality can be wrapped in a ModuleScript so that it can be called from other scripts.

Create a new ModuleScript within ReplicatedStorage and rename it TeleportWithinPlace.

Copy and paste in the following code:

			
				ModuleScript - TeleportWithinPlace
			
				Expected Output
			
				Expand
				
			local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")

local TeleportWithinPlace = {}

-- Create remote event instance
local teleportEvent = Instance.new("RemoteEvent")
teleportEvent.Name = "TeleportEvent"
teleportEvent.Parent = ReplicatedStorage

function TeleportWithinPlace.Teleport(humanoid, params)
	local character = humanoid.Parent

	-- Freeze character during teleport if requested
	if params.freeze then
		humanoid:SetAttribute("DefaultWalkSpeed", humanoid.WalkSpeed)
		humanoid:SetAttribute("DefaultJumpPower", humanoid.JumpPower)
		humanoid.WalkSpeed = 0
		humanoid.JumpPower = 0
	end

	-- Calculate height of root part from character base
	local rootPartY
	if humanoid.RigType == Enum.HumanoidRigType.R15 then
		rootPartY = (humanoid.RootPart.Size.Y * 0.5) + humanoid.HipHeight
	else
		rootPartY = (humanoid.RootPart.Size.Y * 0.5) + humanoid.Parent.LeftLeg.Size.Y + humanoid.HipHeight
	end

	-- Teleport player and request content around location if applicable
	local position = CFrame.new(params.destination + Vector3.new(0, rootPartY, 0))
	local orientation = CFrame.Angles(0, math.rad(params.faceAngle), 0)
	if workspace.StreamingEnabled then
		local player = Players:GetPlayerFromCharacter(character)
		player:RequestStreamAroundAsync(params.destination)
	end
	character:SetPrimaryPartCFrame(position * orientation)

	-- Unfreeze character
	if params.freeze then
		humanoid.WalkSpeed = humanoid:GetAttribute("DefaultWalkSpeed")
		humanoid.JumpPower = humanoid:GetAttribute("DefaultJumpPower")
	end
end

return TeleportWithinPlace
		
				Copy Code
			
				Light Theme

Module Usage

Teleport on Part Touch

Teleportation can be easily triggered when a player touches a part such as a teleporation pad or an invisible trigger part at a door’s entry point.

Include the Teleport Module in your project.
Attach a Script to an anchored BasePart and paste in the code below.

			
				Script - Teleport Player on Part Touch
			
				Expected Output
			
				Expand
				
			local ReplicatedStorage = game:GetService("ReplicatedStorage")

local teleportPart = script.Parent

local TELEPORT_DESTINATION = Vector3.new(50, 0, 50)
local TELEPORT_FACE_ANGLE = 0
local FREEZE_CHARACTER = true

-- Require teleport module
local TeleportWithinPlace = require(ReplicatedStorage:WaitForChild("TeleportWithinPlace"))

local function teleportPlayer(otherPart)
	local character = otherPart.Parent
	local humanoid = character:FindFirstChild("Humanoid")

	if humanoid and not humanoid:GetAttribute("Teleporting") then
		humanoid:SetAttribute("Teleporting", true)

		local params = {
			destination = TELEPORT_DESTINATION,
			faceAngle = TELEPORT_FACE_ANGLE,
			freeze = FREEZE_CHARACTER
		}
		TeleportWithinPlace.Teleport(humanoid, params)

		wait(1)
		humanoid:SetAttribute("Teleporting", nil)
	end
end

teleportPart.Touched:Connect(teleportPlayer)
		
				Copy Code
			
				Light Theme

Adjust the variable values on lines 5–7 as desired:

Variable	Description
`TELEPORT_DESTINATION`	The `datatype/Vector3` position to teleport the player to.
`TELEPORT_FACE_ANGLE`	Angular direction character should face following teleportation, between -180 and 180.
`FREEZE_CHARACTER`	Whether to temporarily "freeze" the character during teleportation, preventing movement or jumping.

Teleport on Client Action

Because player teleportation should only be called on the game server, you’ll need to fire a articles/Remote Functions and Events|remote event alongside client-side actions like activation of a GUI button. The following setup outlines this process.

Make sure you’ve included the Teleport Module in your project.
Add a new Script to ServerScriptService and paste in the code below — this gets the remote event created by the teleport module and, upon an RemoteEvent/OnServerEvent|OnServerEvent connection, finds the Humanoid associated with the player and calls the module’s Teleport function.

			
				Script - Teleport Player on Remote Event
			
				Expected Output
			
				Expand
				
			local ReplicatedStorage = game:GetService("ReplicatedStorage")

-- Require teleport module
local TeleportWithinPlace = require(ReplicatedStorage:WaitForChild("TeleportWithinPlace"))

-- Fire the module function on server event
local teleportEvent = ReplicatedStorage:WaitForChild("TeleportEvent")
teleportEvent.OnServerEvent:Connect(function(player, params)
	local character = player.Character
	if not character or not character.Parent then
		character = player.CharacterAdded:Wait()
	end
	local humanoid = character:FindFirstChild("Humanoid")
	
	if humanoid and not humanoid:GetAttribute("Teleporting") then
		humanoid:SetAttribute("Teleporting", true)

		TeleportWithinPlace.Teleport(humanoid, params)

		wait(1)
		humanoid:SetAttribute("Teleporting", nil)
	end
end)
		
				Copy Code
			
				Light Theme

Attach a LocalScript to a TextButton or ImageButton and paste in the following code:

			
				LocalScript - Fire Remote Event on Button Press
			
				Expected Output
			
				Expand
				
			local ReplicatedStorage = game:GetService("ReplicatedStorage")

local button = script.Parent

local TELEPORT_DESTINATION = Vector3.new(50, 0, 50)
local TELEPORT_FACE_ANGLE = 0
local FREEZE_CHARACTER = true

local teleportEvent = ReplicatedStorage:WaitForChild("TeleportEvent")

local function onButtonActivated()
	local params = {
		destination = TELEPORT_DESTINATION,
		faceAngle = TELEPORT_FACE_ANGLE,
		freeze = FREEZE_CHARACTER
	}
	teleportEvent:FireServer(params)
end

button.Activated:Connect(onButtonActivated)
		
				Copy Code
			
				Light Theme

Adjust the variable values on lines 5–7 as desired:

Variable	Description
`TELEPORT_DESTINATION`	The `datatype/Vector3` position to teleport the player to.
`TELEPORT_FACE_ANGLE`	Angular direction character should face following teleportation, between -180 and 180.
`FREEZE_CHARACTER`	Whether to temporarily "freeze" the character during teleportation, preventing movement or jumping.

Tags:

teleport
coding

Teleporting Within a Place

Teleporting Within a Place

Teleport Module

Module Usage

Teleport on Part Touch

Teleport on Client Action

Related Articles

Teleporting Between Places