BedrioxDOCUMENTATION
PLAYER EVENT

PlayerDeathEvent

Runs after lethal damage commits and before death messages are presented.

Typed eventBedriox\Api\Event\Player
WHAT IT REPRESENTS

Reports lethal player damage and lets plugins control the bounded death presentation before Bedriox completes that presentation.

WHEN IT FIRES

Bedriox dispatches this at the typed lifecycle point represented by the event. Check the available values below before acting.

Event data

Bedriox\Api\Player\Player $player

Read-only event value supplied by Bedriox.

string $cause

Read-only event value supplied by Bedriox.

float $damage

Read-only event value supplied by Bedriox.

bool $keepInventory

Read-only event value supplied by Bedriox.

?Bedriox\Api\Player\Player $killer

Read-only event value supplied by Bedriox.

Available methods

deathMessage(): string|Bedriox\Api\TranslatableMessage|null

Typed public method.

setDeathMessage(string|Bedriox\Api\TranslatableMessage|null $message): void

Typed public method.

deathScreenMessage(): string|Bedriox\Api\TranslatableMessage|null

Typed public method.

setDeathScreenMessage(string|Bedriox\Api\TranslatableMessage|null $message): void

Typed public method.

Inherited methods

captureState(): mixed from Bedriox\Api\Event\Event

Typed public method.

restoreState(mixed $state): void from Bedriox\Api\Event\Event

Typed public method.

setReadOnly(bool $readOnly): void from Bedriox\Api\Event\Event

Typed public method.

Listen for this event

Register the containing object with PluginContext::events()->registerSubscriber($this), then add a typed handler:

PHP
use Bedriox\Api\Event\EventHandler;
use Bedriox\Api\Event\Player\PlayerDeathEvent;

#[EventHandler]
public function onPlayerDeathEvent(PlayerDeathEvent $event): void
{
    // Keep listener work bounded and use public capabilities only.
}

View exact source ↗