BedrioxDOCUMENTATION
PLAYER EVENT

PlayerJoinEvent

Runs after admission commits and allows plugins to control the join announcement.

Typed eventBedriox\Api\Event\Player
WHAT IT REPRESENTS

Reports that an admitted player session has joined the server and is available to ordinary 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.

Available methods

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

Typed public method.

setJoinMessage(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\PlayerJoinEvent;

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

View exact source ↗