Represents a parsed command before its registered handler is dispatched.
CommandPreDispatchEvent
Runs before the related authoritative action and may be cancelled within the documented server boundary.
Cancellable pre-eventBedriox\Api\Event\Command
Bedriox dispatches this before the related action commits. Cancelling it prevents that action at this event boundary.
Event after this
If this event is not cancelled and the action succeeds, Bedriox dispatches CommandDispatchedEvent as the committed outcome. That event cannot cancel or undo the result.
Event data
Bedriox\Api\Command\CommandSender $senderRead-only event value supplied by Bedriox.
string $commandRead-only event value supplied by Bedriox.
Bedriox\Api\Command\CommandValues $valuesRead-only event value supplied by Bedriox.
string $ownerRead-only event value supplied by Bedriox.
Available methods
This type does not declare additional public methods.
Inherited methods
isCancelled(): bool from Bedriox\Api\Event\CancellableEventTyped public method.
cancel(): void from Bedriox\Api\Event\CancellableEventTyped public method.
setCancelled(bool $cancelled): void from Bedriox\Api\Event\CancellableEventTyped public method.
captureState(): mixed from Bedriox\Api\Event\EventTyped public method.
restoreState(mixed $state): void from Bedriox\Api\Event\EventTyped public method.
setReadOnly(bool $readOnly): void from Bedriox\Api\Event\EventTyped public method.
Listen for this event
Register the containing object with PluginContext::events()->registerSubscriber($this), then add a typed handler:
use Bedriox\Api\Event\EventHandler;
use Bedriox\Api\Event\Command\CommandPreDispatchEvent;
#[EventHandler]
public function onCommandPreDispatchEvent(CommandPreDispatchEvent $event): void
{
// Keep listener work bounded and use public capabilities only.
}