Class ForgeEventFactory

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, @NotNull @NotNull BlockSnapshot blockSnapshot, @NotNull @NotNull 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, boolean success)

• getBreakSpeed

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

• onPlayerDestroyItem

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

• onFinalizeSpawn

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

  Vanilla calls to Mob.finalizeSpawn(net.minecraft.world.level.ServerLevelAccessor, net.minecraft.world.DifficultyInstance, net.minecraft.world.entity.MobSpawnType, net.minecraft.world.entity.SpawnGroupData, net.minecraft.nbt.CompoundTag) are replaced with calls to this method via coremod.
  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, net.minecraft.nbt.CompoundTag). Super calls (from within overrides) should not be wrapped.

  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, net.minecraft.nbt.CompoundTag) with a call to this method.

  As an example, the following code block:

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

  Would become:

   var zombie = new Zombie(level);
   ForgeEventFactory.onFinalizeSpawn(zombie, level, difficulty, spawnType, spawnData, spawnTag);
   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, net.minecraft.nbt.CompoundTag) call.

  Returns:

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

  See Also:

  • MobSpawnEvent.FinalizeSpawn
  • Mob.finalizeSpawn(ServerLevelAccessor, DifficultyInstance, MobSpawnType, SpawnGroupData, CompoundTag)

• onFinalizeSpawnSpawner

  @Nullable public static MobSpawnEvent.FinalizeSpawn onFinalizeSpawnSpawner(Mob mob, ServerLevelAccessor level, DifficultyInstance difficulty, @Nullable @Nullable SpawnGroupData spawnData, @Nullable @Nullable CompoundTag spawnTag, BaseSpawner spawner)

  Returns the FinalizeSpawn event instance, or null if it was canceled.
  This 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 a BaseSpawner instance.

  See Also:

  • MobSpawnEvent.FinalizeSpawn

• canEntityDespawn

  public static net.minecraftforge.eventbus.api.Event.Result canEntityDespawn(Mob entity, ServerLevelAccessor level)

• getItemBurnTime

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

• getExperienceDrop

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

• getMaxSpawnPackSize

  public static int getMaxSpawnPackSize(Mob entity)

• 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)

• fireZombieSummonAid

  public static ZombieEvent.SummonAidEvent fireZombieSummonAid(Zombie zombie, Level level, int x, int y, int z, LivingEntity attacker, double summonChance)

• 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)

• onApplyBonemeal

  public static int onApplyBonemeal(@NotNull @NotNull Player player, @NotNull @NotNull Level level, @NotNull @NotNull BlockPos pos, @NotNull @NotNull BlockState state, @NotNull @NotNull ItemStack stack)

• onBucketUse

  @Nullable public static @Nullable InteractionResultHolder<ItemStack> onBucketUse(@NotNull @NotNull Player player, @NotNull @NotNull Level level, @NotNull @NotNull ItemStack stack, @Nullable @Nullable HitResult target)

• 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, @NotNull @NotNull ItemStack item)

• onItemPickup

  public static int onItemPickup(ItemEntity entityItem, Player player)

• canMountEntity

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

• onAnimalTame

  public static boolean onAnimalTame(Animal animal, Player tamer)

• onPlayerSleepInBed

  public static Player.BedSleepingProblem onPlayerSleepInBed(Player player, Optional<BlockPos> pos)

• 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)

• 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)

• gatherCapabilities

  @Nullable public static <T extends ICapabilityProvider> @Nullable CapabilityDispatcher gatherCapabilities(Class<? extends T> type, T provider)

• gatherCapabilities

  @Nullable public static <T extends ICapabilityProvider> @Nullable CapabilityDispatcher gatherCapabilities(Class<? extends T> type, T provider, @Nullable @Nullable ICapabilityProvider parent)

• gatherCapabilities

  @Nullable private static @Nullable CapabilityDispatcher gatherCapabilities(AttachCapabilitiesEvent<?> event, @Nullable @Nullable ICapabilityProvider parent)

• fireSleepingLocationCheck

  public static boolean fireSleepingLocationCheck(LivingEntity player, BlockPos sleepingLocation)

• fireSleepingTimeCheck

  public static boolean fireSleepingTimeCheck(Player player, Optional<BlockPos> sleepingLocation)

• 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

  public static LootTable loadLootTable(ResourceLocation name, LootTable table, LootTables lootTableManager)

• canCreateFluidSource

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

• 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)

• getMobGriefingEvent

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

• saplingGrowTree

  @Deprecated(forRemoval=true, since="1.19.2") public static boolean saplingGrowTree(LevelAccessor level, RandomSource randomSource, BlockPos pos)

  Deprecated, for removal: This API element is subject to removal in a future version.

• blockGrowFeature

  public static SaplingGrowTreeEvent blockGrowFeature(LevelAccessor level, RandomSource randomSource, BlockPos pos, @Nullable @Nullable Holder<ConfiguredFeature<?,?>> holder)

• alterGround

  public static BlockState alterGround(LevelSimulatedReader level, RandomSource random, BlockPos pos, BlockState altered)

• 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)

• 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 boolean 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)

• 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 @Deprecated(forRemoval=true, since="1.19.2") public static EntityTeleportEvent.EnderPearl onEnderPearlLand(ServerPlayer entity, double targetX, double targetY, double targetZ, ThrownEnderpearl pearlEntity, float attackDamage)

  Deprecated, for removal: This API element is subject to removal in a future version.

  Use the hit result-sensitive version.

• onEnderPearlLand

  @Internal public static EntityTeleportEvent.EnderPearl onEnderPearlLand(ServerPlayer entity, double targetX, double targetY, double targetZ, ThrownEnderpearl pearlEntity, float attackDamage, @Nullable @Nullable 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)

• firePlayerRespawnEvent

  public static void firePlayerRespawnEvent(Player player, boolean endConquered)

• firePlayerItemPickupEvent

  public static void firePlayerItemPickupEvent(Player player, ItemEntity item, ItemStack clone)

• firePlayerCraftingEvent

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

• firePlayerSmeltedEvent

  public static void firePlayerSmeltedEvent(Player player, ItemStack smelted)

• onRenderTickStart

  public static void onRenderTickStart(float timer)

• onRenderTickEnd

  public static void onRenderTickEnd(float timer)

• onPlayerPreTick

  public static void onPlayerPreTick(Player player)

• onPlayerPostTick

  public static void onPlayerPostTick(Player player)

• onPreLevelTick

  public static void onPreLevelTick(Level level, BooleanSupplier haveTime)

• onPostLevelTick

  public static void onPostLevelTick(Level level, BooleanSupplier haveTime)

• onPreClientTick

  public static void onPreClientTick()

• onPostClientTick

  public static void onPostClientTick()

• onPreServerTick

  public static void onPreServerTick(BooleanSupplier haveTime, MinecraftServer server)

• onPostServerTick

  public static void onPostServerTick(BooleanSupplier haveTime, MinecraftServer server)

• getPotentialSpawns

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

• onAdvancementEarnedEvent

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

• onAdvancementProgressedEvent

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