PlayerHurtBeforeEvent

Interface in @minecraft/server

Extends CancellableEvent

Basalt’s own: EntityHurtBeforeEvent for players alone, with the knockback.

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

Subscribe to it with world.beforeEvents.playerHurt.

Example

TypeScript JavaScript

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

world.beforeEvents.playerHurt.subscribe((event: PlayerHurtBeforeEvent) => {
    console.log('playerHurt', event.hurtEntity.name, event.damage, event.cancelKnockback);

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

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

world.beforeEvents.playerHurt.subscribe((event) => {
    console.log('playerHurt', event.hurtEntity.name, event.damage, event.cancelKnockback);

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

Properties

hurtEntity

read-only

readonly hurtEntity: Player;

Types

Player

damage

damage: number;

damageSource

read-only

readonly damageSource: EntityDamageSource;

Types

EntityDamageSource

knockback

knockback: Vector3;

The push the hit gives, which handlers may change.

Types

Vector3

cancelKnockback

cancelKnockback: boolean;

Set true and the hit pushes nobody, so the plugin can push its own way.

Used by

WorldBeforeEvents.playerHurt

Inherited

From CancellableEvent: cancel