Package net.minecraftforge.common

Class ForgeHooks

java.lang.Object

net.minecraftforge.common.ForgeHooks

@Internal
public final class ForgeHooks
extends Object

FOR INTERNAL USE ONLY, DO NOT CALL DIRECTLY

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForgeHooks.BiomeCallbackFunction

Field Summary

Fields

Modifier and Type	Field	Description
private static final ThreadLocal<Player>	CRAFTING_PLAYER
private static final Map<EntityType<? extends LivingEntity>,AttributeSupplier>	FORGE_ATTRIBUTES
private static final Lazy<Map<String,StructuresBecomeConfiguredFix.Conversion>>	FORGE_CONVERSION_MAP
private static final org.apache.logging.log4j.Marker	FORGEHOOKS
private static final org.apache.logging.log4j.Logger	LOGGER
(package private) static final Pattern	URL_PATTERN
private static final Map<Holder.Reference<Item>,Integer>	VANILLA_BURNS
private static final org.apache.logging.log4j.Marker	WORLDPERSISTENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ForgeHooks()

Method Summary

Modifier and Type	Method	Description
static boolean	canContinueUsing(@NotNull ItemStack from, @NotNull ItemStack to)
static boolean	canEntityDestroy(Level level, BlockPos pos, LivingEntity entity)
static boolean	canUseEntitySelectors(SharedSuggestionProvider provider)
static <E extends LootPool> com.mojang.serialization.Codec<List<E>>	createLootTablePoolCodec(com.mojang.serialization.Codec<E> vanilla)
static void	dropXpForBlock(BlockState state, ServerLevel level, BlockPos pos, ItemStack stack)
static String	encodeLifecycle(com.mojang.serialization.Lifecycle lifecycle)
static com.mojang.serialization.Codec<Ingredient>	enhanceIngredientCodec(com.mojang.serialization.Codec<Ingredient> vanilla)
static DataComponentMap	gatherItemComponents(Item item, DataComponentMap dataComponents)
static Map<EntityType<? extends LivingEntity>,AttributeSupplier>	getAttributesView()	Deprecated.
static int	getBurnTime(ItemStack stack, @Nullable RecipeType<?> recipeType)	Gets the burn time of this itemstack.
static Player	getCraftingPlayer()
static @NotNull ItemStack	getCraftingRemainingItem(@NotNull ItemStack stack)
static @Nullable CriticalHitEvent	getCriticalHit(Player player, Entity target, boolean vanillaCritical, float damageModifier)
static <B extends FriendlyByteBuf> StreamCodec<B,? extends CustomPacketPayload>	getCustomPayloadCodec(ResourceLocation id, int max)
static @Nullable String	getDefaultCreatorModId(@NotNull ItemStack itemStack)	Used as the default implementation of IForgeItem.getCreatorModId(net.minecraft.world.item.ItemStack).
static @Nullable DyeColor	getDyeColorFromItemStack(ItemStack stack)
static Packet<ClientGamePacketListener>	getEntitySpawnPacket(Entity entity)
static double	getEntityVisibilityMultiplier(LivingEntity entity, Entity lookingEntity, double originalMultiplier)
static int	getLootingLevel(Entity target, @Nullable Entity killer, @Nullable DamageSource cause)
static int	getLootingLevel(LivingEntity target, @Nullable DamageSource cause, int level)
static List<String>	getModPacks()
static List<String>	getModPacksWithVanilla()
static ItemStack	getProjectile(LivingEntity entity, ItemStack projectileWeaponItem, ItemStack projectile)	Hook to fire LivingGetProjectileEvent.
static @Nullable EntityDataSerializer<?>	getSerializer(int id, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static int	getSerializerId(EntityDataSerializer<?> serializer, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static FluidType	getVanillaFluidType(Fluid fluid)	Returns a vanilla fluid type for the given fluid.
static void	handleClientConfigurationComplete(Connection connection)
static boolean	hasNoElements(Ingredient ingredient)
static StreamCodec<RegistryFriendlyByteBuf,Ingredient>	ingredientStreamCodec()
static boolean	isCorrectToolForDrops(@NotNull BlockState state, @NotNull Player player)
static Optional<BlockPos>	isLivingOnLadder(@NotNull BlockState state, @NotNull Level level, @NotNull BlockPos pos, @NotNull LivingEntity entity)
static void	modifyAttributes()	Deprecated.
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.
static Component	newChatWithLinks(String string)
static Component	newChatWithLinks(String string, boolean allowMissingHeader)
static boolean	onAnvilChange(AnvilMenu container, @NotNull ItemStack left, @NotNull ItemStack right, Container outputSlot, String name, long baseCost, Player player)
static int	onBlockBreakEvent(Level level, GameType gameType, ServerPlayer entityPlayer, BlockPos pos)
static GameType	onChangeGameType(Player player, GameType currentGameType, GameType newGameType)
static void	onCreativeModeTabBuildContents(CreativeModeTab tab, ResourceKey<CreativeModeTab> tabKey, CreativeModeTab.DisplayItemsGenerator originalGenerator, CreativeModeTab.ItemDisplayParameters params, CreativeModeTab.Output output)
static void	onCropsGrowPost(Level level, BlockPos pos, BlockState state)
static boolean	onCropsGrowPre(Level level, BlockPos pos, BlockState state, boolean def)
static boolean	onCustomPayload(CustomPacketPayload payload, Connection connection)
static boolean	onCustomPayload(ClientboundCustomQueryPacket packet, Connection connection)
static boolean	onCustomPayload(ServerboundCustomQueryAnswerPacket packet, Connection connection)
static boolean	onCustomPayload(CustomPayloadEvent event)
static boolean	onFarmlandTrample(Level level, BlockPos pos, BlockState state, float fallDistance, Entity entity)
static boolean	onGrindstoneTake(Container inputSlots, ContainerLevelAccess access, Function<Level,Integer> xpFunction)
static InteractionResult	onInteractEntityAt(Entity entity, Player player, Vec3 vec3d, InteractionHand hand)
static InteractionResult	onItemRightClick(Player player, InteractionHand hand)
static boolean	onLivingAttack(LivingEntity entity, DamageSource src, float amount)
static void	onLivingBreathe(LivingEntity entity, int consumeAirAmount, int refillAirAmount)	Handles living entities being under water.
static float	onLivingDamage(LivingEntity entity, DamageSource src, float amount)
static float	onLivingHurt(LivingEntity entity, DamageSource src, float amount)
static void	onLivingJump(LivingEntity entity)
static Brain<?>	onLivingMakeBrain(LivingEntity entity, Brain<?> originalBrain, com.mojang.serialization.Dynamic<?> dynamic)
static boolean	onLivingUseTotem(LivingEntity entity, DamageSource damageSource, ItemStack totem, InteractionHand hand)
static int	onNoteChange(Level level, BlockPos pos, BlockState state, int old, int _new)
static InteractionResult	onPlaceItemIntoWorld(@NotNull UseOnContext context)
static boolean	onPlayerAttack(LivingEntity entity, DamageSource src, float amount)
static boolean	onPlayerAttackTarget(Player player, Entity target)
static @Nullable ItemEntity	onPlayerTossEvent(@NotNull Player player, @NotNull ItemStack item, boolean includeName)
static @Nullable Component	onServerChatSubmittedEvent(ServerPlayer player, Component message)
static com.mojang.serialization.Lifecycle	parseLifecycle(String lifecycle)
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
static void	readAdditionalLevelSaveData(LevelStorageSource.LevelStorageAccess access, LevelStorageSource.LevelDirectory levelDirectory)
static boolean	readAndTestCondition(RegistryOps<com.google.gson.JsonElement> ops, com.google.gson.JsonObject json)
static @Nullable com.google.gson.JsonObject	readConditionalAdvancement(RegistryOps<com.google.gson.JsonElement> context, com.google.gson.JsonObject json)
static void	setCraftingPlayer(Player player)
static boolean	shouldSuppressEnderManAnger(EnderMan enderMan, Player player, ItemStack mask)
static void	updateBurns()
static <T> HolderLookup.RegistryLookup<T>	wrapRegistryLookup(HolderLookup.RegistryLookup<T> lookup)
static void	writeAdditionalLevelSaveData(WorldData worldData, CompoundTag levelTag)
static void	writeCondition(ICondition condition, com.google.gson.JsonObject out)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

FORGEHOOKS

private static final org.apache.logging.log4j.Marker FORGEHOOKS

WORLDPERSISTENCE

private static final org.apache.logging.log4j.Marker WORLDPERSISTENCE

URL_PATTERN

static final Pattern URL_PATTERN

CRAFTING_PLAYER

private static final ThreadLocal<Player> CRAFTING_PLAYER

VANILLA_BURNS

private static final Map<Holder.Reference<Item>,Integer> VANILLA_BURNS

FORGE_ATTRIBUTES

private static final Map<EntityType<? extends LivingEntity>,AttributeSupplier> FORGE_ATTRIBUTES

FORGE_CONVERSION_MAP

private static final Lazy<Map<String,StructuresBecomeConfiguredFix.Conversion>> FORGE_CONVERSION_MAP

Constructor Details

ForgeHooks

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

onLivingMakeBrain

public static Brain<?> onLivingMakeBrain(LivingEntity entity,
 Brain<?> originalBrain,
 com.mojang.serialization.Dynamic<?> dynamic)

onLivingAttack

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

onPlayerAttack

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

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)

onInteractEntityAt

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

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)

onServerChatSubmittedEvent

@Nullable
public static @Nullable Component onServerChatSubmittedEvent(ServerPlayer player,
 Component message)

newChatWithLinks

public static Component newChatWithLinks(String string)

newChatWithLinks

public static Component newChatWithLinks(String string,
 boolean allowMissingHeader)

dropXpForBlock

public static void dropXpForBlock(BlockState state,
 ServerLevel level,
 BlockPos pos,
 ItemStack stack)

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,
 long baseCost,
 Player player)

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)

onItemRightClick

public static InteractionResult onItemRightClick(Player player,
 InteractionHand hand)

onChangeGameType

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

createLootTablePoolCodec

public static <E extends LootPool>
com.mojang.serialization.Codec<List<E>> createLootTablePoolCodec(com.mojang.serialization.Codec<E> vanilla)

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

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)

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)

hasNoElements

public static boolean hasNoElements(Ingredient ingredient)

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

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

API Note:

The given context will be modified by this method to also store the ID of the loot table being queried.

getModPacks

public static List<String> getModPacks()

getModPacksWithVanilla

public static List<String> getModPacksWithVanilla()

getAttributesView

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

Deprecated.

modifyAttributes

@Deprecated
public static void modifyAttributes()

Deprecated.

writeAdditionalLevelSaveData

public static void writeAdditionalLevelSaveData(WorldData worldData,
 CompoundTag levelTag)

readAdditionalLevelSaveData

@Internal
public static void readAdditionalLevelSaveData(LevelStorageSource.LevelStorageAccess access,
 LevelStorageSource.LevelDirectory levelDirectory)

encodeLifecycle

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

parseLifecycle

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

shouldSuppressEnderManAnger

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

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)

wrapRegistryLookup

@Internal
public static <T> HolderLookup.RegistryLookup<T> wrapRegistryLookup(HolderLookup.RegistryLookup<T> lookup)

onLivingBreathe

public static void onLivingBreathe(LivingEntity entity,
 int consumeAirAmount,
 int refillAirAmount)

Handles living entities being under water. This fires the LivingBreatheEvent and if the entity's air supply is less than or equal to zero also the LivingDrownEvent. Additionally when the entity is under water it will dismount if

invalid reference

IForgeEntity#canBeRiddenUnderFluidType(FluidType, Entity)

returns false.

Parameters:

entity - The living entity which is currently updated

consumeAirAmount - The amount of air to consume when the entity is unable to breathe

refillAirAmount - The amount of air to refill when the entity is able to breathe

Implementation Note:

This method needs to closely replicate the logic found right after the call site in LivingEntity.baseTick() as it overrides it.

onCreativeModeTabBuildContents

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

getCustomPayloadCodec

@Internal
public static <B extends FriendlyByteBuf>
StreamCodec<B,? extends CustomPacketPayload> getCustomPayloadCodec(ResourceLocation id,
 int max)

onCustomPayload

@Internal
public static boolean onCustomPayload(CustomPacketPayload payload,
 Connection connection)

onCustomPayload

@Internal
public static boolean onCustomPayload(ClientboundCustomQueryPacket packet,
 Connection connection)

onCustomPayload

@Internal
public static boolean onCustomPayload(ServerboundCustomQueryAnswerPacket packet,
 Connection connection)

onCustomPayload

@Internal
public static boolean onCustomPayload(CustomPayloadEvent event)

handleClientConfigurationComplete

@Internal
public static void handleClientConfigurationComplete(Connection connection)

getEntitySpawnPacket

@Internal
public static Packet<ClientGamePacketListener> getEntitySpawnPacket(Entity entity)

readAndTestCondition

@Internal
public static boolean readAndTestCondition(RegistryOps<com.google.gson.JsonElement> ops,
 com.google.gson.JsonObject json)

writeCondition

@Internal
public static void writeCondition(ICondition condition,
 com.google.gson.JsonObject out)

readConditionalAdvancement

@Nullable
@Internal
public static @Nullable com.google.gson.JsonObject readConditionalAdvancement(RegistryOps<com.google.gson.JsonElement> context,
 com.google.gson.JsonObject json)

enhanceIngredientCodec

@Internal
public static com.mojang.serialization.Codec<Ingredient> enhanceIngredientCodec(com.mojang.serialization.Codec<Ingredient> vanilla)

ingredientStreamCodec

public static StreamCodec<RegistryFriendlyByteBuf,Ingredient> ingredientStreamCodec()

getDyeColorFromItemStack

@Nullable
public static @Nullable DyeColor getDyeColorFromItemStack(ItemStack stack)

gatherItemComponents

public static DataComponentMap gatherItemComponents(Item item,
 DataComponentMap dataComponents)