Package net.neoforged.neoforge.event.entity.living

Class MobDespawnEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.MobSpawnEvent

net.neoforged.neoforge.event.entity.living.MobDespawnEvent

public class MobDespawnEvent
extends MobSpawnEvent

This event is fired from Mob.checkDespawn().
It fires once per tick per mob that is attempting to despawn.

It is fired for all entities, including persistent entities. Additionally, it may be used to keep mobs from despawning in peaceful mode.

This event is only fired on the logical server.

See Also:

• Mob.checkDespawn()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MobDespawnEvent.Result

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

MobSpawnEvent.PositionCheck, MobSpawnEvent.SpawnPlacementCheck

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
protected MobDespawnEvent.Result	result

Constructor Summary

Constructors

Constructor	Description
MobDespawnEvent(Mob mob, ServerLevelAccessor level)	Fire via EventHooks.checkMobDespawn(Mob)

Method Summary

Modifier and Type	Method	Description
MobDespawnEvent.Result	getResult()	Returns the result of this event, which controls if the despawn will occur.
void	setResult(MobDespawnEvent.Result result)	Changes the result of this event.

Methods inherited from class net.neoforged.neoforge.event.entity.living.MobSpawnEvent

getEntity, getLevel, getX, getY, getZ

Methods inherited from class java.lang.Object

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

Field Details

result

protected MobDespawnEvent.Result result

Constructor Details

MobDespawnEvent

@Internal
public MobDespawnEvent(Mob mob,
 ServerLevelAccessor level)

Fire via EventHooks.checkMobDespawn(Mob)

Method Details

setResult

public void setResult(MobDespawnEvent.Result result)

Changes the result of this event.

getResult

public MobDespawnEvent.Result getResult()

Returns the result of this event, which controls if the despawn will occur.

Returns:

the result of this event, which controls if the despawn will occur