Represents entity unleash before Bedriox commits the related authoritative change. Plugins may inspect it and cancel or adjust only the values explicitly exposed below.
EntityUnleashEvent
Runs before the related authoritative action and may be cancelled within the documented server boundary.
Cancellable pre-eventBedriox\Api\Event\Entity
Bedriox dispatches this before the related action commits. Cancelling it prevents that action at this event boundary.
Event data
Bedriox\Api\Entity\Capability\Leashable $entityRead-only event value supplied by Bedriox.
Bedriox\Api\Player\Player|Bedriox\Api\Entity\Entity|null $holderRead-only event value supplied by Bedriox.
Bedriox\Api\Entity\Value\LeashDetachReason $reasonRead-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\Entity\EntityUnleashEvent;
#[EventHandler]
public function onEntityUnleashEvent(EntityUnleashEvent $event): void
{
// Keep listener work bounded and use public capabilities only.
}