ChunkUnloadEvent

Package: com.hypixel.hytale.server.core.universe.world.events.ecs Extends: CancellableEcsEvent Implements: ICancellableEcsEvent Cancellable: Yes

ECS event dispatched when a chunk is being unloaded from memory. Cancelling this event prevents the chunk from being unloaded. The resetKeepAlive field (default true) controls whether the chunk’s keep-alive timer is reset. This can be accessed via willResetKeepAlive() and modified via setResetKeepAlive(boolean).

Fields / Accessors

Field	Type	Accessor	Mutable	Nullable
chunk	WorldChunk	getChunk()	No	No
resetKeepAlive	boolean	willResetKeepAlive()	Yes	No

• chunk — The world chunk being unloaded.
• resetKeepAlive — Whether to reset the chunk’s keep-alive timer. Default: true. Mutable via setResetKeepAlive(boolean).

Fired By

• ChunkUnloadingSystem.unload (line 83) via componentAccessor.invoke(event) — ECS dispatch when a chunk is being unloaded from memory.

Listening

ECS events are handled by EntityEventSystem subclasses, not by getEventRegistry().register(). Chunk events operate on the ChunkStore pipeline, not EntityStore.

public class MyChunkUnloadHandler extends EntityEventSystem<ChunkStore, ChunkUnloadEvent> {
    @Override
    public Query<ChunkStore> getQuery() {
        return MY_COMPONENT_TYPE;
    }

    @Override
    public void handle(int index, ArchetypeChunk<ChunkStore> chunk,
                       Store<ChunkStore> store, CommandBuffer<ChunkStore> commandBuffer,
                       ChunkUnloadEvent event) {
        WorldChunk worldChunk = event.getChunk();

        // Example: prevent unloading chunks near spawn
        if (isNearSpawn(worldChunk)) {
            event.setCancelled(true);
        }
    }
}

// Register in plugin setup():
getChunkStoreRegistry().registerSystem(new MyChunkUnloadHandler());

Related Events

• ChunkSaveEvent — Fired when a chunk is being saved. Typically precedes unload.