Enum
TeleportMethod
Identifies which TeleportService API method initiated a teleport.
TeleportMethod identifies the TeleportService call that initiated a
given teleport. Each enum item corresponds to a specific public
TeleportService method.
Items 7#
| Name | Value | Summary |
|---|---|---|
TeleportToSpawnByName | 0 | Teleport was initiated by TeleportService:TeleportToSpawnByName(),
which sends a player to a named SpawnLocation in a place. |
TeleportToPlaceInstance | 1 | Teleport was initiated by
TeleportService:TeleportToPlaceInstance(), which sends a player to
a specific running server instance identified by its instanceId. |
TeleportToPrivateServer | 2 | Teleport was initiated by
TeleportService:TeleportToPrivateServer(), which sends players to
a reserved server using an access code. |
TeleportPartyAsync | 3 | Teleport was initiated by TeleportService:TeleportPartyAsync(),
which sends a group of players to a place together. |
TeleportToVIPServer | 4 | Teleport was initiated to a VIP (creator-owned private) server; the engine upgrades the method tag to this value when VIP server credentials are present at teleport time. |
TeleportToInstanceBack | 5 | Teleport was initiated by back-navigation, returning a player to a specific prior place instance. |
TeleportUnknown | 6 | Fallback value used when the teleport method cannot be determined. |