GetLocalPlayerTeleportData

Unsafe

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

Function of:

Description:

This function returns the teleport data the Players/LocalPlayer arrived with. It can only be called from the client.

Exploiters can spoof teleport data. Send secure data such as player currency through a server-side service such as `DataStoreService` to prevent tampering.

Returns

Return Type	Summary
Return Type Variant	Summary The teleport data the `Players/LocalPlayer` arrived into the place with.

Code Samples

Getting LocalPlayer Teleport Data

When put into StarterPlayerScripts, this example runs when the player joins the game, and prints any teleport data provided by the player’s previous server.

			
				Getting LocalPlayer Teleport Data

				Expected Output
			
				Expand
				
			local TeleportService = game:GetService("TeleportService")

local teleportData = TeleportService:GetLocalPlayerTeleportData()

print("Local player arrived with this data:", teleportData)
		
			Local player arrived with this data: nil
		
				Copy Code
			
				Light Theme

GetLocalPlayerTeleportData

Returns

Variant

Code Samples

Getting LocalPlayer Teleport Data