/* * Minecraft Forge - Forge Development LLC * SPDX-License-Identifier: LGPL-2.1-only */ package net.minecraftforge.event; import com.google.common.collect.HashMultimap; import com.google.common.collect.Multimaps; import net.minecraftforge.eventbus.api.Event; import net.minecraft.world.entity.ai.attributes.Attribute; import net.minecraft.world.entity.ai.attributes.AttributeModifier; import net.minecraft.world.entity.EquipmentSlot; import net.minecraft.world.item.ItemStack; import com.google.common.collect.Multimap; import javax.annotation.Nullable; import java.util.Collection; /** * This event is fired when the attributes for an ItemStack are being calculated. * Attributes are calculated on the server when equipping and unequipping an item to add and remove attributes respectively, both must be consistent. * Attributes are calculated on the client when rendering an item's tooltip to show relevant attributes. *
* Note that this event is fired regardless of if the stack has NBT overriding attributes or not. If your attribute should be * ignored when attributes are overridden, you can check for the presence of the {@code AttributeModifiers} tag. *
* This event is fired on the {@link net.minecraftforge.common.MinecraftForge#EVENT_BUS}. */ public class ItemAttributeModifierEvent extends Event { private final ItemStack stack; private final EquipmentSlot slotType; private final Multimap originalModifiers; private Multimap unmodifiableModifiers; @Nullable private Multimap modifiableModifiers; public ItemAttributeModifierEvent(ItemStack stack, EquipmentSlot slotType, Multimap modifiers) { this.stack = stack; this.slotType = slotType; this.unmodifiableModifiers = this.originalModifiers = modifiers; } /** * Returns an unmodifiable view of the attribute multimap. Use other methods from this event to modify the attributes map. * Note that adding attributes based on existing attributes may lead to inconsistent results between the tooltip (client) * and the actual attributes (server) if the listener order is different. Using {@link #getOriginalModifiers()} instead will give more consistent results. */ public Multimap getModifiers() { return this.unmodifiableModifiers; } /** * Returns the attribute map before any changes from other event listeners was made. */ public Multimap getOriginalModifiers() { return this.originalModifiers; } /** * Gets a modifiable map instance, creating it if the current map is currently unmodifiable */ private Multimap getModifiableMap() { if (this.modifiableModifiers == null) { this.modifiableModifiers = HashMultimap.create(this.originalModifiers); this.unmodifiableModifiers = Multimaps.unmodifiableMultimap(this.modifiableModifiers); } return this.modifiableModifiers; } /** * Adds a new attribute modifier to the given stack. * Modifier must have a consistent UUID for consistency between equipping and unequipping items. * Modifier name should clearly identify the mod that added the modifier. * @param attribute Attribute * @param modifier Modifier instance. * @return True if the attribute was added, false if it was already present */ public boolean addModifier(Attribute attribute, AttributeModifier modifier) { return getModifiableMap().put(attribute, modifier); } /** * Removes a single modifier for the given attribute * @param attribute Attribute * @param modifier Modifier instance * @return True if an attribute was removed, false if no change */ public boolean removeModifier(Attribute attribute, AttributeModifier modifier) { return getModifiableMap().remove(attribute, modifier); } /** * Removes all modifiers for the given attribute * @param attribute Attribute * @return Collection of removed modifiers */ public Collection removeAttribute(Attribute attribute) { return getModifiableMap().removeAll(attribute); } /** * Removes all modifiers for all attributes */ public void clearModifiers() { getModifiableMap().clear(); } /** Gets the slot containing this stack */ public EquipmentSlot getSlotType() { return this.slotType; } /** Gets the item stack instance */ public ItemStack getItemStack() { return this.stack; } }