BedrioxDOCUMENTATION
PLAYER EVENT

PlayerDamageEvent

Runs before the related authoritative action and may be cancelled within the documented server boundary.

Cancellable pre-eventBedriox\Api\Event\Player
WHAT IT REPRESENTS

Represents proposed non-attack damage to a player before health is changed.

WHEN IT FIRES

Bedriox dispatches this before the related action commits. Cancelling it prevents that action at this event boundary.

EVENT SEQUENCE

Event after this

If this event is not cancelled and the action succeeds, Bedriox dispatches PlayerDamagedEvent as the committed outcome. That event cannot cancel or undo the result.

Event data

Bedriox\Api\Player\Player $player

Read-only event value supplied by Bedriox.

string $cause

Read-only event value supplied by Bedriox.

Available methods

damage(): float

Typed public method.

setDamage(float $damage): void

Typed public method.

Inherited methods

isCancelled(): bool from Bedriox\Api\Event\CancellableEvent

Typed public method.

cancel(): void from Bedriox\Api\Event\CancellableEvent

Typed public method.

setCancelled(bool $cancelled): void from Bedriox\Api\Event\CancellableEvent

Typed public method.

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\PlayerDamageEvent;

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

View exact source ↗