PlayerTeleportEvent

Namespace Mc.Scripting.Events · Kind struct (ref)

public ref struct PlayerTeleportEvent : IEvent

A player is about to be teleported (command, plugin, ender pearl, …). Cancel to stay; the destination may be changed.

Event

Id	124
Key	mc:player_teleport
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
Player	player	no (readonly)	The player.
From	Vec3d	no (readonly)	Current position.
To	Vec3d	yes	Destination position.
FromWorld	world	no (readonly)	Current dimension.
ToWorld	world	no (readonly)	Destination dimension.
Cause	enum:TeleportCause	no (readonly)	Why.

Set e.Cancelled = true in a handler to cancel it; lower-priority handlers are skipped unless they subscribed with receiveCancelled: true.

Constructors

Member	Description
Constructor	Creates the event (for firing it from a plugin; native code builds its own).

Constructor

public PlayerTeleportEvent(Player player, Vec3d from, Vec3d to, World fromWorld, World toWorld, TeleportCause cause)

Creates the event (for firing it from a plugin; native code builds its own). Signature of API 1.0.

Parameters

Name	Type	Description
player	Player
from	Vec3d
to	Vec3d
fromWorld	World
toWorld	World
cause	TeleportCause

Properties

Member	Description
bool Cancelled { get; set; }	Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
TeleportCause Cause { get; }	Why.
Vec3d From { get; }	Current position.
World FromWorld { get; }	Current dimension.
Player Player { get; }	The player.
Vec3d To { get; set; }	Destination position.
World ToWorld { get; }	Destination dimension.
static ushort CatalogueId { get; }	Catalogue id (stable ABI).
static bool IsCancellable { get; }	Whether handlers can cancel the event.
static string Key { get; }	Registry key of the event.

Cancelled

public bool Cancelled { get; set; }

Cancelling stops lower-priority handlers (unless they opt in) and the action itself.

Cause

public TeleportCause Cause { get; }

Why.

From

public Vec3d From { get; }

Current position.

FromWorld

public World FromWorld { get; }

Current dimension.

Player

public Player Player { get; }

The player.

To

public Vec3d To { get; set; }

Destination position.

ToWorld

public World ToWorld { get; }

Destination dimension.

CatalogueId

public static ushort CatalogueId { get; }

Catalogue id (stable ABI).

IsCancellable

public static bool IsCancellable { get; }

Whether handlers can cancel the event.

Key

public static string Key { get; }

Registry key of the event.

See also

IEvent · Player · TeleportCause · Vec3d · World