Class GetEnchantmentLevelEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.enchanting.GetEnchantmentLevelEvent

public class GetEnchantmentLevelEvent
extends net.neoforged.bus.api.Event

This event is fired whenever the enchantment level of a particular item is requested for gameplay purposes.
It is called from ItemInstanceExtension.getEnchantmentLevel(Holder) and IItemStackExtension.getAllEnchantments(RegistryLookup).

It is not fired for interactions with NBT, which means these changes will not reflect in the item tooltip.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ItemEnchantments.Mutable	enchantments
protected final HolderLookup.RegistryLookup<Enchantment>	lookup
protected final ItemInstance	stack
protected final @Nullable Holder<Enchantment>	targetEnchant

Constructor Summary

Constructors

Constructor	Description
GetEnchantmentLevelEvent(ItemInstance stack, ItemEnchantments.Mutable enchantments, @Nullable Holder<Enchantment> targetEnchant, HolderLookup.RegistryLookup<Enchantment> lookup)

Method Summary

Modifier and Type	Method	Description
ItemEnchantments.Mutable	getEnchantments()	Returns the mutable enchantment->level map.
Optional<Holder.Reference<Enchantment>>	getHolder(ResourceKey<Enchantment> key)	Attempts to resolve a Holder.Reference for a target enchantment.
HolderLookup.RegistryLookup<Enchantment>	getLookup()	Returns the underlying registry lookup, which can be used to access enchantment Holders.
ItemInstance	getStack()	Returns the item stack that is being queried against.
@Nullable Holder<Enchantment>	getTargetEnchant()	This method returns the specific enchantment being queried from ItemInstanceExtension.getEnchantmentLevel(Holder).
boolean	isTargetting(Holder<Enchantment> ench)	Helper method around getTargetEnchant() that checks if the target is the specified enchantment, or if the target is null.
boolean	isTargetting(ResourceKey<Enchantment> ench)	Helper method around getTargetEnchant() that checks if the target is the specified enchantment, or if the target is null.

Methods inherited from class Object

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

Field Details

stack

protected final ItemInstance stack

enchantments

protected final ItemEnchantments.Mutable enchantments

targetEnchant

protected final @Nullable Holder<Enchantment> targetEnchant

lookup

protected final HolderLookup.RegistryLookup<Enchantment> lookup

Constructor Details

GetEnchantmentLevelEvent

public GetEnchantmentLevelEvent(ItemInstance stack,
 ItemEnchantments.Mutable enchantments,
 @Nullable Holder<Enchantment> targetEnchant,
 HolderLookup.RegistryLookup<Enchantment> lookup)

Method Details

getStack

public ItemInstance getStack()

Returns the item stack that is being queried against.

getEnchantments

public ItemEnchantments.Mutable getEnchantments()

Returns the mutable enchantment->level map.

getTargetEnchant

public @Nullable Holder<Enchantment> getTargetEnchant()

This method returns the specific enchantment being queried from ItemInstanceExtension.getEnchantmentLevel(Holder).

If this is value is present, you only need to adjust the level of that enchantment.

If this value is null, then the event was fired from IItemStackExtension.getAllEnchantments(RegistryLookup) and all enchantments should be populated.

Returns:

The specific enchantment being queried, or null, if all enchantments are being requested.

isTargetting

public boolean isTargetting(Holder<Enchantment> ench)

Helper method around getTargetEnchant() that checks if the target is the specified enchantment, or if the target is null.

Parameters:

ench - The enchantment to check.

Returns:

If modifications to the passed enchantment are relevant for this event.

See Also:

• for more information about the target enchantment.

isTargetting

public boolean isTargetting(ResourceKey<Enchantment> ench)

Helper method around getTargetEnchant() that checks if the target is the specified enchantment, or if the target is null.

Parameters:

ench - The enchantment to check.

Returns:

If modifications to the passed enchantment are relevant for this event.

See Also:

• for more information about the target enchantment.

getHolder

public Optional<Holder.Reference<Enchantment>> getHolder(ResourceKey<Enchantment> key)

Attempts to resolve a Holder.Reference for a target enchantment. Since enchantments are data, they are not guaranteed to exist.

Parameters:

key - The target resource key

Returns:

If the holder was available, an Optional containing it; otherwise an empty Optional.

getLookup

public HolderLookup.RegistryLookup<Enchantment> getLookup()

Returns the underlying registry lookup, which can be used to access enchantment Holders.

Returns:

the underlying registry lookup, which can be used to access enchantment Holders