PacketReceivedBeforeEvent

Interface in @minecraft/server-net

A packet a player sent, split from its batch but not yet handled.

import type { PacketReceivedBeforeEvent } from '@minecraft/server-net';

Subscribe to it with beforeEvents.packetReceive.

Example

TypeScript JavaScript

import { beforeEvents, type PacketReceivedBeforeEvent } from '@minecraft/server-net';

beforeEvents.packetReceive.subscribe((event: PacketReceivedBeforeEvent) => {
    console.log('packetReceive', event.packetId, event.packetSize, event.sender?.name);

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

import { beforeEvents } from '@minecraft/server-net';

beforeEvents.packetReceive.subscribe((event) => {
    console.log('packetReceive', event.packetId, event.packetSize, event.sender?.name);

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

Properties

cancel

cancel: boolean;

Set to true to drop it, as if it never came.

packetId

read-only

readonly packetId: PacketId;

Types

PacketId

packetSize

read-only

readonly packetSize: number;

Its bytes, header included.

sender

read-only

readonly sender: Player | undefined;

Who sent it; undefined before they’ve spawned.

Types

Player

Used by

NetworkBeforeEvents.packetReceive