Package net.minecraftforge.common

Class ForgeHooks

java.lang.Object

net.minecraftforge.common.ForgeHooks

public class ForgeHooks
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForgeHooks.BiomeCallbackFunction
private static class	ForgeHooks.LootTableContext

Field Summary

Fields

Modifier and Type	Field	Description
private static Supplier<com.mojang.serialization.Codec<MappedRegistry<LevelStem>>>	CODEC
private static ThreadLocal<Player>	craftingPlayer
private static String	DIMENSIONS_KEY
private static Map<EntityType<? extends LivingEntity>,AttributeSupplier>	FORGE_ATTRIBUTES
private static org.apache.logging.log4j.Marker	FORGEHOOKS
private static org.apache.logging.log4j.Logger	LOGGER
private static ThreadLocal<Deque<ForgeHooks.LootTableContext>>	lootContext
private static String	SEED_KEY
private static Map<EntityDataSerializer<?>,DataSerializerEntry>	serializerEntries
(package private) static Pattern	URL_PATTERN
private static Map<IRegistryDelegate<Item>,Integer>	VANILLA_BURNS
private static Set<String>	VANILLA_DIMS

Constructor Summary

Constructors

Constructor	Description
ForgeHooks()

Method Summary

Modifier and Type	Method	Description
static boolean	canContinueUsing(ItemStack from, ItemStack to)
static boolean	canEntityDestroy(Level world, BlockPos pos, LivingEntity entity)
static int	canEntitySpawn(Mob entity, LevelAccessor world, double x, double y, double z, BaseSpawner spawner, MobSpawnType spawnReason)
static FluidAttributes	createVanillaFluidAttributes(Fluid fluid)
static <T> void	deserializeTagAdditions(List<Tag.Entry> list, com.google.gson.JsonObject json, List<Tag.BuilderEntry> allList)
static Biome	enhanceBiome(ResourceLocation name, Biome.ClimateSettings climate, Biome.BiomeCategory category, Float depth, Float scale, BiomeSpecialEffects effects, BiomeGenerationSettings gen, MobSpawnSettings spawns, com.mojang.serialization.codecs.RecordCodecBuilder.Instance<Biome> codec, ForgeHooks.BiomeCallbackFunction callback)
static void	fixNullStructureReferences(ChunkAccess chunk, Map<StructureFeature<?>,it.unimi.dsi.fastutil.longs.LongSet> structureReferences)	Fixes MC-194811 When a structure mod is removed, this map may contain null keys.
static <T> com.mojang.serialization.Dynamic<T>	fixUpDimensionsData(com.mojang.serialization.Dynamic<T> data)	Restores previously "deleted" dimensions to the world.
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.
static Map<EntityType<? extends LivingEntity>,AttributeSupplier>	getAttributesView()	Deprecated.
static int	getBurnTime(ItemStack stack, RecipeType<?> recipeType)	Gets the burn time of this itemstack.
static ItemStack	getContainerItem(ItemStack stack)
static Player	getCraftingPlayer()
static CriticalHitEvent	getCriticalHit(Player player, Entity target, boolean vanillaCritical, float damageModifier)
static String	getDefaultCreatorModId(ItemStack itemStack)	Used as the default implementation of IForgeItem.getCreatorModId(net.minecraft.world.item.ItemStack).
static String	getDefaultWorldType()
static double	getEntityVisibilityMultiplier(LivingEntity entity, Entity lookingEntity, double originalMultiplier)
static int	getLootingLevel(Entity target, Entity killer, DamageSource cause)
static int	getLootingLevel(LivingEntity target, DamageSource cause, int level)
private static ForgeHooks.LootTableContext	getLootTableContext()
static List<String>	getModPacks()
static List<String>	getModPacksWithVanilla()
static EntityDataSerializer<?>	getSerializer(int id, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static int	getSerializerId(EntityDataSerializer<?> serializer, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static Tag<Block>	getTagFromVanillaTier(Tiers tier)
static boolean	isCorrectToolForDrops(BlockState state, Player player)
static boolean	isLivingOnLadder(BlockState state, Level world, BlockPos pos, LivingEntity entity)
static LootTable	loadLootTable(com.google.gson.Gson gson, ResourceLocation name, com.google.gson.JsonElement data, boolean custom, LootTables lootTableManager)
static void	modifyAttributes()	Deprecated.
static List<ItemStack>	modifyLoot(List<ItemStack> list, LootContext context)	Deprecated. Use modifyLoot(ResourceLocation, List, LootContext) instead.
static List<ItemStack>	modifyLoot(ResourceLocation lootTableId, List<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 void	onAdvancement(ServerPlayer player, Advancement advancement)
static boolean	onAnvilChange(AnvilMenu container, ItemStack left, ItemStack right, Container outputSlot, String name, int baseCost, Player player)
static float	onAnvilRepair(Player player, ItemStack output, ItemStack left, ItemStack right)
static int	onBlockBreakEvent(Level world, GameType gameType, ServerPlayer entityPlayer, BlockPos pos)
static boolean	onChangeGameMode(Player player, GameType currentGameMode, GameType newGameMode)
static void	onCropsGrowPost(Level worldIn, BlockPos pos, BlockState state)
static boolean	onCropsGrowPre(Level worldIn, BlockPos pos, BlockState state, boolean def)
static void	onDifficultyChange(Difficulty difficulty, Difficulty oldDifficulty)
static void	onEmptyClick(Player player, InteractionHand hand)
static void	onEmptyLeftClick(Player player)
static void	onEntityEnterSection(Entity entity, long packedOldPos, long packedNewPos)
static boolean	onFarmlandTrample(Level world, BlockPos pos, BlockState state, float fallDistance, Entity entity)
static InteractionResult	onInteractEntity(Player player, Entity entity, InteractionHand hand)
static InteractionResult	onInteractEntityAt(Player player, Entity entity, HitResult ray, InteractionHand hand)
static InteractionResult	onInteractEntityAt(Player player, Entity entity, Vec3 vec3d, InteractionHand hand)
static InteractionResult	onItemRightClick(Player player, InteractionHand hand)
static PlayerInteractEvent.LeftClickBlock	onLeftClickBlock(Player player, BlockPos pos, Direction face)
static boolean	onLivingAttack(LivingEntity entity, DamageSource src, float amount)
static float	onLivingDamage(LivingEntity entity, DamageSource src, float amount)
static boolean	onLivingDeath(LivingEntity entity, DamageSource src)
static boolean	onLivingDrops(LivingEntity entity, DamageSource source, Collection<ItemEntity> drops, int lootingLevel, boolean recentlyHit)
static float[]	onLivingFall(LivingEntity entity, float distance, float damageMultiplier)
static float	onLivingHurt(LivingEntity entity, DamageSource src, float amount)
static void	onLivingJump(LivingEntity entity)
static LivingKnockBackEvent	onLivingKnockBack(LivingEntity target, float strength, double ratioX, double ratioZ)
static void	onLivingSetAttackTarget(LivingEntity entity, LivingEntity target)
static boolean	onLivingUpdate(LivingEntity entity)
static int	onNoteChange(Level world, BlockPos pos, BlockState state, int old, int _new)
static boolean	onPickBlock(HitResult target, Player player, Level world)	Called when a player uses 'pick block', calls new Entity and Block hooks.
static InteractionResult	onPlaceItemIntoWorld(UseOnContext context)
static boolean	onPlayerAttack(LivingEntity entity, DamageSource src, float amount)
static boolean	onPlayerAttackTarget(Player player, Entity target)
static ItemEntity	onPlayerTossEvent(Player player, ItemStack item, boolean includeName)
static PlayerInteractEvent.RightClickBlock	onRightClickBlock(Player player, InteractionHand hand, BlockPos pos, BlockHitResult hitVec)
static Component	onServerChatEvent(ServerGamePacketListenerImpl net, String raw, Component comp)
static boolean	onTravelToDimension(Entity entity, ResourceKey<Level> dimension)
static String	readLootEntryName(com.google.gson.JsonObject json, String type)
static String	readPoolName(com.google.gson.JsonObject json)
static void	setCraftingPlayer(Player player)
static void	updateBurns()

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

URL_PATTERN

static final Pattern URL_PATTERN

craftingPlayer

private static ThreadLocal<Player> craftingPlayer

lootContext

private static ThreadLocal<Deque<ForgeHooks.LootTableContext>> lootContext

serializerEntries

private static final Map<EntityDataSerializer<?>,DataSerializerEntry> serializerEntries

VANILLA_BURNS

private static final Map<IRegistryDelegate<Item>,Integer> VANILLA_BURNS

VANILLA_DIMS

private static final Set<String> VANILLA_DIMS

DIMENSIONS_KEY

private static final String DIMENSIONS_KEY

See Also:

Constant Field Values

SEED_KEY

private static final String SEED_KEY

See Also:

Constant Field Values

CODEC

private static final Supplier<com.mojang.serialization.Codec<MappedRegistry<LevelStem>>> CODEC

FORGE_ATTRIBUTES

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

Constructor Details

ForgeHooks

public ForgeHooks()

Method Details

canContinueUsing

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

isCorrectToolForDrops

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

onPickBlock

public static boolean onPickBlock(HitResult target,
 Player player,
 Level world)

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

onDifficultyChange

public static void onDifficultyChange(Difficulty difficulty,
 Difficulty oldDifficulty)

onLivingSetAttackTarget

public static void onLivingSetAttackTarget(LivingEntity entity,
 LivingEntity target)

onLivingUpdate

public static boolean onLivingUpdate(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)

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 float[] onLivingFall(LivingEntity entity,
 float distance,
 float damageMultiplier)

getLootingLevel

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

getLootingLevel

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

getEntityVisibilityMultiplier

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

isLivingOnLadder

public static boolean isLivingOnLadder(@Nonnull
 BlockState state,
 @Nonnull
 Level world,
 @Nonnull
 BlockPos pos,
 @Nonnull
 LivingEntity entity)

onLivingJump

public static void onLivingJump(LivingEntity entity)

onPlayerTossEvent

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

onServerChatEvent

@Nullable
public static Component onServerChatEvent(ServerGamePacketListenerImpl net,
 String raw,
 Component comp)

newChatWithLinks

public static Component newChatWithLinks(String string)

newChatWithLinks

public static Component newChatWithLinks(String string,
 boolean allowMissingHeader)

onBlockBreakEvent

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

onPlaceItemIntoWorld

public static InteractionResult onPlaceItemIntoWorld(@Nonnull
 UseOnContext context)

onAnvilChange

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

onAnvilRepair

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

setCraftingPlayer

public static void setCraftingPlayer(Player player)

getCraftingPlayer

public static Player getCraftingPlayer()

getContainerItem

@Nonnull
public static ItemStack getContainerItem(@Nonnull
 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)

onChangeGameMode

public static boolean onChangeGameMode(Player player,
 GameType currentGameMode,
 GameType newGameMode)

getLootTableContext

private static ForgeHooks.LootTableContext getLootTableContext()

loadLootTable

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

createVanillaFluidAttributes

public static FluidAttributes createVanillaFluidAttributes(Fluid fluid)

getDefaultWorldType

public static String getDefaultWorldType()

getTagFromVanillaTier

public static Tag<Block> getTagFromVanillaTier(Tiers tier)

enhanceBiome

public static Biome enhanceBiome(@Nullable
 ResourceLocation name,
 Biome.ClimateSettings climate,
 Biome.BiomeCategory category,
 Float depth,
 Float scale,
 BiomeSpecialEffects effects,
 BiomeGenerationSettings gen,
 MobSpawnSettings spawns,
 com.mojang.serialization.codecs.RecordCodecBuilder.Instance<Biome> codec,
 ForgeHooks.BiomeCallbackFunction callback)

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 worldIn,
 BlockPos pos,
 BlockState state,
 boolean def)

onCropsGrowPost

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

getCriticalHit

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

onAdvancement

public static void onAdvancement(ServerPlayer player,
 Advancement advancement)

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.

getDefaultCreatorModId

@Nullable
public static String getDefaultCreatorModId(@Nonnull
 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 world,
 BlockPos pos,
 BlockState state,
 float fallDistance,
 Entity entity)

onNoteChange

public static int onNoteChange(Level world,
 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)

deserializeTagAdditions

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

getSerializer

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

getSerializerId

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

canEntityDestroy

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

getBurnTime

public static int getBurnTime(ItemStack stack,
 @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, List, 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 List<ItemStack> modifyLoot(ResourceLocation lootTableId,
 List<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()

fixNullStructureReferences

public static void fixNullStructureReferences(ChunkAccess chunk,
 Map<StructureFeature<?>,it.unimi.dsi.fastutil.longs.LongSet> structureReferences)

Fixes MC-194811 When a structure mod is removed, this map may contain null keys. This will make the world unable to save if this persists. If we remove a structure from the save data in this way, we then mark the chunk for saving

fixUpDimensionsData

public static <T>
com.mojang.serialization.Dynamic<T> fixUpDimensionsData(com.mojang.serialization.Dynamic<T> data)

Restores previously "deleted" dimensions to the world. The LenientUnboundedMapCodec prevents this from happening, this is to fix any world from before the fix. TODO: Remove in 1.18

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)