BedrioxDOCUMENTATION
PLAYER EVENT

PlayerLoginEvent

Runs after authoritative player state is restored and before the client bootstrap begins.

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

Represents player login before Bedriox commits the related authoritative change. Plugins may inspect it and cancel or adjust only the values explicitly exposed below.

WHEN IT FIRES

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

Event data

Bedriox\Api\Player\Player $player

Read-only event value supplied by Bedriox.

Available methods

destination(): Bedriox\Api\World\Position

Typed public method.

yaw(): float

Typed public method.

pitch(): float

Typed public method.

setDestination(Bedriox\Api\World\Position $destination): void

Typed public method.

setOrientation(float $yaw, float $pitch): 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\PlayerLoginEvent;

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

View exact source ↗