BedrioxDOCUMENTATION
CORE EVENT

CancellableEvent

Runs before the related authoritative action and may be cancelled within the documented server boundary.

Cancellable pre-eventBedriox\Api\Event
WHAT IT REPRESENTS

Represents cancellable 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.

Available methods

isCancelled(): bool

Typed public method.

cancel(): void

Typed public method.

setCancelled(bool $cancelled): 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\CancellableEvent;

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

View exact source ↗