BedrioxDOCUMENTATION
PLAYER EVENT

PlayerQuitEvent

Runs after removal commits; only the public leave announcement remains mutable.

Typed eventBedriox\Api\Event\Player
WHAT IT REPRESENTS

Represents the player quit lifecycle point and exposes its typed Bedriox values to registered plugin listeners.

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.

Bedriox\Api\Event\Player\PlayerQuitCause $cause

Read-only event value supplied by Bedriox.

string $reason

Read-only event value supplied by Bedriox.

?string $actor

Read-only event value supplied by Bedriox.

Available methods

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

Typed public method.

setQuitMessage(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\PlayerQuitEvent;

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

View exact source ↗