BedrioxDOCUMENTATION
VEHICLE EVENT

VehicleControlledEvent

Immutable observation after authoritative boat control is accepted.

Typed eventBedriox\Api\Event\Vehicle
WHAT IT REPRESENTS

Represents the vehicle controlled 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 $driver

Read-only event value supplied by Bedriox.

Bedriox\Api\Entity\Vanilla\Boat $vehicle

Read-only event value supplied by Bedriox.

float $forward

Read-only event value supplied by Bedriox.

float $strafe

Read-only event value supplied by Bedriox.

float $yaw

Read-only event value supplied by Bedriox.

bool $paddlingLeft

Read-only event value supplied by Bedriox.

bool $paddlingRight

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\Vehicle\VehicleControlledEvent;

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

View exact source ↗