PacketSendBeforeEvent

Interface in @minecraft/server-net

A packet about to go to a player in a batch.

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

Subscribe to it with beforeEvents.packetSend.

Example

TypeScript JavaScript

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

beforeEvents.packetSend.subscribe((event: PacketSendBeforeEvent) => {
    console.log('packetSend', event.packetId, event.packetSize);

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

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

beforeEvents.packetSend.subscribe((event) => {
    console.log('packetSend', event.packetId, event.packetSize);

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

Properties

cancel

cancel: boolean;

Set to true to leave it out of the batch.

packetId

read-only

readonly packetId: PacketId;

Types

PacketId

packetSize

read-only

readonly packetSize: number;

recipients

read-only

readonly recipients: (Player | undefined)[];

Who it goes to; Basalt fires once for each, so this holds one.

Types

Player

Used by

NetworkBeforeEvents.packetSend