Class MobSpawnEvent.PositionCheck

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.MobSpawnEvent.PositionCheck

Enclosing class:

MobSpawnEvent

public static class MobSpawnEvent.PositionCheck
extends MobSpawnEvent

This event is fired when a mob checks for a valid spawn position, after SpawnPlacements.checkSpawnRules(EntityType, ServerLevelAccessor, EntitySpawnReason, BlockPos, RandomSource) has been evaluated.
Conditions validated here include the following:

• Obstruction - mobs inside blocks or fluids.
• Pathfinding - if the spawn block is valid for pathfinding.
• Sea Level - Ocelots check if the position is above sea level.
• Spawn Block - Ocelots check if the below block is grass or leaves.

This event is only fired on the logical server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MobSpawnEvent.PositionCheck.Result

Nested classes/interfaces inherited from class MobSpawnEvent

MobSpawnEvent.PositionCheck, MobSpawnEvent.SpawnPlacementCheck

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private MobSpawnEvent.PositionCheck.Result	result
private final @Nullable BaseSpawner	spawner
private final EntitySpawnReason	spawnType

Constructor Summary

Constructors

Constructor	Description
PositionCheck(Mob mob, ServerLevelAccessor level, EntitySpawnReason spawnType, @Nullable BaseSpawner spawner)

Method Summary

Modifier and Type	Method	Description
MobSpawnEvent.PositionCheck.Result	getResult()	Returns the result of this event, which controls if the position check will succeed.
@Nullable BaseSpawner	getSpawner()	Retrieves the underlying BaseSpawner instance if this mob was created by a Mob Spawner of some form.
EntitySpawnReason	getSpawnType()	Retrieves the type of mob spawn that is happening.
void	setResult(MobSpawnEvent.PositionCheck.Result result)	Changes the result of this event.

Methods inherited from class MobSpawnEvent

getEntity, getLevel, getX, getY, getZ

Methods inherited from class Object

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

Field Details

spawner

private final @Nullable BaseSpawner spawner

spawnType

private final EntitySpawnReason spawnType

result

private MobSpawnEvent.PositionCheck.Result result

Constructor Details

PositionCheck

public PositionCheck(Mob mob,
 ServerLevelAccessor level,
 EntitySpawnReason spawnType,
 @Nullable BaseSpawner spawner)

Method Details

getSpawner

public @Nullable BaseSpawner getSpawner()

Retrieves the underlying BaseSpawner instance if this mob was created by a Mob Spawner of some form. This is always null unless getSpawnType() is EntitySpawnReason.SPAWNER, and may still be null even then.

Returns:

The BaseSpawner responsible for triggering the spawn, or null if none is available.

getSpawnType

public EntitySpawnReason getSpawnType()

Retrieves the type of mob spawn that is happening.

Returns:

The mob spawn type.

See Also:

• EntitySpawnReason

setResult

public void setResult(MobSpawnEvent.PositionCheck.Result result)

Changes the result of this event.

getResult

public MobSpawnEvent.PositionCheck.Result getResult()

Returns the result of this event, which controls if the position check will succeed.

Returns:

the result of this event, which controls if the position check will succeed