Package net.neoforged.neoforge.common

Class CommonHooks

java.lang.Object

net.neoforged.neoforge.common.CommonHooks

public class CommonHooks
extends Object

Class for various common (i.e. client and server-side) hooks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommonHooks.BiomeCallbackFunction

Field Summary

Fields

Modifier and Type	Field	Description
private static final Set<Class<?>>	checkedComponentClasses
private static ThreadLocal<Player>	craftingPlayer
private static final String	DIMENSIONS_KEY
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.Logger	LOGGER
private static final String	SEED_KEY
(package private) static final Pattern	URL_PATTERN
private static final Set<String>	VANILLA_DIMS
static final int	VANILLA_SERIALIZER_LIMIT
private static final org.apache.logging.log4j.Marker	WORLDPERSISTENCE

Constructor Summary

Constructors

Constructor	Description
CommonHooks()

Method Summary

Modifier and Type	Method	Description
static boolean	canContinueUsing(ItemStack from, ItemStack to)
static boolean	canCropGrow(Level level, BlockPos pos, BlockState state, boolean def)	Checks if a crop can grow by firing CropGrowEvent.Pre.
static boolean	canEntityDestroy(Level level, BlockPos pos, LivingEntity entity)
static boolean	canMobEffectBeApplied(LivingEntity entity, MobEffectInstance effect)	Checks if a mob effect can be applied to an entity by firing MobEffectEvent.Applicable.
static boolean	canUseEntitySelectors(SharedSuggestionProvider provider)
static ItemAttributeModifiers	computeModifiedAttributes(ItemStack stack, ItemAttributeModifiers defaultModifiers)	Hook to fire ItemAttributeModifierEvent.
static String	encodeLifecycle(com.mojang.serialization.Lifecycle lifecycle)
static BlockEvent.BreakEvent	fireBlockBreak(Level level, GameType gameType, ServerPlayer player, BlockPos pos, BlockState state)	Fires BlockEvent.BreakEvent, pre-emptively canceling the event based on the conditions that will cause the block to not be broken anyway.
static CriticalHitEvent	fireCriticalHit(Player player, Entity target, boolean vanillaCritical, float damageModifier)	Fires the CriticalHitEvent and returns the resulting event.
static void	fireCropGrowPost(Level level, BlockPos pos, BlockState state)
static Map<EntityType<? extends LivingEntity>,AttributeSupplier>	getAttributesView()	Deprecated.
static Player	getCraftingPlayer()
static ItemStack	getCraftingRemainingItem(ItemStack stack)
static @Nullable String	getDefaultCreatorModId(ItemStack itemStack)	Used as the default implementation of IItemExtension.getCreatorModId(net.minecraft.world.item.ItemStack).
static double	getEntityVisibilityMultiplier(LivingEntity entity, Entity lookingEntity, double originalMultiplier)
static List<String>	getModDataPacks()
static List<String>	getModDataPacksWithVanilla()
static ItemStack	getProjectile(LivingEntity entity, ItemStack projectileWeaponItem, ItemStack projectile)	Hook to fire LivingGetProjectileEvent.
private static String	getRawText(Component message)
static @Nullable EntityDataSerializer<?>	getSerializer(int id, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static int	getSerializerId(EntityDataSerializer<?> serializer, CrudeIncrementalIntIdentityHashBiMap<EntityDataSerializer<?>> vanilla)
static ChatDecorator	getServerChatSubmittedDecorator()
static TagKey<Block>	getTagFromVanillaTier(Tiers tier)
static FluidType	getVanillaFluidType(Fluid fluid)	Returns a vanilla fluid type for the given fluid.
static void	handleBlockDrops(ServerLevel level, BlockPos pos, BlockState state, @Nullable BlockEntity blockEntity, List<ItemEntity> drops, @Nullable Entity breaker, ItemStack tool)	Fires the BlockDropsEvent when block drops (items and experience) are determined.
static Optional<BlockPos>	isLivingOnLadder(BlockState state, Level level, BlockPos pos, LivingEntity entity)
private static boolean	isPotentialRegistryObject(Object value)
static @Nullable MobEffect	loadMobEffect(CompoundTag nbt, String key, @Nullable MobEffect fallback)
static com.mojang.serialization.Codec<List<LootPool>>	lootPoolsCodec(BiConsumer<LootPool,String> nameSetter)
static void	markComponentClassAsValid(Class<?> clazz)	Marks a class as being safe to use as a data component.
static void	modifyAttributes()	Deprecated.
static List<ItemStack>	modifyLoot(List<ItemStack> list, LootContext context)	Deprecated. Use modifyLoot(ResourceLocation, ObjectArrayList, LootContext) instead.
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, ItemStack left, ItemStack right, Container outputSlot, String name, long baseCost, Player player)
static float	onAnvilRepair(Player player, ItemStack output, ItemStack left, ItemStack right)
static @Nullable GameType	onChangeGameType(Player player, GameType currentGameType, GameType newGameType)
static Collection<CreativeModeTab>	onCheckCreativeTabs(CreativeModeTab... vanillaTabs)
static void	onChunkUnload(PoiManager poiManager, ChunkAccess chunkAccess)	The goal here is to fix the POI memory leak that happens due to SectionStorage.storage field never actually removing POIs long after they become irrelevant.
static PlayerInteractEvent.LeftClickBlock	onClientMineHold(Player player, BlockPos pos, Direction face)
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 level, BlockPos pos, BlockState state, float fallDistance, Entity entity)
static int	onGrindstoneChange(ItemStack top, ItemStack bottom, Container outputSlot, int xp)
static boolean	onGrindstoneTake(Container inputSlots, ContainerLevelAccess access, Function<Level,Integer> xpFunction)
static @Nullable InteractionResult	onInteractEntity(Player player, Entity entity, InteractionHand hand)
static @Nullable InteractionResult	onInteractEntityAt(Player player, Entity entity, HitResult ray, InteractionHand hand)
static @Nullable InteractionResult	onInteractEntityAt(Player player, Entity entity, Vec3 vec3d, InteractionHand hand)
static @Nullable InteractionResult	onItemRightClick(Player player, InteractionHand hand)
static boolean	onItemStackedOn(ItemStack carriedItem, ItemStack stackedOnItem, Slot slot, ClickAction action, Player player, SlotAccess carriedSlotAccess)
static PlayerInteractEvent.LeftClickBlock	onLeftClickBlock(Player player, BlockPos pos, Direction face, ServerboundPlayerActionPacket.Action action)
static boolean	onLivingAttack(LivingEntity entity, DamageSource src, float amount)
static void	onLivingBreathe(LivingEntity entity, int consumeAirAmount, int refillAirAmount)	Handles living entities being underwater.
static LivingChangeTargetEvent	onLivingChangeTarget(LivingEntity entity, LivingEntity originalTarget, LivingChangeTargetEvent.ILivingTargetType targetType)
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, boolean recentlyHit)
static @org.jetbrains.annotations.Nullable 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 LivingSwapItemsEvent.Hands	onLivingSwapHandItems(LivingEntity livingEntity)
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(UseOnContext context)
static boolean	onPlayerAttack(LivingEntity entity, DamageSource src, float amount)
static boolean	onPlayerAttackTarget(Player player, Entity target)
static @Nullable ItemEntity	onPlayerTossEvent(Player player, ItemStack item, boolean includeName)
static PlayerInteractEvent.RightClickBlock	onRightClickBlock(Player player, InteractionHand hand, BlockPos pos, BlockHitResult hitVec)
static @Nullable Component	onServerChatSubmittedEvent(ServerPlayer player, String plain, Component decorated)
static ShieldBlockEvent	onShieldBlock(LivingEntity blocker, DamageSource source, float blocked)
static boolean	onTravelToDimension(Entity entity, ResourceKey<Level> dimension)
static boolean	onVanillaGameEvent(Level level, Holder<GameEvent> vanillaEvent, Vec3 pos, GameEvent.Context context)
private static boolean	overridesEqualsAndHashCode(Class<?> clazz)
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(CompoundTag rootTag, LevelStorageSource.LevelDirectory levelDirectory)
static <T> @Nullable HolderLookup.RegistryLookup<T>	resolveLookup(ResourceKey<? extends Registry<T>> key)	Attempts to resolve a HolderLookup.RegistryLookup using the current global state.
static void	saveMobEffect(CompoundTag nbt, String key, MobEffect effect)
static void	setCraftingPlayer(Player player)
static boolean	shouldSuppressEnderManAnger(EnderMan enderMan, Player player, ItemStack mask)
static void	validateComponent(@Nullable Object dataComponent)	Checks that all data components override equals and hashCode.
static <T> HolderLookup.RegistryLookup<T>	wrapRegistryLookup(HolderLookup.RegistryLookup<T> lookup)
static void	writeAdditionalLevelSaveData(WorldData worldData, CompoundTag levelTag)

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

WORLDPERSISTENCE

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

URL_PATTERN

static final Pattern URL_PATTERN

craftingPlayer

private static ThreadLocal<Player> craftingPlayer

VANILLA_SERIALIZER_LIMIT

public static final int VANILLA_SERIALIZER_LIMIT

See Also:

• Constant Field Values

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

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

checkedComponentClasses

private static final Set<Class<?>> checkedComponentClasses

Constructor Details

CommonHooks

public CommonHooks()

Method Details

canContinueUsing

public static boolean canContinueUsing(ItemStack from,
 ItemStack to)

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)

onLivingChangeTarget

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

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,
 boolean recentlyHit)

onLivingFall

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

getEntityVisibilityMultiplier

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

isLivingOnLadder

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

onLivingJump

public static void onLivingJump(LivingEntity entity)

onPlayerTossEvent

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

onVanillaGameEvent

public static boolean onVanillaGameEvent(Level level,
 Holder<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)

getServerChatSubmittedDecorator

public static ChatDecorator getServerChatSubmittedDecorator()

newChatWithLinks

public static Component newChatWithLinks(String string)

newChatWithLinks

public static Component newChatWithLinks(String string,
 boolean allowMissingHeader)

handleBlockDrops

public static void handleBlockDrops(ServerLevel level,
 BlockPos pos,
 BlockState state,
 @Nullable
 @Nullable BlockEntity blockEntity,
 List<ItemEntity> drops,
 @Nullable
 @Nullable Entity breaker,
 ItemStack tool)

Fires the BlockDropsEvent when block drops (items and experience) are determined. If the event is not cancelled, all drops will be added to the world, and then BlockBehaviour.spawnAfterBreak(net.minecraft.world.level.block.state.BlockState, net.minecraft.server.level.ServerLevel, net.minecraft.core.BlockPos, net.minecraft.world.item.ItemStack, boolean) will be called.

Parameters:

level - The level

pos - The broken block's position

state - The broken block's state

blockEntity - The block entity from the given position

drops - The list of all items dropped by the block, captured from Block.getDrops(net.minecraft.world.level.block.state.BlockState, net.minecraft.server.level.ServerLevel, net.minecraft.core.BlockPos, net.minecraft.world.level.block.entity.BlockEntity)

breaker - The entity who broke the block, or null if unknown

tool - The tool used when breaking the block; may be empty

fireBlockBreak

public static BlockEvent.BreakEvent fireBlockBreak(Level level,
 GameType gameType,
 ServerPlayer player,
 BlockPos pos,
 BlockState state)

Fires BlockEvent.BreakEvent, pre-emptively canceling the event based on the conditions that will cause the block to not be broken anyway.

Note that undoing the pre-cancel will not permit breaking the block, since the vanilla conditions will always be checked.

Parameters:

level - The level

gameType - The game type of the breaking player

player - The breaking player

pos - The position of the block being broken

state - The state of the block being broken

Returns:

The event

onPlaceItemIntoWorld

public static InteractionResult onPlaceItemIntoWorld(UseOnContext context)

onAnvilChange

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

onAnvilRepair

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

onGrindstoneChange

public static int onGrindstoneChange(ItemStack top,
 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

public static ItemStack getCraftingRemainingItem(ItemStack stack)

onPlayerAttackTarget

public static boolean onPlayerAttackTarget(Player player,
 Entity target)

onTravelToDimension

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

onInteractEntityAt

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

onInteractEntityAt

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

onInteractEntity

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

onItemRightClick

@Nullable
public static @Nullable InteractionResult onItemRightClick(Player player,
 InteractionHand hand)

onLeftClickBlock

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

onClientMineHold

public static PlayerInteractEvent.LeftClickBlock onClientMineHold(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

lootPoolsCodec

@Internal
public static com.mojang.serialization.Codec<List<LootPool>> lootPoolsCodec(BiConsumer<LootPool,String> nameSetter)

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)

onCheckCreativeTabs

public static Collection<CreativeModeTab> onCheckCreativeTabs(CreativeModeTab... vanillaTabs)

canCropGrow

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

Checks if a crop can grow by firing CropGrowEvent.Pre.

Parameters:

level - The level the crop is in

pos - The position of the crop

state - The state of the crop

def - The result of the default checks performed by the crop.

Returns:

true if the crop can grow

fireCropGrowPost

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

fireCriticalHit

public static CriticalHitEvent fireCriticalHit(Player player,
 Entity target,
 boolean vanillaCritical,
 float damageModifier)

Fires the CriticalHitEvent and returns the resulting event.

Parameters:

player - The attacking player

target - The attack target

vanillaCritical - If the attack would have been a critical hit by vanilla's rules in Player.attack(Entity).

damageModifier - The base damage modifier. Vanilla critical hits have a damage modifier of 1.5.

computeModifiedAttributes

public static ItemAttributeModifiers computeModifiedAttributes(ItemStack stack,
 ItemAttributeModifiers defaultModifiers)

Hook to fire ItemAttributeModifierEvent. Modders should use ItemStack.forEachModifier(EquipmentSlot, BiConsumer) 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(ItemStack itemStack)

Used as the default implementation of IItemExtension.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)

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)

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

getModDataPacks

public static List<String> getModDataPacks()

getModDataPacksWithVanilla

public static List<String> getModDataPacksWithVanilla()

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)

onLivingSwapHandItems

public static LivingSwapItemsEvent.Hands onLivingSwapHandItems(LivingEntity livingEntity)

writeAdditionalLevelSaveData

@Internal
public static void writeAdditionalLevelSaveData(WorldData worldData,
 CompoundTag levelTag)

readAdditionalLevelSaveData

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

Parameters:

rootTag - Level data file contents.

levelDirectory - Level currently being loaded.

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)

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 underwater. 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 underwater it will dismount if IEntityExtension.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

markComponentClassAsValid

public static void markComponentClassAsValid(Class<?> clazz)

Marks a class as being safe to use as a data component. Keep in mind that data components are compared with Object.equals(Object) and hashed with Object.hashCode(). They must also be immutable.

Only call this method if the default implementations of Object.equals(Object) and Object.hashCode() are suitable for this class, and if instances of this class are immutable. Typically, this is only the case for singletons such as Block instances.

validateComponent

@Internal
public static void validateComponent(@Nullable
 @Nullable Object dataComponent)

Checks that all data components override equals and hashCode.

isPotentialRegistryObject

private static boolean isPotentialRegistryObject(Object value)

overridesEqualsAndHashCode

private static boolean overridesEqualsAndHashCode(Class<?> clazz)

onChunkUnload

public static void onChunkUnload(PoiManager poiManager,
 ChunkAccess chunkAccess)

The goal here is to fix the POI memory leak that happens due to SectionStorage.storage field never actually removing POIs long after they become irrelevant. We do it here in chunk unload event so that chunk that are fully unloaded now gets the POI removed from the POI cached storage map.

canMobEffectBeApplied

public static boolean canMobEffectBeApplied(LivingEntity entity,
 MobEffectInstance effect)

Checks if a mob effect can be applied to an entity by firing MobEffectEvent.Applicable.

Parameters:

entity - The target entity the mob effect is being applied to.

effect - The mob effect being applied.

Returns:

True if the mob effect can be applied, otherwise false.

resolveLookup

@Nullable
public static <T>
@Nullable HolderLookup.RegistryLookup<T> resolveLookup(ResourceKey<? extends Registry<T>> key)

Attempts to resolve a HolderLookup.RegistryLookup using the current global state.

Prioritizes the server's lookup, only attempting to retrieve it from the client if the server is unavailable.

Type Parameters:

T - The type of registry being looked up

Parameters:

key - The resource key for the target registry

Returns:

A registry access, if one was available.