Class ForgeHooks

Method Details

• canContinueUsing

  public static boolean canContinueUsing(@NotNull @NotNull ItemStack from, @NotNull @NotNull ItemStack to)

• isCorrectToolForDrops

  public static boolean isCorrectToolForDrops(@NotNull @NotNull BlockState state, @NotNull @NotNull Player player)

• onPickBlock

  @Deprecated(forRemoval=true, since="1.19") public static boolean onPickBlock(HitResult target, Player player, Level level)

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

  Called when a player uses 'pick block', calls new Entity and Block hooks.

• onItemStackedOn

  public static boolean onItemStackedOn(ItemStack carriedItem, ItemStack stackedOnItem, Slot slot, ClickAction action, Player player, SlotAccess carriedSlotAccess)

• onDifficultyChange

  public static void onDifficultyChange(Difficulty difficulty, Difficulty oldDifficulty)

• onLivingSetAttackTarget

  @Deprecated(since="1.19.2", forRemoval=true) public static void onLivingSetAttackTarget(LivingEntity entity, LivingEntity target)

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

• onLivingSetAttackTarget

  @Deprecated(since="1.19.2", forRemoval=true) public static void onLivingSetAttackTarget(LivingEntity entity, LivingEntity target, LivingChangeTargetEvent.ILivingTargetType targetType)

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

• onLivingChangeTarget

  public static LivingChangeTargetEvent onLivingChangeTarget(LivingEntity entity, LivingEntity originalTarget, LivingChangeTargetEvent.ILivingTargetType targetType)

• onLivingTick

  public static boolean onLivingTick(LivingEntity entity)

• onLivingAttack

  public static boolean onLivingAttack(LivingEntity entity, DamageSource src, float amount)

• onPlayerAttack

  public static boolean onPlayerAttack(LivingEntity entity, DamageSource src, float amount)

• onLivingKnockBack

  public static LivingKnockBackEvent onLivingKnockBack(LivingEntity target, float strength, double ratioX, double ratioZ)

• onLivingUseTotem

  public static boolean onLivingUseTotem(LivingEntity entity, DamageSource damageSource, ItemStack totem, InteractionHand hand)

• onLivingHurt

  public static float onLivingHurt(LivingEntity entity, DamageSource src, float amount)

• onLivingDamage

  public static float onLivingDamage(LivingEntity entity, DamageSource src, float amount)

• onLivingDeath

  public static boolean onLivingDeath(LivingEntity entity, DamageSource src)

• onLivingDrops

  public static boolean onLivingDrops(LivingEntity entity, DamageSource source, Collection<ItemEntity> drops, int lootingLevel, boolean recentlyHit)

• onLivingFall

  @Nullable public static @org.jetbrains.annotations.Nullable float[] onLivingFall(LivingEntity entity, float distance, float damageMultiplier)

• getLootingLevel

  public static int getLootingLevel(Entity target, @Nullable @Nullable Entity killer, @Nullable @Nullable DamageSource cause)

• getLootingLevel

  public static int getLootingLevel(LivingEntity target, @Nullable @Nullable DamageSource cause, int level)

• getEntityVisibilityMultiplier

  public static double getEntityVisibilityMultiplier(LivingEntity entity, Entity lookingEntity, double originalMultiplier)

• isLivingOnLadder

  public static Optional<BlockPos> isLivingOnLadder(@NotNull @NotNull BlockState state, @NotNull @NotNull Level level, @NotNull @NotNull BlockPos pos, @NotNull @NotNull LivingEntity entity)

• onLivingJump

  public static void onLivingJump(LivingEntity entity)

• onPlayerTossEvent

  @Nullable public static @Nullable ItemEntity onPlayerTossEvent(@NotNull @NotNull Player player, @NotNull @NotNull ItemStack item, boolean includeName)

• onVanillaGameEvent

  public static boolean onVanillaGameEvent(Level level, GameEvent vanillaEvent, Vec3 pos, GameEvent.Context context)

• getRawText

  private static String getRawText(Component message)

• onServerChatSubmittedEvent

  @Nullable public static @Nullable Component onServerChatSubmittedEvent(ServerPlayer player, String plain, Component decorated, boolean canChangeMessage)

• getServerChatSubmittedDecorator

  @NotNull public static @NotNull ChatDecorator getServerChatSubmittedDecorator()

• onServerChatPreviewEvent

  @Nullable public static @Nullable Component onServerChatPreviewEvent(@NotNull @NotNull ServerPlayer player, @NotNull @NotNull Component message)

• getServerChatPreviewDecorator

  @NotNull public static @NotNull ChatDecorator getServerChatPreviewDecorator()

• newChatWithLinks

  public static Component newChatWithLinks(String string)

• newChatWithLinks

  public static Component newChatWithLinks(String string, boolean allowMissingHeader)

• onBlockBreakEvent

  public static int onBlockBreakEvent(Level level, GameType gameType, ServerPlayer entityPlayer, BlockPos pos)

• onPlaceItemIntoWorld

  public static InteractionResult onPlaceItemIntoWorld(@NotNull @NotNull UseOnContext context)

• onAnvilChange

  public static boolean onAnvilChange(AnvilMenu container, @NotNull @NotNull ItemStack left, @NotNull @NotNull ItemStack right, Container outputSlot, String name, int baseCost, Player player)

• onAnvilRepair

  public static float onAnvilRepair(Player player, @NotNull @NotNull ItemStack output, @NotNull @NotNull ItemStack left, @NotNull @NotNull ItemStack right)

• onGrindstoneChange

  public static int onGrindstoneChange(@NotNull @NotNull ItemStack top, @NotNull @NotNull ItemStack bottom, Container outputSlot, int xp)

• onGrindstoneTake

  public static boolean onGrindstoneTake(Container inputSlots, ContainerLevelAccess access, Function<Level,Integer> xpFunction)

• setCraftingPlayer

  public static void setCraftingPlayer(Player player)

• getCraftingPlayer

  public static Player getCraftingPlayer()

• getCraftingRemainingItem

  @NotNull public static @NotNull ItemStack getCraftingRemainingItem(@NotNull @NotNull ItemStack stack)

• onPlayerAttackTarget

  public static boolean onPlayerAttackTarget(Player player, Entity target)

• onTravelToDimension

  public static boolean onTravelToDimension(Entity entity, ResourceKey<Level> dimension)

• onInteractEntityAt

  public static InteractionResult onInteractEntityAt(Player player, Entity entity, HitResult ray, InteractionHand hand)

• onInteractEntityAt

  public static InteractionResult onInteractEntityAt(Player player, Entity entity, Vec3 vec3d, InteractionHand hand)

• onInteractEntity

  public static InteractionResult onInteractEntity(Player player, Entity entity, InteractionHand hand)

• onItemRightClick

  public static InteractionResult onItemRightClick(Player player, InteractionHand hand)

• onLeftClickBlock

  public static PlayerInteractEvent.LeftClickBlock onLeftClickBlock(Player player, BlockPos pos, Direction face)

• onRightClickBlock

  public static PlayerInteractEvent.RightClickBlock onRightClickBlock(Player player, InteractionHand hand, BlockPos pos, BlockHitResult hitVec)

• onEmptyClick

  public static void onEmptyClick(Player player, InteractionHand hand)

• onEmptyLeftClick

  public static void onEmptyLeftClick(Player player)

• onChangeGameType

  @Nullable public static @Nullable GameType onChangeGameType(Player player, GameType currentGameType, GameType newGameType)

  Returns:

  null if game type should not be changed, desired new GameType otherwise

• getLootTableContext

  private static ForgeHooks.LootTableContext getLootTableContext()

• loadLootTable

  @Nullable public static @Nullable LootTable loadLootTable(com.google.gson.Gson gson, ResourceLocation name, com.google.gson.JsonElement data, boolean custom, LootTables lootTableManager)

• getVanillaFluidType

  public static FluidType getVanillaFluidType(Fluid fluid)

  Returns a vanilla fluid type for the given fluid.

  Parameters:

  fluid - the fluid looking for its type

  Returns:

  the type of the fluid if vanilla

  Throws:

  RuntimeException - if the fluid is not a vanilla one

• getTagFromVanillaTier

  public static TagKey<Block> getTagFromVanillaTier(Tiers tier)

• readPoolName

  public static String readPoolName(com.google.gson.JsonObject json)

• readLootEntryName

  public static String readLootEntryName(com.google.gson.JsonObject json, String type)

• onCropsGrowPre

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

• onCropsGrowPost

  public static void onCropsGrowPost(Level level, BlockPos pos, BlockState state)

• getCriticalHit

  @Nullable public static @Nullable CriticalHitEvent getCriticalHit(Player player, Entity target, boolean vanillaCritical, float damageModifier)

• onAdvancement

  @Deprecated(forRemoval=true, since="1.19.2") public static void onAdvancement(ServerPlayer player, Advancement advancement)

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

  See ForgeEventFactory.onAdvancementEarnedEvent(net.minecraft.world.entity.player.Player, net.minecraft.advancements.Advancement) and ForgeEventFactory.onAdvancementProgressedEvent(net.minecraft.world.entity.player.Player, net.minecraft.advancements.Advancement, net.minecraft.advancements.AdvancementProgress, java.lang.String, net.minecraftforge.event.entity.player.AdvancementEvent.AdvancementProgressEvent.ProgressType)

• getAttributeModifiers

  public static com.google.common.collect.Multimap<Attribute,AttributeModifier> getAttributeModifiers(ItemStack stack, EquipmentSlot equipmentSlot, com.google.common.collect.Multimap<Attribute,AttributeModifier> attributes)

  Hook to fire ItemAttributeModifierEvent. Modders should use ItemStack.getAttributeModifiers(EquipmentSlot) instead.

• getProjectile

  public static ItemStack getProjectile(LivingEntity entity, ItemStack projectileWeaponItem, ItemStack projectile)

  Hook to fire LivingGetProjectileEvent. Returns the ammo to be used.

• getDefaultCreatorModId

  @Nullable public static @Nullable String getDefaultCreatorModId(@NotNull @NotNull ItemStack itemStack)

  Used as the default implementation of IForgeItem.getCreatorModId(net.minecraft.world.item.ItemStack). Call that method instead.

• onFarmlandTrample

  public static boolean onFarmlandTrample(Level level, BlockPos pos, BlockState state, float fallDistance, Entity entity)

• onNoteChange

  public static int onNoteChange(Level level, BlockPos pos, BlockState state, int old, int _new)

• canEntitySpawn

  public static int canEntitySpawn(Mob entity, LevelAccessor world, double x, double y, double z, BaseSpawner spawner, MobSpawnType spawnReason)

• hasNoElements

  public static boolean hasNoElements(Ingredient ingredient)

• deserializeTagAdditions

  public static <T> void deserializeTagAdditions(List<TagEntry> list, com.google.gson.JsonObject json, List<TagEntry> allList)

• getSerializer

  @Nullable public static @Nullable EntityDataSerializer<?> getSerializer(int id, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)

• getSerializerId

  public static int getSerializerId(EntityDataSerializer<?> serializer, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)

• canEntityDestroy

  public static boolean canEntityDestroy(Level level, BlockPos pos, LivingEntity entity)

• getBurnTime

  public static int getBurnTime(ItemStack stack, @Nullable @Nullable RecipeType<?> recipeType)

  Gets the burn time of this itemstack.

• updateBurns

  public static void updateBurns()

• modifyLoot

  @Deprecated public static List<ItemStack> modifyLoot(List<ItemStack> list, LootContext context)

  Deprecated.

  Use modifyLoot(ResourceLocation, ObjectArrayList, LootContext) instead.

  All loot table drops should be passed to this function so that mod added effects (e.g. smelting enchantments) can be processed.

  Parameters:

  list - The loot generated

  context - The loot context that generated that loot

  Returns:

  The modified list

• modifyLoot

  public static it.unimi.dsi.fastutil.objects.ObjectArrayList<ItemStack> modifyLoot(ResourceLocation lootTableId, it.unimi.dsi.fastutil.objects.ObjectArrayList<ItemStack> generatedLoot, LootContext context)

  Handles the modification of loot table drops via the registered Global Loot Modifiers, so that custom effects can be processed.

  All loot-table generated loot should be passed to this function.

  Parameters:

  lootTableId - The ID of the loot table currently being queried

  generatedLoot - The loot generated by the loot table

  context - The loot context that generated the loot, unmodified

  Returns:

  The modified list of drops

• getModPacks

  public static List<String> getModPacks()

• getModPacksWithVanilla

  public static List<String> getModPacksWithVanilla()

• getAttributesView

  @Deprecated public static Map<EntityType<? extends LivingEntity>,AttributeSupplier> getAttributesView()

  Deprecated.

  FOR INTERNAL USE ONLY, DO NOT CALL DIRECTLY

• modifyAttributes

  @Deprecated public static void modifyAttributes()

  Deprecated.

  FOR INTERNAL USE ONLY, DO NOT CALL DIRECTLY

• onEntityEnterSection

  public static void onEntityEnterSection(Entity entity, long packedOldPos, long packedNewPos)

• onShieldBlock

  public static ShieldBlockEvent onShieldBlock(LivingEntity blocker, DamageSource source, float blocked)

• writeAdditionalLevelSaveData

  public static void writeAdditionalLevelSaveData(WorldData worldData, CompoundTag levelTag)

• readAdditionalLevelSaveData

  @Deprecated(forRemoval=true, since="1.19.2") public static void readAdditionalLevelSaveData(CompoundTag rootTag)

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

  To be removed in 1.20. Use readAdditionalLevelSaveData(CompoundTag, LevelStorageSource.LevelDirectory) instead.

• readAdditionalLevelSaveData

  @Internal public static void readAdditionalLevelSaveData(CompoundTag rootTag, @Nullable LevelStorageSource.LevelDirectory levelDirectory)

  Parameters:

  rootTag - Level data file contents.

  levelDirectory - Level currently being loaded. TODO 1.20 - Remove nullable annotation

• encodeLifecycle

  public static String encodeLifecycle(com.mojang.serialization.Lifecycle lifecycle)

• parseLifecycle

  public static com.mojang.serialization.Lifecycle parseLifecycle(String lifecycle)

• saveMobEffect

  public static void saveMobEffect(CompoundTag nbt, String key, MobEffect effect)

• loadMobEffect

  @Nullable public static @Nullable MobEffect loadMobEffect(CompoundTag nbt, String key, @Nullable @Nullable MobEffect fallback)

• shouldSuppressEnderManAnger

  public static boolean shouldSuppressEnderManAnger(EnderMan enderMan, Player player, ItemStack mask)

• readTypedPackFormats

  public static Map<PackType,Integer> readTypedPackFormats(com.google.gson.JsonObject json)

• prefixNamespace

  public static String prefixNamespace(ResourceLocation registryKey)

  This method is used to prefix the path, where elements of the associated registry are stored, with their namespace, if it is not minecraft

  This rules conflicts with equal paths out. If for example the mod fancy_cheese adds a registry named cheeses, but the mod awesome_cheese also adds a registry called cheeses, they are going to have the same path cheeses, just with different namespaces. If additional_cheese wants to add additional cheese to awesome_cheese, but not fancy_cheese, it can not differentiate both. Both paths will look like data/additional_cheese/cheeses.

  The fix, which is applied here prefixes the path of the registry with the namespace, so fancy_cheese's registry stores its elements in data/<namespace>/fancy_cheese/cheeses and awesome_cheese's registry stores its elements in data/namespace/awesome_cheese/cheeses

  Parameters:

  registryKey - key of the registry

  Returns:

  path of the registry key. Prefixed with the namespace if it is not "minecraft"

• canUseEntitySelectors

  public static boolean canUseEntitySelectors(SharedSuggestionProvider provider)

• filterThunks

  public static <E> Collection<Map.Entry<ResourceKey<E>,RegistryResourceAccess.EntryThunk<E>>> filterThunks(Map<ResourceKey<E>,RegistryResourceAccess.EntryThunk<E>> map)