BedrioxDOCUMENTATION
ENTITY EVENT

EntityUnleashedEvent

Observes the related action after it has committed.

Committed post-eventBedriox\Api\Event\Entity
WHAT IT REPRESENTS

Reports that entity unleashed has committed. Plugins may observe the result, but this event does not roll the action back.

WHEN IT FIRES

Bedriox dispatches this after the related action has committed. It is an observation and cannot undo the result.

Event data

Bedriox\Api\Entity\Capability\Leashable $entity

Read-only event value supplied by Bedriox.

Bedriox\Api\Player\Player|Bedriox\Api\Entity\Entity|null $holder

Read-only event value supplied by Bedriox.

Bedriox\Api\Entity\Value\LeashDetachReason $reason

Read-only event value supplied by Bedriox.

Available methods

This type does not declare additional public methods.

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\Entity\EntityUnleashedEvent;

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

View exact source ↗