Package net.neoforged.neoforge.event.entity

Class EntityJoinLevelEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.EntityJoinLevelEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class EntityJoinLevelEvent
extends EntityEvent
implements net.neoforged.bus.api.ICancellableEvent

This event is fired whenever an Entity joins a Level. This event is fired whenever an entity is added to a level in LevelWriter.addFreshEntity(Entity) and PersistentEntitySectionManager#addNewEntity(Entity, boolean).

Note: This event may be called before the underlying LevelChunk is promoted to ChunkStatus.FULL. You will cause chunk loading deadlocks if you do not delay your world interactions.

This event is cancellable and does not

invalid reference

have a result

. If the event is canceled, the entity will not be added to the level.

This event is fired on the main Forge event bus on both logical sides.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final Level	level
private final boolean	loadedFromDisk

Constructor Summary

Constructors

Constructor	Description
EntityJoinLevelEvent(Entity entity, Level level)
EntityJoinLevelEvent(Entity entity, Level level, boolean loadedFromDisk)

Method Summary

Modifier and Type	Method	Description
Level	getLevel()	Returns the level that the entity is set to join.
boolean	loadedFromDisk()

Methods inherited from class net.neoforged.neoforge.event.entity.EntityEvent

getEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

level

private final Level level

loadedFromDisk

private final boolean loadedFromDisk

Constructor Details

EntityJoinLevelEvent

public EntityJoinLevelEvent(Entity entity,
 Level level)

EntityJoinLevelEvent

public EntityJoinLevelEvent(Entity entity,
 Level level,
 boolean loadedFromDisk)

Method Details

getLevel

public Level getLevel()

Returns the level that the entity is set to join.

Returns:

the level that the entity is set to join

loadedFromDisk

public boolean loadedFromDisk()

Returns:

true if the entity was loaded from disk, false otherwise. On the logical client, this will always return false.