Package net.neoforged.neoforge.event.entity

Class SpawnPlacementRegisterEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.SpawnPlacementRegisterEvent

All Implemented Interfaces:

net.neoforged.fml.event.IModBusEvent

public class SpawnPlacementRegisterEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.fml.event.IModBusEvent

This event allows each EntityType to have a SpawnPlacements.SpawnPredicate registered or modified. Spawn Predicates are checked whenever an Entity of the given EntityType spawns in the world naturally. If registering your own entity's spawn placements, you should use register(EntityType, SpawnPlacementType, Heightmap.Types, SpawnPlacements.SpawnPredicate, Operation) So that you ensure that your entity has a heightmap type and placement type registered. If modifying vanilla or another mod's spawn placements, you can use three operations: REPLACE: checked first, the last mod to replace the predicate wipes out all other predicates. Listen with a low EventPriority if you need to do this. OR: checked second, only one of these predicates must pass along with the original predicate AND: checked third, these predicates must all pass along with the original predicate

This event is not cancellable and does not

invalid reference

have a result

.

Fired on the Mod bus IModBusEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpawnPlacementRegisterEvent.MergedSpawnPredicate<T extends Entity>
static enum	SpawnPlacementRegisterEvent.Operation

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<EntityType<?>,SpawnPlacementRegisterEvent.MergedSpawnPredicate<?>>	map

Constructor Summary

Constructors

Constructor	Description
SpawnPlacementRegisterEvent(Map<EntityType<?>,SpawnPlacementRegisterEvent.MergedSpawnPredicate<?>> map)

Method Summary

Modifier and Type	Method	Description
<T extends Entity> void	register(EntityType<T> entityType, @Nullable SpawnPlacementType placementType, Heightmap.Types heightmap, SpawnPlacements.SpawnPredicate<T> predicate, SpawnPlacementRegisterEvent.Operation operation)	Register a predicate for a given entityType and operation With the option of changing the placementType and heightmap.
<T extends Entity> void	register(EntityType<T> entityType, SpawnPlacements.SpawnPredicate<T> predicate)	Register an optional spawn placement predicate for a given entityType
<T extends Entity> void	register(EntityType<T> entityType, SpawnPlacements.SpawnPredicate<T> predicate, SpawnPlacementRegisterEvent.Operation operation)	Register a predicate for a given entityType with a given operation for handling

Methods inherited from class java.lang.Object

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

Field Details

map

private final Map<EntityType<?>,SpawnPlacementRegisterEvent.MergedSpawnPredicate<?>> map

Constructor Details

SpawnPlacementRegisterEvent

@Internal
public SpawnPlacementRegisterEvent(Map<EntityType<?>,SpawnPlacementRegisterEvent.MergedSpawnPredicate<?>> map)

Method Details

register

public <T extends Entity> void register(EntityType<T> entityType,
 SpawnPlacements.SpawnPredicate<T> predicate)

Register an optional spawn placement predicate for a given entityType

register

public <T extends Entity> void register(EntityType<T> entityType,
 SpawnPlacements.SpawnPredicate<T> predicate,
 SpawnPlacementRegisterEvent.Operation operation)

Register a predicate for a given entityType with a given operation for handling

register

public <T extends Entity> void register(EntityType<T> entityType,
 @Nullable
 @Nullable SpawnPlacementType placementType,
 @Nullable
 Heightmap.Types heightmap,
 SpawnPlacements.SpawnPredicate<T> predicate,
 SpawnPlacementRegisterEvent.Operation operation)

Register a predicate for a given entityType and operation With the option of changing the placementType and heightmap. These are only applied if SpawnPlacementRegisterEvent.Operation.REPLACE is used. Use null for the placement or heightmap to leave them as is (which should be done in almost every case)