Represents entity effect add before Bedriox commits the related authoritative change. Plugins may inspect it and cancel or adjust only the values explicitly exposed below.
EntityEffectAddEvent
Cancellable, adjustable intent emitted before an authoritative effect mutation.
Cancellable pre-eventBedriox\Api\Event\Entity
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 EntityEffectAddedEvent as the committed outcome. That event cannot cancel or undo the result.
Event data
Bedriox\Api\Entity\LivingEntity|Bedriox\Api\Player\Player $entityRead-only event value supplied by Bedriox.
Bedriox\Api\Effect\EffectCause $causeRead-only event value supplied by Bedriox.
?Bedriox\Api\Effect\EffectInstance $previousRead-only event value supplied by Bedriox.
Available methods
effect(): Bedriox\Api\Effect\EffectInstanceTyped public method.
setEffect(Bedriox\Api\Effect\EffectInstance $effect): voidTyped public method.
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\EntityEffectAddEvent;
#[EventHandler]
public function onEntityEffectAddEvent(EntityEffectAddEvent $event): void
{
// Keep listener work bounded and use public capabilities only.
}