PlayerDieBeforeEvent

Interface in @minecraft/server

Basalt’s own: a player about to die.

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

Subscribe to it with server.beforeEvents.playerDie.

Example

TypeScript JavaScript

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

server.beforeEvents.playerDie.subscribe((event: PlayerDieBeforeEvent) => {
    console.log('playerDie', event.player.name, event.keepInventory, event.deathMessage);
});

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

server.beforeEvents.playerDie.subscribe((event) => {
    console.log('playerDie', event.player.name, event.keepInventory, event.deathMessage);
});

Properties

player

read-only

readonly player: Player;

Types

Player

damageSource

read-only

readonly damageSource: EntityDamageSource;

Types

EntityDamageSource

keepInventory

keepInventory: boolean;

Whether the player keeps their items, which handlers may change.

drops

drops: ItemStack[];

What’s thrown out if the inventory isn’t kept, which handlers may change.

Types

ItemStack

deathMessage

deathMessage: string | undefined;

Sent to everyone; undefined sends nothing.

Used by

ServerBeforeEvents.playerDie