Represents world load before Bedriox commits the related authoritative change. Plugins may inspect it and cancel or adjust only the values explicitly exposed below.
WorldLoadEvent
Cancellable intent emitted before existing world storage is opened.
Cancellable pre-eventBedriox\Api\Event\World
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 WorldLoadedEvent as the committed outcome. That event cannot cancel or undo the result.
Event data
string $worldIdRead-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\World\WorldLoadEvent;
#[EventHandler]
public function onWorldLoadEvent(WorldLoadEvent $event): void
{
// Keep listener work bounded and use public capabilities only.
}