Represents player kick before Bedriox commits the related authoritative change. Plugins may inspect it and cancel or adjust only the values explicitly exposed below.
PlayerKickEvent
Cancellable server-initiated kick; a normal transport timeout does not fire this event.
Cancellable pre-eventBedriox\Api\Event\Player
Bedriox dispatches this before the related action commits. Cancelling it prevents that action at this event boundary.
Event data
Bedriox\Api\Player\Player $playerRead-only event value supplied by Bedriox.
Bedriox\Api\Event\Player\PlayerKickCause $causeRead-only event value supplied by Bedriox.
?string $actorRead-only event value supplied by Bedriox.
Available methods
reason(): stringTyped public method.
quitMessage(): ?stringTyped public method.
disconnectScreenMessage(): ?stringTyped public method.
setReason(string $reason): voidTyped public method.
setQuitMessage(?string $message): voidTyped public method.
setDisconnectScreenMessage(?string $message): voidTyped public method.
Inherited methods
isCancelled(): bool from Bedriox\Api\Event\CancellableEventTyped public method.
cancel(): void from Bedriox\Api\Event\CancellableEventTyped public method.
setCancelled(bool $cancelled): void from Bedriox\Api\Event\CancellableEventTyped public method.
captureState(): mixed from Bedriox\Api\Event\EventTyped public method.
restoreState(mixed $state): void from Bedriox\Api\Event\EventTyped public method.
setReadOnly(bool $readOnly): void from Bedriox\Api\Event\EventTyped public method.
Listen for this event
Register the containing object with PluginContext::events()->registerSubscriber($this), then add a typed handler:
use Bedriox\Api\Event\EventHandler;
use Bedriox\Api\Event\Player\PlayerKickEvent;
#[EventHandler]
public function onPlayerKickEvent(PlayerKickEvent $event): void
{
// Keep listener work bounded and use public capabilities only.
}