程序包 net.neoforged.neoforge.event

类 ItemAttributeModifierEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.event.ItemAttributeModifierEvent
public class ItemAttributeModifierEvent extends net.neoforged.bus.api.Event
This event is fired when the attributes for an item stack are queried (for any reason) through IItemStackExtension.getAttributeModifiers().
This event is fired regardless of if the stack has DataComponents.ATTRIBUTE_MODIFIERS or not. If your attribute should be ignored when attributes are overridden, you can check for the presence of the component.

This event may be fired on both the logical server and logical client.

  • 字段详细资料

  • 构造器详细资料

  • 方法详细资料

    • getItemStack

      public ItemStack getItemStack()
      返回 the item stack whose attribute modifiers are being computed。
      返回:
      the item stack whose attribute modifiers are being computed

    • getDefaultModifiers

      public ItemAttributeModifiers getDefaultModifiers()
      返回 the default attribute modifiers before changes made by the event。
      返回:
      the default attribute modifiers before changes made by the event

    • getModifiers

      public List<ItemAttributeModifiers.Entry> getModifiers()
      Returns an unmodifiable view of the attribute modifier entries. Do not use the returned value to create an ItemAttributeModifiers since the underlying list is not immutable.

      If you need an ItemAttributeModifiers, you may need to call build()

      API Note:
      Use other methods from this event to adjust the modifiers.

    • addModifier

      public boolean addModifier(Holder<Attribute> attribute, AttributeModifier modifier, EquipmentSlotGroup slot)
      Adds a new attribute modifier to the given stack. Two modifiers with the same id may not exist for the same attribute, and this method will fail if one exists.
      参数:
      attribute - The attribute the modifier is for
      modifier - The new attribute modifier
      slot - The equipment slots for which the modifier should apply
      返回:
      True if the modifier was added, false if it was already present
      API Note:
      Modifiers must have a unique and consistent ResourceLocation id, or the modifier will not be removed when the item is unequipped.

    • removeModifier

      public boolean removeModifier(Holder<Attribute> attribute, ResourceLocation id)
      Removes an attribute modifier for the target attribute by id
      返回:
      True if an attribute modifier was removed, false otherwise

    • replaceModifier

      public void replaceModifier(Holder<Attribute> attribute, AttributeModifier modifier, EquipmentSlotGroup slot)
      Adds a new attribute modifier to the given stack, optionally replacing any existing modifiers with the same id.
      参数:
      attribute - The attribute the modifier is for
      modifier - The new attribute modifier
      slot - The equipment slots for which the modifier should apply
      API Note:
      Modifiers must have a unique and consistent ResourceLocation id, or the modifier will not be removed when the item is unequipped.

    • removeIf

      public boolean removeIf(Predicate<ItemAttributeModifiers.Entry> condition)
      Removes modifiers based on a condition.
      返回:
      true if any modifiers were removed

    • removeAllModifiersFor

      public boolean removeAllModifiersFor(Holder<Attribute> attribute)
      Removes all modifiers for the given attribute.
      返回:
      true if any modifiers were removed

    • clearModifiers

      public void clearModifiers()
      Removes all modifiers for all attributes.

    • build

      public ItemAttributeModifiers build()
      Builds a new ItemAttributeModifiers with the results of this event, returning the default modifiers if no changes were made.

    • getBuilder

      private ItemAttributeModifierEvent.ItemAttributeModifiersBuilder getBuilder()
      Returns the builder used for adjusting the attribute modifiers, creating it if it does not already exist.