PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

OnTeleport

Fired when the TeleportState of a player changes. This event is useful for detecting whether a teleportation was successful.

What is the TeleportState?

When a teleportation request is made using TeleportService, there are a series of stages before the Player is teleported. The current stage is represented by the Enum/TeleportState value which is given by OnTeleport. See below for a practical example of this.

Parameters

Name Type Default Description

The new Enum/TeleportState of the Player.

The ID of the place the Player is being teleported to.

The name of the spawn to teleport to, if TeleportService/TeleportToSpawnByName has been used.


Code Samples


Player.OnTeleport

This example prints which stage of a teleport a player is at, as well as printing if the teleport was a failure.