Package dev.architectury.event.events.common

Interface LifecycleEvent

public interface LifecycleEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LifecycleEvent.InstanceState<T>
static interface	LifecycleEvent.LevelState<T extends net.minecraft.world.level.Level>
static interface	LifecycleEvent.ServerLevelState
static interface	LifecycleEvent.ServerState

Field Summary

Fields

Modifier and Type	Field	Description
static final Event<LifecycleEvent.ServerState>	SERVER_BEFORE_START	Invoked before initial server startup.
static final Event<LifecycleEvent.ServerLevelState>	SERVER_LEVEL_LOAD	Invoked when a level is loaded on the server-side.
static final Event<LifecycleEvent.ServerLevelState>	SERVER_LEVEL_SAVE	Invoked when the level is being saved.
static final Event<LifecycleEvent.ServerLevelState>	SERVER_LEVEL_UNLOAD	Invoked when a level is unloaded on the server-side.
static final Event<LifecycleEvent.ServerState>	SERVER_STARTED	Invoked when the server has started and is ready to accept players.
static final Event<LifecycleEvent.ServerState>	SERVER_STARTING	Invoked during server startup.
static final Event<LifecycleEvent.ServerState>	SERVER_STOPPED	Invoked when the server has finished stopping, and is about to fully shut down.
static final Event<LifecycleEvent.ServerState>	SERVER_STOPPING	Invoked when the server begins shutting down.
static final Event<Runnable>	SETUP	Invoked once common setup has begun.

Field Details

SERVER_BEFORE_START

static final Event<LifecycleEvent.ServerState> SERVER_BEFORE_START

Invoked before initial server startup. This is the earliest point at which the server will be available. Equivalent to Forge's FMLServerAboutToStartEvent event and Fabric's ServerLifecycleEvents#SERVER_STARTING.

See Also:

• LifecycleEvent.InstanceState.stateChanged(Object)

SERVER_STARTING

static final Event<LifecycleEvent.ServerState> SERVER_STARTING

Invoked during server startup. Equivalent to Forge's FMLServerStartingEvent event.

See Also:

• LifecycleEvent.InstanceState.stateChanged(Object)

SERVER_STARTED

static final Event<LifecycleEvent.ServerState> SERVER_STARTED

Invoked when the server has started and is ready to accept players. Equivalent to Forge's FMLServerStartedEvent event and Fabric's ServerLifecycleEvents#SERVER_STARTED.

See Also:

• LifecycleEvent.InstanceState.stateChanged(Object)

SERVER_STOPPING

static final Event<LifecycleEvent.ServerState> SERVER_STOPPING

Invoked when the server begins shutting down. Equivalent to Forge's FMLServerStoppingEvent event and Fabric's ServerLifecycleEvents#SERVER_STOPPING.

See Also:

• LifecycleEvent.InstanceState.stateChanged(Object)

SERVER_STOPPED

static final Event<LifecycleEvent.ServerState> SERVER_STOPPED

Invoked when the server has finished stopping, and is about to fully shut down. Equivalent to Forge's FMLServerStoppedEvent event and Fabric's ServerLifecycleEvents#SERVER_STOPPED.

See Also:

• LifecycleEvent.InstanceState.stateChanged(Object)

SERVER_LEVEL_LOAD

static final Event<LifecycleEvent.ServerLevelState> SERVER_LEVEL_LOAD

Invoked when a level is loaded on the server-side. Equivalent to Forge's WorldEvent.Load event (on server) and Fabric's ServerWorldEvents#LOAD.

See Also:

• LifecycleEvent.LevelState.act(Level)

SERVER_LEVEL_UNLOAD

static final Event<LifecycleEvent.ServerLevelState> SERVER_LEVEL_UNLOAD

Invoked when a level is unloaded on the server-side. Equivalent to Forge's WorldEvent.Unload event (on server) and Fabric's ServerWorldEvents#UNLOAD.

See Also:

• LifecycleEvent.LevelState.act(Level)

SERVER_LEVEL_SAVE

static final Event<LifecycleEvent.ServerLevelState> SERVER_LEVEL_SAVE

Invoked when the level is being saved. Equivalent to Forge's WorldEvent.Save event.

See Also:

• LifecycleEvent.LevelState.act(Level)

SETUP

static final Event<Runnable> SETUP

Invoked once common setup has begun.

This happens during FMLCommonSetupEvent on Forge, or when Architectury API's client/server entrypoint initialises on Fabric.

Registries should have been initialised by this point, but there are no such guarantees, as you can modify the registry beyond this point on non-Forge environments.