BedrioxDOCUMENTATION
VEHICLE EVENT

VehicleControlEvent

Cancellable authoritative boat-control intent before motion is applied.

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

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

Read-only event value supplied by Bedriox.

Bedriox\Api\Entity\Vanilla\Boat $vehicle

Read-only event value supplied by Bedriox.

Available methods

forward(): float

Typed public method.

strafe(): float

Typed public method.

yaw(): float

Typed public method.

isPaddlingLeft(): bool

Typed public method.

isPaddlingRight(): bool

Typed public method.

setAxes(float $forward, float $strafe): void

Typed public method.

setYaw(float $yaw): void

Typed public method.

setPaddling(bool $left, bool $right): 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\Vehicle\VehicleControlEvent;

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

View exact source ↗