BedrioxDOCUMENTATION
PLAYER EVENT

PlayerPortalTravelledEvent

Published after the authoritative dimension transfer has committed.

Committed post-eventBedriox\Api\Event\Player
WHAT IT REPRESENTS

Reports that player portal travelled has committed. Plugins may observe the result, but this event does not roll the action back.

WHEN IT FIRES

Bedriox dispatches this after the related action has committed. It is an observation and cannot undo the result.

Event data

Bedriox\Api\Player\Player $player

Read-only event value supplied by Bedriox.

Bedriox\Api\World\PortalType $portalType

Read-only event value supplied by Bedriox.

Bedriox\Api\World\Position $from

Read-only event value supplied by Bedriox.

Bedriox\Api\World\Position $destination

Read-only event value supplied by Bedriox.

Available methods

This type does not declare additional public methods.

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

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

View exact source ↗