PlayerTeleportBeforeEvent

Interface in @minecraft/server

Extends CancellableEvent

Basalt’s own: toLocation, the feet, may be moved.

import type { PlayerTeleportBeforeEvent } from '@minecraft/server';

Subscribe to it with world.beforeEvents.playerTeleport.

Example

TypeScript JavaScript

import { world, type PlayerTeleportBeforeEvent } from '@minecraft/server';

world.beforeEvents.playerTeleport.subscribe((event: PlayerTeleportBeforeEvent) => {
    console.log('playerTeleport', event.player.name);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

import { world } from '@minecraft/server';

world.beforeEvents.playerTeleport.subscribe((event) => {
    console.log('playerTeleport', event.player.name);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

Properties

player

read-only

readonly player: Player;

Types

Player

fromLocation

read-only

readonly fromLocation: Vector3;

Types

Vector3

toLocation

toLocation: Vector3;

Types

Vector3

cause

read-only

readonly cause: "Plugin" | "Command" | "EnderPearl";

Used by

WorldBeforeEvents.playerTeleport

Inherited

From CancellableEvent: cancel