This function stores a value under a given key that persists across all teleportations in the same game.
This method is intended for use on the client only and should not be used on the server.
The stored value can later be retrieved using
TeleportService/GetTeleportSetting. This will work in the current place and any subsequent places the
Players/LocalPlayer teleports to, provided they are in the same game.
For example, in a game that allowed crouching you could save whether the user is currently crouching prior to teleporting as a teleport setting:
local TeleportService = game:GetService("TeleportService") local isCrouching = false TeleportService:SetTeleportSetting("isCrouching", isCrouching)
The stored value can take one of the following forms:
- A table without mixed keys (all strings or all integers)
- A string
- A number
- A bool
If data is already stored under the given key, the previous value will be overwritten by the new value.
Differences from GlobalDataStores
Although they share some similarities, there are some key differences between teleport settings and datastores:
GlobalDataStore/SetAsyncstores the data on Roblox servers whereas SetTeleportSetting stores the data locally
- Data stored in a
GlobalDataStoreis preserved after the user leaves the game universe whereas teleport settings are not
GlobalDataStore|GlobalDataStorescan only be accessed on the server, whereas teleport settings can only be accessed on the client
GlobalDataStore|GlobalDataStoreshave usage limits, whereas teleport settings do not
In general teleport settings should be used to preserve client side information within a single play session across different places in a game.
GlobalDataStore|GlobalDataStores should be used to save important player data that needs to be accessed across player sessions.
Teleport settings and security
As teleport settings are stored locally, it is possible they can be manipulated by malicious users. This risk can be mitigated by employing server side validation, for more information on this please see the article on
The key to store the value under. This key can be used to retrieve the value using
The value to store