Package net.neoforged.neoforge.event

Class EventHooks

java.lang.Object

net.neoforged.neoforge.event.EventHooks

public class EventHooks
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private static final WeightedRandomList<MobSpawnSettings.SpawnerData>	NO_SPAWNS

Constructor Summary

Constructors

Constructor	Description
EventHooks()

Method Summary

Modifier and Type	Method	Description
static AlterGroundEvent.StateProvider	alterGround(TreeDecorator.Context ctx, List<BlockPos> positions, AlterGroundEvent.StateProvider provider)	Fires the AlterGroundEvent and retrieves the resulting AlterGroundEvent.StateProvider.
static boolean	canCreateFluidSource(Level level, BlockPos pos, BlockState state)	Checks if a fluid is allowed to create a fluid source.
static boolean	canEntityContinueSleeping(LivingEntity sleeper, @Nullable Player.BedSleepingProblem problem)	Checks if a sleeping entity can continue sleeping with the given sleeping problem.
static boolean	canEntityGrief(Level level, @Nullable Entity entity)	Checks if an entity can perform a griefing action.
static boolean	canLivingConvert(LivingEntity entity, EntityType<? extends LivingEntity> outcome, Consumer<Integer> timer)
static boolean	canMountEntity(Entity entityMounting, Entity entityBeingMounted, boolean isMounting)
static com.mojang.datafixers.util.Either<Player.BedSleepingProblem,Unit>	canPlayerStartSleeping(ServerPlayer player, BlockPos pos, com.mojang.datafixers.util.Either<Player.BedSleepingProblem,Unit> vanillaResult)
static boolean	checkMobDespawn(Mob mob)	Fires MobDespawnEvent and returns true if the default logic should be ignored.
static boolean	checkSpawnPlacements(EntityType<?> entityType, ServerLevelAccessor level, MobSpawnType spawnType, BlockPos pos, RandomSource random, boolean defaultResult)	Internal, should only be called via SpawnPlacements.checkSpawnRules(net.minecraft.world.entity.EntityType<T>, net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.entity.MobSpawnType, net.minecraft.core.BlockPos, net.minecraft.util.RandomSource).
static boolean	checkSpawnPosition(Mob mob, ServerLevelAccessor level, MobSpawnType spawnType)	Checks if the current position of the passed mob is valid for spawning, by firing MobSpawnEvent.PositionCheck. The default check is to perform the logical and of Mob.checkSpawnRules(net.minecraft.world.level.LevelAccessor, net.minecraft.world.entity.MobSpawnType) and Mob.checkSpawnObstruction(net.minecraft.world.level.LevelReader).
static boolean	checkSpawnPositionSpawner(Mob mob, ServerLevelAccessor level, MobSpawnType spawnType, SpawnData spawnData, BaseSpawner spawner)	Specialized variant of checkSpawnPosition(net.minecraft.world.entity.Mob, net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.entity.MobSpawnType) for spawners, as they have slightly different checks, and pass through the BaseSpawner to the event.
static boolean	doPlayerHarvestCheck(Player player, BlockState state, BlockGetter level, BlockPos pos)
static @Nullable SpawnGroupData	finalizeMobSpawn(Mob mob, ServerLevelAccessor level, DifficultyInstance difficulty, MobSpawnType spawnType, @Nullable SpawnGroupData spawnData)	Finalizes the spawn of a mob by firing the FinalizeSpawnEvent and calling Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) with the result.
static FinalizeSpawnEvent	finalizeMobSpawnSpawner(Mob mob, ServerLevelAccessor level, DifficultyInstance difficulty, MobSpawnType spawnType, @Nullable SpawnGroupData spawnData, IOwnedSpawner spawner, boolean def)	Finalizes the spawn of a mob by firing the FinalizeSpawnEvent and calling Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) with the result.
static BlockGrowFeatureEvent	fireBlockGrowFeature(LevelAccessor level, RandomSource rand, BlockPos pos, @Nullable Holder<ConfiguredFeature<?,?>> holder)	Fires the BlockGrowFeatureEvent and returns the event object.
static BonemealEvent	fireBonemealEvent(@Nullable Player player, Level level, BlockPos pos, BlockState state, ItemStack stack)	Called when bone meal (or equivalent) is used on a block.
static void	fireChunkSent(ServerPlayer entity, LevelChunk chunk, ServerLevel level)
static void	fireChunkTicketLevelUpdated(ServerLevel level, long chunkPos, int oldTicketLevel, int newTicketLevel, @Nullable ChunkHolder chunkHolder)
static void	fireChunkUnWatch(ServerPlayer entity, ChunkPos chunkpos, ServerLevel level)
static void	fireChunkWatch(ServerPlayer entity, LevelChunk chunk, ServerLevel level)
static void	fireEntityTickPost(Entity entity)	Fires EntityTickEvent.Post.
static EntityTickEvent.Pre	fireEntityTickPre(Entity entity)	Fires EntityTickEvent.Pre.
static BlockState	fireFluidPlaceBlockEvent(LevelAccessor level, BlockPos pos, BlockPos liquidPos, BlockState state)
static void	fireItemPickupPost(ItemEntity itemEntity, Player player, ItemStack copy)	Called in ItemEntity.playerTouch(Player) after an item was successfully picked up.
static ItemEntityPickupEvent.Pre	fireItemPickupPre(ItemEntity itemEntity, Player player)	Called in ItemEntity.playerTouch(Player) before any other processing occurs.
static void	fireLevelTickPost(Level level, BooleanSupplier haveTime)	Fires LevelTickEvent.Post.
static void	fireLevelTickPre(Level level, BooleanSupplier haveTime)	Fires LevelTickEvent.Pre.
static void	firePlayerChangedDimensionEvent(Player player, ResourceKey<Level> fromDim, ResourceKey<Level> toDim)
static void	firePlayerCraftingEvent(Player player, ItemStack crafted, Container craftMatrix)
static Gui.HeartType	firePlayerHeartTypeEvent(Player player, Gui.HeartType heartType)	Called by Gui.HeartType.forPlayer(net.minecraft.world.entity.player.Player) to allow for modification of the displayed heart type in the health bar.
static void	firePlayerLoadingEvent(Player player, File playerDirectory, String uuidString)
static void	firePlayerLoadingEvent(Player player, PlayerDataStorage playerFileData, String uuidString)
static void	firePlayerLoggedIn(Player player)
static void	firePlayerLoggedOut(Player player)
static void	firePlayerRespawnEvent(ServerPlayer player, boolean fromEndFight)	Called by invalid reference PlayerList#respawn(ServerPlayer, boolean) after creating and initializing the new ServerPlayer.
static PlayerRespawnPositionEvent	firePlayerRespawnPositionEvent(ServerPlayer player, DimensionTransition dimensionTransition, boolean fromEndFight)	Called by invalid reference PlayerList#respawn(ServerPlayer, boolean) before creating the new ServerPlayer to fire the PlayerRespawnPositionEvent
static void	firePlayerSavingEvent(Player player, File playerDirectory, String uuidString)
static void	firePlayerSmeltedEvent(Player player, ItemStack smelted)
static PlayerSpawnPhantomsEvent	firePlayerSpawnPhantoms(ServerPlayer player, ServerLevel level, BlockPos pos)	Called from PhantomSpawner.tick(net.minecraft.server.level.ServerLevel, boolean, boolean) just before the spawn conditions for phantoms are evaluated.
static void	firePlayerTickPost(Player player)	Fires PlayerTickEvent.Post.
static void	firePlayerTickPre(Player player)	Fires PlayerTickEvent.Pre.
static void	fireServerTickPost(BooleanSupplier haveTime, MinecraftServer server)	Fires ServerTickEvent.Post.
static void	fireServerTickPre(BooleanSupplier haveTime, MinecraftServer server)	Fires ServerTickEvent.Pre.
static ItemEnchantments	getAllEnchantmentLevels(ItemEnchantments enchantments, ItemStack stack, HolderLookup.RegistryLookup<Enchantment> lookup)	Fires GetEnchantmentLevelEvent and for all enchantments, returning the (possibly event-modified) enchantment map.
static float	getBreakSpeed(Player player, BlockState state, float original, BlockPos pos)
static int	getEnchantmentLevelSpecific(int level, ItemStack stack, Holder<Enchantment> ench)	Fires GetEnchantmentLevelEvent and for a single enchantment, returning the (possibly event-modified) level.
static EntityEvent.Size	getEntitySizeForge(Entity entity, Pose pose, EntityDimensions size, float eyeHeight)
static EntityEvent.Size	getEntitySizeForge(Entity entity, Pose pose, EntityDimensions oldSize, EntityDimensions newSize, float newEyeHeight)
static int	getExperienceDrop(LivingEntity entity, Player attackingPlayer, int originalExperience)
static Vec3	getExplosionKnockback(Level level, Explosion explosion, Entity entity, Vec3 initialVelocity)	To be called when an explosion has calculated the knockback velocity but has not yet added the knockback to the entity caught in blast.
static int	getItemBurnTime(ItemStack itemStack, int burnTime, @Nullable RecipeType<?> recipeType)
static int	getMaxSpawnClusterSize(Mob entity)	Fires SpawnClusterSizeEvent and returns the size as a result of the event.
static Component	getPlayerDisplayName(Player player, Component username)
static Component	getPlayerTabListDisplayName(Player player)
static WeightedRandomList<MobSpawnSettings.SpawnerData>	getPotentialSpawns(LevelAccessor level, MobCategory category, BlockPos pos, WeightedRandomList<MobSpawnSettings.SpawnerData> oldList)
static @Nullable LootTable	loadLootTable(ResourceLocation name, LootTable table)	Fires the LootTableLoadEvent for non-empty loot tables and returns the table if the event was not canceled and the table was not set to LootTable.EMPTY in the event.
static void	onAdvancementEarnedEvent(Player player, AdvancementHolder earned)
static void	onAdvancementProgressedEvent(Player player, AdvancementHolder progressed, AdvancementProgress advancementProgress, String criterion, AdvancementEvent.AdvancementProgressEvent.ProgressType progressType)
static boolean	onAnimalTame(Animal animal, Player tamer)
static int	onArrowLoose(ItemStack stack, Level level, Player player, int charge, boolean hasAmmo)
static InteractionResultHolder<ItemStack>	onArrowNock(ItemStack item, Level level, Player player, InteractionHand hand, boolean hasAmmo)
static boolean	onBlockPlace(@Nullable Entity entity, BlockSnapshot blockSnapshot, Direction direction)
static EntityTeleportEvent.ChorusFruit	onChorusFruitTeleport(LivingEntity entity, double targetX, double targetY, double targetZ)
static void	onCommandRegister(com.mojang.brigadier.CommandDispatcher<CommandSourceStack> dispatcher, Commands.CommandSelection environment, CommandBuildContext context)
static boolean	onCreateWorldSpawn(Level level, ServerLevelData settings)
static void	onCreativeModeTabBuildContents(CreativeModeTab tab, ResourceKey<CreativeModeTab> tabKey, CreativeModeTab.DisplayItemsGenerator originalGenerator, CreativeModeTab.ItemDisplayParameters params, CreativeModeTab.Output output)	Fires the BuildCreativeModeTabContentsEvent.
static boolean	onEffectRemoved(LivingEntity entity, Holder<MobEffect> effect, @Nullable EffectCure cure)
static boolean	onEffectRemoved(LivingEntity entity, MobEffectInstance effectInstance, @Nullable EffectCure cure)
static int	onEnchantmentLevelSet(Level level, BlockPos pos, int enchantRow, int power, ItemStack itemStack, int enchantmentLevel)
static EntityTeleportEvent.EnderPearl	onEnderPearlLand(ServerPlayer entity, double targetX, double targetY, double targetZ, ThrownEnderpearl pearlEntity, float attackDamage, HitResult hitResult)
static EntityTeleportEvent.EnderEntity	onEnderTeleport(LivingEntity entity, double targetX, double targetY, double targetZ)
static boolean	onEntityDestroyBlock(LivingEntity entity, BlockPos pos, BlockState state)
static boolean	onEntityStruckByLightning(Entity entity, LightningBolt bolt)
static EntityTeleportEvent.TeleportCommand	onEntityTeleportCommand(Entity entity, double targetX, double targetY, double targetZ)
static EntityTeleportEvent.SpreadPlayersCommand	onEntityTeleportSpreadPlayersCommand(Entity entity, double targetX, double targetY, double targetZ)
static void	onExplosionDetonate(Level level, Explosion explosion, List<Entity> list, double diameter)
static boolean	onExplosionStart(Level level, Explosion explosion)
static int	onItemExpire(ItemEntity entity, ItemStack item)
static ItemTooltipEvent	onItemTooltip(ItemStack itemStack, @Nullable Player entityPlayer, List<Component> list, TooltipFlag flags, Item.TooltipContext context)
static ItemStack	onItemUseFinish(LivingEntity entity, ItemStack item, int duration, ItemStack result)
static int	onItemUseStart(LivingEntity entity, ItemStack item, int duration)
static int	onItemUseTick(LivingEntity entity, ItemStack item, int duration)
static void	onLivingConvert(LivingEntity entity, LivingEntity outcome)
static float	onLivingHeal(LivingEntity entity, float amount)
static MobSplitEvent	onMobSplit(Mob parent, List<Mob> children)	Fires the mob split event.
static boolean	onMultiBlockPlace(@Nullable Entity entity, List<BlockSnapshot> blockSnapshots, Direction direction)
static BlockEvent.NeighborNotifyEvent	onNeighborNotify(Level level, BlockPos pos, BlockState state, EnumSet<Direction> notifiedSides, boolean forceRedstoneUpdate)
static boolean	onPermissionChanged(com.mojang.authlib.GameProfile gameProfile, int newLevel, PlayerList playerList)
static void	onPistonMovePost(Level level, BlockPos pos, Direction direction, boolean extending)
static boolean	onPistonMovePre(Level level, BlockPos pos, Direction direction, boolean extending)
static void	onPlayerBrewedPotion(Player player, ItemStack stack)
static void	onPlayerClone(Player player, Player oldPlayer, boolean wasDeath)
static void	onPlayerDestroyItem(Player player, ItemStack stack, @Nullable InteractionHand hand)
static void	onPlayerFall(Player player, float distance, float multiplier)
static boolean	onPlayerSpawnSet(Player player, ResourceKey<Level> levelKey, BlockPos pos, boolean forced)
static void	onPlayerWakeup(Player player, boolean wakeImmediately, boolean updateLevel)
static PlayLevelSoundEvent.AtEntity	onPlaySoundAtEntity(Entity entity, Holder<SoundEvent> name, SoundSource category, float volume, float pitch)
static PlayLevelSoundEvent.AtPosition	onPlaySoundAtPosition(Level level, double x, double y, double z, Holder<SoundEvent> name, SoundSource category, float volume, float pitch)
static boolean	onPotionAttemptBrew(NonNullList<ItemStack> stacks)
static void	onPotionBrewed(NonNullList<ItemStack> brewingItemStacks)
static boolean	onProjectileImpact(Projectile projectile, HitResult ray)
static List<PreparableReloadListener>	onResourceReload(ReloadableServerResources serverResources, RegistryAccess registryAccess)
static long	onSleepFinished(ServerLevel level, long newTime, long minTime)
static void	onStartEntityTracking(Entity entity, Player player)
static StatAwardEvent	onStatAward(Player player, Stat<?> stat, int value)
static void	onStopEntityTracking(Entity entity, Player player)
static @Nullable BlockState	onToolUse(BlockState originalState, UseOnContext context, ToolAction toolAction, boolean simulate)
static Optional<PortalShape>	onTrySpawnPortal(LevelAccessor level, BlockPos pos, Optional<PortalShape> size)
static boolean	onUseItemStop(LivingEntity entity, ItemStack item, int duration)

Methods inherited from class java.lang.Object

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

Field Details

NO_SPAWNS

private static final WeightedRandomList<MobSpawnSettings.SpawnerData> NO_SPAWNS

Constructor Details

EventHooks

public EventHooks()

Method Details

onMultiBlockPlace

public static boolean onMultiBlockPlace(@Nullable
 @Nullable Entity entity,
 List<BlockSnapshot> blockSnapshots,
 Direction direction)

onBlockPlace

public static boolean onBlockPlace(@Nullable
 @Nullable Entity entity,
 BlockSnapshot blockSnapshot,
 Direction direction)

onNeighborNotify

public static BlockEvent.NeighborNotifyEvent onNeighborNotify(Level level,
 BlockPos pos,
 BlockState state,
 EnumSet<Direction> notifiedSides,
 boolean forceRedstoneUpdate)

doPlayerHarvestCheck

public static boolean doPlayerHarvestCheck(Player player,
 BlockState state,
 BlockGetter level,
 BlockPos pos)

getBreakSpeed

public static float getBreakSpeed(Player player,
 BlockState state,
 float original,
 BlockPos pos)

onPlayerDestroyItem

public static void onPlayerDestroyItem(Player player,
 ItemStack stack,
 @Nullable
 @Nullable InteractionHand hand)

checkSpawnPlacements

@Internal
public static boolean checkSpawnPlacements(EntityType<?> entityType,
 ServerLevelAccessor level,
 MobSpawnType spawnType,
 BlockPos pos,
 RandomSource random,
 boolean defaultResult)

Internal, should only be called via SpawnPlacements.checkSpawnRules(net.minecraft.world.entity.EntityType<T>, net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.entity.MobSpawnType, net.minecraft.core.BlockPos, net.minecraft.util.RandomSource).

See Also:

• MobSpawnEvent.SpawnPlacementCheck

checkSpawnPosition

public static boolean checkSpawnPosition(Mob mob,
 ServerLevelAccessor level,
 MobSpawnType spawnType)

Checks if the current position of the passed mob is valid for spawning, by firing MobSpawnEvent.PositionCheck.
The default check is to perform the logical and of Mob.checkSpawnRules(net.minecraft.world.level.LevelAccessor, net.minecraft.world.entity.MobSpawnType) and Mob.checkSpawnObstruction(net.minecraft.world.level.LevelReader).

Parameters:

mob - The mob being spawned.

level - The level the mob will be added to, if successful.

spawnType - The spawn type of the spawn.

Returns:

True, if the position is valid, as determined by the contract of MobSpawnEvent.PositionCheck.

See Also:

• MobSpawnEvent.PositionCheck

checkSpawnPositionSpawner

public static boolean checkSpawnPositionSpawner(Mob mob,
 ServerLevelAccessor level,
 MobSpawnType spawnType,
 SpawnData spawnData,
 BaseSpawner spawner)

Specialized variant of checkSpawnPosition(net.minecraft.world.entity.Mob, net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.entity.MobSpawnType) for spawners, as they have slightly different checks, and pass through the BaseSpawner to the event.

See Also:

• checkSpawnPosition(Mob, ServerLevelAccessor, MobSpawnType)

finalizeMobSpawn

@Nullable
public static @Nullable SpawnGroupData finalizeMobSpawn(Mob mob,
 ServerLevelAccessor level,
 DifficultyInstance difficulty,
 MobSpawnType spawnType,
 @Nullable
 @Nullable SpawnGroupData spawnData)

Finalizes the spawn of a mob by firing the FinalizeSpawnEvent and calling Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) with the result.

Mods should call this method in place of calling Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData), unless calling super from within an override. Vanilla calls to Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) are replaced with calls to this method via coremod, so calls to this method will not show in an IDE.

When interfacing with this event, write all code as normal, and replace the call to Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) with a call to this method.

As an example, the following code block:

 var zombie = new Zombie(level);
 zombie.finalizeSpawn(level, difficulty, spawnType, spawnData);
 level.tryAddFreshEntityWithPassengers(zombie);
 if (zombie.isAddedToWorld()) {
     // Do stuff with your new zombie
 }
 

Would become:

 var zombie = new Zombie(level);
 EventHooks.finalizeMobSpawn(zombie, level, difficulty, spawnType, spawnData);
 level.tryAddFreshEntityWithPassengers(zombie);
 if (zombie.isAddedToWorld()) {
     // Do stuff with your new zombie
 }
 

The only code that changes is the Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) call.

Parameters:

mob - The mob whose spawn is being finalized

level - The level the mob will be spawned in

difficulty - The local difficulty at the position of the mob

spawnType - The type of spawn that is occuring

spawnData - Optional spawn data relevant to the mob being spawned

Returns:

The SpawnGroupData from the finalize, or null if it was canceled. The return value of this method has no bearing on if the entity will be spawned

See Also:

• FinalizeSpawnEvent
• Mob.finalizeSpawn(ServerLevelAccessor, DifficultyInstance, MobSpawnType, SpawnGroupData)

finalizeMobSpawnSpawner

public static FinalizeSpawnEvent finalizeMobSpawnSpawner(Mob mob,
 ServerLevelAccessor level,
 DifficultyInstance difficulty,
 MobSpawnType spawnType,
 @Nullable
 @Nullable SpawnGroupData spawnData,
 IOwnedSpawner spawner,
 boolean def)

Finalizes the spawn of a mob by firing the FinalizeSpawnEvent and calling Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData) with the result.

This method is separate since mob spawners perform special finalizeSpawn handling when NBT data is present, but we still want to fire the event.

This overload is also the only way to pass through an IOwnedSpawner instance.

Parameters:

mob - The mob whose spawn is being finalized

level - The level the mob will be spawned in

difficulty - The local difficulty at the position of the mob

spawnType - The type of spawn that is occuring

spawnData - Optional spawn data relevant to the mob being spawned

spawner - The spawner that is attempting to spawn the mob

def - If the spawner would normally call finalizeSpawn, regardless of the event

firePlayerSpawnPhantoms

public static PlayerSpawnPhantomsEvent firePlayerSpawnPhantoms(ServerPlayer player,
 ServerLevel level,
 BlockPos pos)

Called from PhantomSpawner.tick(net.minecraft.server.level.ServerLevel, boolean, boolean) just before the spawn conditions for phantoms are evaluated. Fires the PlayerSpawnPhantomsEvent and returns the event.

Parameters:

player - The player for whom a spawn attempt is being made

level - The level of the player

pos - The block position of the player

checkMobDespawn

public static boolean checkMobDespawn(Mob mob)

Fires MobDespawnEvent and returns true if the default logic should be ignored.

Parameters:

entity - The entity being despawned.

Returns:

True if the event result is not MobDespawnEvent.Result.DEFAULT, and the vanilla logic should be ignored.

getItemBurnTime

public static int getItemBurnTime(ItemStack itemStack,
 int burnTime,
 @Nullable
 @Nullable RecipeType<?> recipeType)

getExperienceDrop

public static int getExperienceDrop(LivingEntity entity,
 Player attackingPlayer,
 int originalExperience)

getMaxSpawnClusterSize

public static int getMaxSpawnClusterSize(Mob entity)

Fires SpawnClusterSizeEvent and returns the size as a result of the event.

Called in NaturalSpawner.spawnCategoryForPosition(net.minecraft.world.entity.MobCategory, net.minecraft.server.level.ServerLevel, net.minecraft.core.BlockPos) where Mob.getMaxSpawnClusterSize() would normally be called.

Parameters:

entity - The entity whose max spawn cluster size is being queried.

Returns:

The new spawn cluster size.

getPlayerDisplayName

public static Component getPlayerDisplayName(Player player,
 Component username)

getPlayerTabListDisplayName

public static Component getPlayerTabListDisplayName(Player player)

fireFluidPlaceBlockEvent

public static BlockState fireFluidPlaceBlockEvent(LevelAccessor level,
 BlockPos pos,
 BlockPos liquidPos,
 BlockState state)

onItemTooltip

public static ItemTooltipEvent onItemTooltip(ItemStack itemStack,
 @Nullable
 @Nullable Player entityPlayer,
 List<Component> list,
 TooltipFlag flags,
 Item.TooltipContext context)

onEntityStruckByLightning

public static boolean onEntityStruckByLightning(Entity entity,
 LightningBolt bolt)

onItemUseStart

public static int onItemUseStart(LivingEntity entity,
 ItemStack item,
 int duration)

onItemUseTick

public static int onItemUseTick(LivingEntity entity,
 ItemStack item,
 int duration)

onUseItemStop

public static boolean onUseItemStop(LivingEntity entity,
 ItemStack item,
 int duration)

onItemUseFinish

public static ItemStack onItemUseFinish(LivingEntity entity,
 ItemStack item,
 int duration,
 ItemStack result)

onStartEntityTracking

public static void onStartEntityTracking(Entity entity,
 Player player)

onStopEntityTracking

public static void onStopEntityTracking(Entity entity,
 Player player)

firePlayerLoadingEvent

public static void firePlayerLoadingEvent(Player player,
 File playerDirectory,
 String uuidString)

firePlayerSavingEvent

public static void firePlayerSavingEvent(Player player,
 File playerDirectory,
 String uuidString)

firePlayerLoadingEvent

public static void firePlayerLoadingEvent(Player player,
 PlayerDataStorage playerFileData,
 String uuidString)

onToolUse

@Nullable
public static @Nullable BlockState onToolUse(BlockState originalState,
 UseOnContext context,
 ToolAction toolAction,
 boolean simulate)

fireBonemealEvent

public static BonemealEvent fireBonemealEvent(@Nullable
 @Nullable Player player,
 Level level,
 BlockPos pos,
 BlockState state,
 ItemStack stack)

Called when bone meal (or equivalent) is used on a block. Fires the BonemealEvent and returns the event.

Parameters:

player - The player who used the item, if any

level - The level

pos - The position of the target block

state - The state of the target block

stack - The bone meal item stack

Returns:

The event

onPlaySoundAtEntity

public static PlayLevelSoundEvent.AtEntity onPlaySoundAtEntity(Entity entity,
 Holder<SoundEvent> name,
 SoundSource category,
 float volume,
 float pitch)

onPlaySoundAtPosition

public static PlayLevelSoundEvent.AtPosition onPlaySoundAtPosition(Level level,
 double x,
 double y,
 double z,
 Holder<SoundEvent> name,
 SoundSource category,
 float volume,
 float pitch)

onItemExpire

public static int onItemExpire(ItemEntity entity,
 ItemStack item)

fireItemPickupPre

public static ItemEntityPickupEvent.Pre fireItemPickupPre(ItemEntity itemEntity,
 Player player)

Called in ItemEntity.playerTouch(Player) before any other processing occurs.

Fires ItemEntityPickupEvent.Pre and returns the event.

Parameters:

itemEntity - The item entity that a player collided with

player - The player that collided with the item entity

fireItemPickupPost

public static void fireItemPickupPost(ItemEntity itemEntity,
 Player player,
 ItemStack copy)

Called in ItemEntity.playerTouch(Player) after an item was successfully picked up.

Fires ItemEntityPickupEvent.Post.

Parameters:

itemEntity - The item entity that a player collided with

player - The player that collided with the item entity

copy - A copy of the item entity's item stack before the pickup

canMountEntity

public static boolean canMountEntity(Entity entityMounting,
 Entity entityBeingMounted,
 boolean isMounting)

onAnimalTame

public static boolean onAnimalTame(Animal animal,
 Player tamer)

canPlayerStartSleeping

public static com.mojang.datafixers.util.Either<Player.BedSleepingProblem,Unit> canPlayerStartSleeping(ServerPlayer player,
 BlockPos pos,
 com.mojang.datafixers.util.Either<Player.BedSleepingProblem,Unit> vanillaResult)

onPlayerWakeup

public static void onPlayerWakeup(Player player,
 boolean wakeImmediately,
 boolean updateLevel)

onPlayerFall

public static void onPlayerFall(Player player,
 float distance,
 float multiplier)

onPlayerSpawnSet

public static boolean onPlayerSpawnSet(Player player,
 ResourceKey<Level> levelKey,
 BlockPos pos,
 boolean forced)

onPlayerClone

public static void onPlayerClone(Player player,
 Player oldPlayer,
 boolean wasDeath)

onExplosionStart

public static boolean onExplosionStart(Level level,
 Explosion explosion)

onExplosionDetonate

public static void onExplosionDetonate(Level level,
 Explosion explosion,
 List<Entity> list,
 double diameter)

getExplosionKnockback

public static Vec3 getExplosionKnockback(Level level,
 Explosion explosion,
 Entity entity,
 Vec3 initialVelocity)

To be called when an explosion has calculated the knockback velocity but has not yet added the knockback to the entity caught in blast.

Parameters:

level - The level that the explosion is in

explosion - Explosion that is happening

entity - The entity caught in the explosion's blast

initialVelocity - The explosion calculated velocity for the entity

Returns:

The new explosion velocity to add to the entity's existing velocity

onCreateWorldSpawn

public static boolean onCreateWorldSpawn(Level level,
 ServerLevelData settings)

onLivingHeal

public static float onLivingHeal(LivingEntity entity,
 float amount)

onPotionAttemptBrew

public static boolean onPotionAttemptBrew(NonNullList<ItemStack> stacks)

onPotionBrewed

public static void onPotionBrewed(NonNullList<ItemStack> brewingItemStacks)

onPlayerBrewedPotion

public static void onPlayerBrewedPotion(Player player,
 ItemStack stack)

canEntityContinueSleeping

public static boolean canEntityContinueSleeping(LivingEntity sleeper,
 @Nullable
 @Nullable Player.BedSleepingProblem problem)

Checks if a sleeping entity can continue sleeping with the given sleeping problem.

Returns:

true if the entity may continue sleeping

onArrowNock

public static InteractionResultHolder<ItemStack> onArrowNock(ItemStack item,
 Level level,
 Player player,
 InteractionHand hand,
 boolean hasAmmo)

onArrowLoose

public static int onArrowLoose(ItemStack stack,
 Level level,
 Player player,
 int charge,
 boolean hasAmmo)

onProjectileImpact

public static boolean onProjectileImpact(Projectile projectile,
 HitResult ray)

loadLootTable

@Nullable
public static @Nullable LootTable loadLootTable(ResourceLocation name,
 LootTable table)

Fires the LootTableLoadEvent for non-empty loot tables and returns the table if the event was not canceled and the table was not set to LootTable.EMPTY in the event. Otherwise returns null which maps to an empty Optional in LootDataType.deserialize(ResourceLocation, DynamicOps, Object)

canCreateFluidSource

public static boolean canCreateFluidSource(Level level,
 BlockPos pos,
 BlockState state)

Checks if a fluid is allowed to create a fluid source. This fires the CreateFluidSourceEvent. By default, a fluid can create a source if it returns true to IFluidStateExtension.canConvertToSource(Level, BlockPos)

onTrySpawnPortal

public static Optional<PortalShape> onTrySpawnPortal(LevelAccessor level,
 BlockPos pos,
 Optional<PortalShape> size)

onEnchantmentLevelSet

public static int onEnchantmentLevelSet(Level level,
 BlockPos pos,
 int enchantRow,
 int power,
 ItemStack itemStack,
 int enchantmentLevel)

onEntityDestroyBlock

public static boolean onEntityDestroyBlock(LivingEntity entity,
 BlockPos pos,
 BlockState state)

canEntityGrief

public static boolean canEntityGrief(Level level,
 @Nullable
 @Nullable Entity entity)

Checks if an entity can perform a griefing action.

If an entity is provided, this method fires EntityMobGriefingEvent. If an entity is not provided, this method returns the value of GameRules.RULE_MOBGRIEFING.

Parameters:

level - The level of the action

entity - The entity performing the action, or null if unknown.

Returns:

fireBlockGrowFeature

public static BlockGrowFeatureEvent fireBlockGrowFeature(LevelAccessor level,
 RandomSource rand,
 BlockPos pos,
 @Nullable
 @Nullable Holder<ConfiguredFeature<?,?>> holder)

Fires the BlockGrowFeatureEvent and returns the event object.

Parameters:

level - The level the feature will be grown in

rand - The random source

pos - The position the feature will be grown at

holder - The feature to be grown, if any

alterGround

public static AlterGroundEvent.StateProvider alterGround(TreeDecorator.Context ctx,
 List<BlockPos> positions,
 AlterGroundEvent.StateProvider provider)

Fires the AlterGroundEvent and retrieves the resulting AlterGroundEvent.StateProvider.

Parameters:

ctx - The tree decoration context for the current alteration.

positions - The list of positions that are considered roots.

provider - The original BlockStateProvider from the AlterGroundDecorator.

Returns:

The (possibly event-modified) AlterGroundEvent.StateProvider to be used for ground alteration.

fireChunkTicketLevelUpdated

public static void fireChunkTicketLevelUpdated(ServerLevel level,
 long chunkPos,
 int oldTicketLevel,
 int newTicketLevel,
 @Nullable
 @Nullable ChunkHolder chunkHolder)

fireChunkWatch

public static void fireChunkWatch(ServerPlayer entity,
 LevelChunk chunk,
 ServerLevel level)

fireChunkSent

public static void fireChunkSent(ServerPlayer entity,
 LevelChunk chunk,
 ServerLevel level)

fireChunkUnWatch

public static void fireChunkUnWatch(ServerPlayer entity,
 ChunkPos chunkpos,
 ServerLevel level)

onPistonMovePre

public static boolean onPistonMovePre(Level level,
 BlockPos pos,
 Direction direction,
 boolean extending)

onPistonMovePost

public static void onPistonMovePost(Level level,
 BlockPos pos,
 Direction direction,
 boolean extending)

onSleepFinished

public static long onSleepFinished(ServerLevel level,
 long newTime,
 long minTime)

onResourceReload

public static List<PreparableReloadListener> onResourceReload(ReloadableServerResources serverResources,
 RegistryAccess registryAccess)

onCommandRegister

public static void onCommandRegister(com.mojang.brigadier.CommandDispatcher<CommandSourceStack> dispatcher,
 Commands.CommandSelection environment,
 CommandBuildContext context)

getEntitySizeForge

public static EntityEvent.Size getEntitySizeForge(Entity entity,
 Pose pose,
 EntityDimensions size,
 float eyeHeight)

getEntitySizeForge

public static EntityEvent.Size getEntitySizeForge(Entity entity,
 Pose pose,
 EntityDimensions oldSize,
 EntityDimensions newSize,
 float newEyeHeight)

canLivingConvert

public static boolean canLivingConvert(LivingEntity entity,
 EntityType<? extends LivingEntity> outcome,
 Consumer<Integer> timer)

onLivingConvert

public static void onLivingConvert(LivingEntity entity,
 LivingEntity outcome)

onEntityTeleportCommand

public static EntityTeleportEvent.TeleportCommand onEntityTeleportCommand(Entity entity,
 double targetX,
 double targetY,
 double targetZ)

onEntityTeleportSpreadPlayersCommand

public static EntityTeleportEvent.SpreadPlayersCommand onEntityTeleportSpreadPlayersCommand(Entity entity,
 double targetX,
 double targetY,
 double targetZ)

onEnderTeleport

public static EntityTeleportEvent.EnderEntity onEnderTeleport(LivingEntity entity,
 double targetX,
 double targetY,
 double targetZ)

onEnderPearlLand

@Internal
public static EntityTeleportEvent.EnderPearl onEnderPearlLand(ServerPlayer entity,
 double targetX,
 double targetY,
 double targetZ,
 ThrownEnderpearl pearlEntity,
 float attackDamage,
 HitResult hitResult)

onChorusFruitTeleport

public static EntityTeleportEvent.ChorusFruit onChorusFruitTeleport(LivingEntity entity,
 double targetX,
 double targetY,
 double targetZ)

onPermissionChanged

public static boolean onPermissionChanged(com.mojang.authlib.GameProfile gameProfile,
 int newLevel,
 PlayerList playerList)

firePlayerChangedDimensionEvent

public static void firePlayerChangedDimensionEvent(Player player,
 ResourceKey<Level> fromDim,
 ResourceKey<Level> toDim)

firePlayerLoggedIn

public static void firePlayerLoggedIn(Player player)

firePlayerLoggedOut

public static void firePlayerLoggedOut(Player player)

firePlayerRespawnPositionEvent

public static PlayerRespawnPositionEvent firePlayerRespawnPositionEvent(ServerPlayer player,
 DimensionTransition dimensionTransition,
 boolean fromEndFight)

Called by

invalid reference

PlayerList#respawn(ServerPlayer, boolean)

before creating the new ServerPlayer to fire the PlayerRespawnPositionEvent

Parameters:

player - The old ServerPlayer that is being respawned

fromEndFight - Whether the player is respawning because they jumped through the End return portal

respawnLevel - The default level the player will respawn into

respawnAngle - The angle the player will face when they respawn

respawnPosition - The position in the level the player will respawn at

Returns:

The event

firePlayerRespawnEvent

public static void firePlayerRespawnEvent(ServerPlayer player,
 boolean fromEndFight)

Called by

invalid reference

PlayerList#respawn(ServerPlayer, boolean)

after creating and initializing the new ServerPlayer.

Parameters:

player - The new player instance created by the respawn process

fromEndFight - Whether the player is respawning because they jumped through the End return portal

firePlayerCraftingEvent

public static void firePlayerCraftingEvent(Player player,
 ItemStack crafted,
 Container craftMatrix)

firePlayerSmeltedEvent

public static void firePlayerSmeltedEvent(Player player,
 ItemStack smelted)

firePlayerHeartTypeEvent

public static Gui.HeartType firePlayerHeartTypeEvent(Player player,
 Gui.HeartType heartType)

Called by Gui.HeartType.forPlayer(net.minecraft.world.entity.player.Player) to allow for modification of the displayed heart type in the health bar.

Parameters:

player - The local Player

heartType - The Gui.HeartType which would be displayed by vanilla

Returns:

The heart type which should be displayed

fireEntityTickPre

public static EntityTickEvent.Pre fireEntityTickPre(Entity entity)

Fires EntityTickEvent.Pre. Called from the head of LivingEntity.tick().

Parameters:

entity - The entity being ticked

Returns:

The event

fireEntityTickPost

public static void fireEntityTickPost(Entity entity)

Fires EntityTickEvent.Post. Called from the tail of LivingEntity.tick().

Parameters:

entity - The entity being ticked

firePlayerTickPre

public static void firePlayerTickPre(Player player)

Fires PlayerTickEvent.Pre. Called from the head of Player.tick().

Parameters:

player - The player being ticked

firePlayerTickPost

public static void firePlayerTickPost(Player player)

Fires PlayerTickEvent.Post. Called from the tail of Player.tick().

Parameters:

player - The player being ticked

fireLevelTickPre

public static void fireLevelTickPre(Level level,
 BooleanSupplier haveTime)

Fires LevelTickEvent.Pre. Called from Minecraft.tick() and MinecraftServer.tickChildren(BooleanSupplier) just before the try block for level tick is entered.

Parameters:

level - The level being ticked

haveTime - The time supplier, indicating if there is remaining time to do work in the current tick.

fireLevelTickPost

public static void fireLevelTickPost(Level level,
 BooleanSupplier haveTime)

Fires LevelTickEvent.Post. Called from Minecraft.tick() and MinecraftServer.tickChildren(BooleanSupplier) just after the try block for level tick is exited.

Parameters:

level - The level being ticked

haveTime - The time supplier, indicating if there is remaining time to do work in the current tick.

fireServerTickPre

public static void fireServerTickPre(BooleanSupplier haveTime,
 MinecraftServer server)

Fires ServerTickEvent.Pre. Called from the head of MinecraftServer.tickServer(BooleanSupplier).

Parameters:

haveTime - The time supplier, indicating if there is remaining time to do work in the current tick.

server - The current server

fireServerTickPost

public static void fireServerTickPost(BooleanSupplier haveTime,
 MinecraftServer server)

Fires ServerTickEvent.Post. Called from the tail of MinecraftServer.tickServer(BooleanSupplier).

Parameters:

haveTime - The time supplier, indicating if there is remaining time to do work in the current tick.

server - The current server

getPotentialSpawns

public static WeightedRandomList<MobSpawnSettings.SpawnerData> getPotentialSpawns(LevelAccessor level,
 MobCategory category,
 BlockPos pos,
 WeightedRandomList<MobSpawnSettings.SpawnerData> oldList)

onStatAward

public static StatAwardEvent onStatAward(Player player,
 Stat<?> stat,
 int value)

onAdvancementEarnedEvent

@Internal
public static void onAdvancementEarnedEvent(Player player,
 AdvancementHolder earned)

onAdvancementProgressedEvent

@Internal
public static void onAdvancementProgressedEvent(Player player,
 AdvancementHolder progressed,
 AdvancementProgress advancementProgress,
 String criterion,
 AdvancementEvent.AdvancementProgressEvent.ProgressType progressType)

onEffectRemoved

public static boolean onEffectRemoved(LivingEntity entity,
 Holder<MobEffect> effect,
 @Nullable
 @Nullable EffectCure cure)

onEffectRemoved

public static boolean onEffectRemoved(LivingEntity entity,
 MobEffectInstance effectInstance,
 @Nullable
 @Nullable EffectCure cure)

getEnchantmentLevelSpecific

public static int getEnchantmentLevelSpecific(int level,
 ItemStack stack,
 Holder<Enchantment> ench)

Fires GetEnchantmentLevelEvent and for a single enchantment, returning the (possibly event-modified) level.

Parameters:

level - The original level of the enchantment as provided by the Item.

stack - The stack being queried against.

ench - The enchantment being queried for.

Returns:

The new level of the enchantment.

getAllEnchantmentLevels

public static ItemEnchantments getAllEnchantmentLevels(ItemEnchantments enchantments,
 ItemStack stack,
 HolderLookup.RegistryLookup<Enchantment> lookup)

Fires GetEnchantmentLevelEvent and for all enchantments, returning the (possibly event-modified) enchantment map.

Parameters:

enchantments - The original enchantment map as provided by the Item.

stack - The stack being queried against.

Returns:

The new enchantment map.

onCreativeModeTabBuildContents

@Internal
public static void onCreativeModeTabBuildContents(CreativeModeTab tab,
 ResourceKey<CreativeModeTab> tabKey,
 CreativeModeTab.DisplayItemsGenerator originalGenerator,
 CreativeModeTab.ItemDisplayParameters params,
 CreativeModeTab.Output output)

Fires the BuildCreativeModeTabContentsEvent.

Parameters:

tab - The tab that contents are being collected for.

tabKey - The resource key of the tab.

originalGenerator - The display items generator that populates vanilla entries.

params - Display parameters, controlling if certain items are hidden.

output - The output acceptor.

onMobSplit

public static MobSplitEvent onMobSplit(Mob parent,
 List<Mob> children)

Fires the mob split event. Returns the event for cancellation checking.

Parameters:

parent - The parent mob, which is in the process of being removed.

children - All child mobs that would have normally spawned.

Returns:

The event object.