BedrioxDOCUMENTATION
SPAWNER EVENT

SpawnerSpawnEvent

Fired after core admission checks and before a spawner submits one authoritative spawn request.

Cancellable pre-eventBedriox\Api\Event\Spawner
WHAT IT REPRESENTS

Represents spawner spawn 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.

Event data

Bedriox\Api\World\World $world

Read-only event value supplied by Bedriox.

Bedriox\Api\World\BlockPosition $spawnerPosition

Read-only event value supplied by Bedriox.

string $entityIdentifier

Read-only event value supplied by Bedriox.

Bedriox\Api\World\Position $spawnPosition

Read-only event value supplied by Bedriox.

bool $trial

Read-only event value supplied by Bedriox.

bool $ominous

Read-only event value supplied by Bedriox.

Available methods

This type does not declare additional public methods.

Inherited methods

isCancelled(): bool from Bedriox\Api\Event\CancellableEvent

Typed public method.

cancel(): void from Bedriox\Api\Event\CancellableEvent

Typed public method.

setCancelled(bool $cancelled): void from Bedriox\Api\Event\CancellableEvent

Typed public method.

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\Spawner\SpawnerSpawnEvent;

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

View exact source ↗