BedrioxDOCUMENTATION
VEHICLE EVENT

VehicleMoveEvent

Cancellable authoritative vehicle displacement after physics validation and before commit.

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

Represents vehicle move 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\Entity\Capability\Vehicle $vehicle

Read-only event value supplied by Bedriox.

Bedriox\Api\World\Position $from

Read-only event value supplied by Bedriox.

Bedriox\Api\World\Position $to

Read-only event value supplied by Bedriox.

Bedriox\Api\Entity\Value\Motion $motion

Read-only event value supplied by Bedriox.

Available methods

This type does not declare additional public methods.

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

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

View exact source ↗