BeforeJoinEvent

Interface in @minecraft/server

Extends CancellableEvent

Basalt’s own (PowerNukkitX’s PlayerLoginEvent): a login, verified, before the resource packs.

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

Subscribe to it with server.beforeEvents.beforeJoin.

Example

TypeScript JavaScript

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

server.beforeEvents.beforeJoin.subscribe((event: BeforeJoinEvent) => {
    console.log('beforeJoin', event.name, event.xuid, event.address);

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

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

server.beforeEvents.beforeJoin.subscribe((event) => {
    console.log('beforeJoin', event.name, event.xuid, event.address);

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

Properties

name

read-only

readonly name: string;

xuid

read-only

readonly xuid: string;

address

read-only

readonly address: string | undefined;

The client’s IP address, if known.

kickMessage

kickMessage: string;

Shown to the player when cancelled; handlers may change it.

Used by

ServerBeforeEvents.beforeJoin

Inherited

From CancellableEvent: cancel