Add MobVisibility item component

Author: Doc94

paper-api/src/main/java/io/papermc/paper/datacomponent/DataComponentTypes.java

@@ -27,6 +27,7 @@
 import io.papermc.paper.datacomponent.item.LodestoneTracker;
 import io.papermc.paper.datacomponent.item.MapDecorations;
 import io.papermc.paper.datacomponent.item.MapId;
+import io.papermc.paper.datacomponent.item.MobVisibility;
 import io.papermc.paper.datacomponent.item.OminousBottleAmplifier;
 import io.papermc.paper.datacomponent.item.PiercingWeapon;
 import io.papermc.paper.datacomponent.item.PotDecorations;
@@ -393,6 +394,7 @@ public final class DataComponentTypes {
     public static final DataComponentType.Valued<DyeColor> SHULKER_COLOR = valued("shulker/color");
     public static final DataComponentType.NonValued WAXED = unvalued("waxed");
     public static final DataComponentType.Valued<DyeColor> CUSHION_COLOR = valued("cushion/color");
+    public static final DataComponentType.Valued<MobVisibility> MOB_VISIBILITY = valued("mob_visibility");
 
     private static DataComponentType.NonValued unvalued(@KeyPattern.Value final String key) {
         final DataComponentType dataComponentType = Registry.DATA_COMPONENT_TYPE.getOrThrow(Key.key(Key.MINECRAFT_NAMESPACE, key));

paper-api/src/main/java/io/papermc/paper/datacomponent/item/ItemComponentTypesBridge.java

@@ -11,6 +11,7 @@
 import org.bukkit.JukeboxSong;
 import org.bukkit.block.BlockType;
 import org.bukkit.damage.DamageType;
+import org.bukkit.entity.EntityType;
 import org.bukkit.inventory.EquipmentSlot;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.ItemType;
@@ -129,4 +130,6 @@ static ItemComponentTypesBridge bridge() {
     KineticWeapon.Condition kineticWeaponCondition(int maxDurationTicks, float minSpeed, float minRelativeSpeed);
 
     SulfurCubeContent sulfurCubeContent(ItemStack absorbedItem);
+
+    MobVisibility mobVisibility(RegistryKeySet<EntityType> targetingEntityTypes, float visibility);
 }

paper-api/src/main/java/io/papermc/paper/datacomponent/item/MobVisibility.java

@@ -0,0 +1,40 @@
+package io.papermc.paper.datacomponent.item;
+
+import io.papermc.paper.datacomponent.DataComponentTypes;
+import io.papermc.paper.registry.set.RegistryKeySet;
+import org.bukkit.entity.EntityType;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.Range;
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Represents the visibility percentage provided by an item with the appropriate {@link DataComponentTypes#EQUIPPABLE} component,
+ * modifying the range at which mobs are able to detect an entity.
+ *
+ * @see io.papermc.paper.datacomponent.DataComponentTypes#MOB_VISIBILITY
+ */
+@NullMarked
+@ApiStatus.NonExtendable
+public interface MobVisibility {
+
+    static MobVisibility mobVisibility(RegistryKeySet<EntityType> targetingEntityTypes, @Range(from = 0, to = 10) float visibility) {
+        return ItemComponentTypesBridge.bridge().mobVisibility(targetingEntityTypes, visibility);
+    }
+
+    /**
+     * Gets the set of entity types that this item modifies the visibility for.
+     *
+     * @return the set of entity types
+     */
+    @Contract(pure = true)
+    RegistryKeySet<EntityType> targetingEntityTypes();
+
+    /**
+     * Gets the visibility provided by this item, modifying the range at which mobs are able to detect an entity.
+     *
+     * @return the visibility
+     */
+    @Contract(pure = true)
+    @Range(from = 0, to = 10) float visibility();
+}

paper-server/src/main/java/io/papermc/paper/datacomponent/DataComponentAdapters.java

@@ -28,6 +28,7 @@
 import io.papermc.paper.datacomponent.item.PaperLodestoneTracker;
 import io.papermc.paper.datacomponent.item.PaperMapDecorations;
 import io.papermc.paper.datacomponent.item.PaperMapId;
+import io.papermc.paper.datacomponent.item.PaperMobVisibility;
 import io.papermc.paper.datacomponent.item.PaperOminousBottleAmplifier;
 import io.papermc.paper.datacomponent.item.PaperPiercingWeapon;
 import io.papermc.paper.datacomponent.item.PaperPotDecorations;
@@ -216,6 +217,7 @@ public static void bootstrap() {
         register(DataComponents.SHULKER_COLOR, nms -> DyeColor.getByWoolData((byte) nms.getId()), api -> net.minecraft.world.item.DyeColor.byId(api.getWoolData()));
         registerUntyped(DataComponents.WAXED);
         register(DataComponents.CUSHION_COLOR, nms -> DyeColor.getByWoolData((byte) nms.getId()), api -> net.minecraft.world.item.DyeColor.byId(api.getWoolData()));
+        register(DataComponents.MOB_VISIBILITY, PaperMobVisibility::new);
 
         for (final ResourceKey<DataComponentType<?>> key : BuiltInRegistries.DATA_COMPONENT_TYPE.registryKeySet()) {
             if (!ADAPTERS.containsKey(key)) {

paper-server/src/main/java/io/papermc/paper/datacomponent/item/ItemComponentTypesBridgesImpl.java

@@ -2,10 +2,12 @@
 
 import com.destroystokyo.paper.profile.PlayerProfile;
 import com.google.common.base.Preconditions;
+import io.papermc.paper.registry.RegistryKey;
 import io.papermc.paper.registry.data.util.Conversions;
 import io.papermc.paper.registry.set.PaperRegistrySets;
 import io.papermc.paper.registry.set.RegistryKeySet;
 import io.papermc.paper.text.Filtered;
+import java.util.stream.Collectors;
 import net.kyori.adventure.key.Key;
 import net.kyori.adventure.util.TriState;
 import net.minecraft.core.registries.Registries;
@@ -14,6 +16,7 @@
 import org.bukkit.block.BlockType;
 import org.bukkit.craftbukkit.inventory.CraftItemStack;
 import org.bukkit.damage.DamageType;
+import org.bukkit.entity.EntityType;
 import org.bukkit.inventory.EquipmentSlot;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.ItemType;
@@ -288,4 +291,14 @@ public SulfurCubeContent sulfurCubeContent(final ItemStack absorbedItem) {
         Preconditions.checkArgument(!absorbedItem.isEmpty(), "absorbedItem cannot be empty");
         return new PaperSulfurCubeContent(new net.minecraft.world.item.component.SulfurCubeContent(CraftItemStack.asTemplate(absorbedItem)));
     }
+
+    @Override
+    public MobVisibility mobVisibility(final RegistryKeySet<EntityType> targetingEntityTypes, final float visibility) {
+        Preconditions.checkArgument(targetingEntityTypes != null, "targetingEntityTypes cannot be null");
+        Preconditions.checkArgument(!targetingEntityTypes.isEmpty(), "targetingEntityTypes cannot be empty");
+        return new PaperMobVisibility(new net.minecraft.world.item.component.MobVisibility(
+            PaperRegistrySets.convertToNms(Registries.ENTITY_TYPE, Conversions.global().lookup(), targetingEntityTypes),
+            requireRange(visibility, "visibility", net.minecraft.world.item.component.MobVisibility.MIN_VISIBILITY, net.minecraft.world.item.component.MobVisibility.MAX_VISIBILITY))
+        );
+    }
 }

paper-server/src/main/java/io/papermc/paper/datacomponent/item/PaperMobVisibility.java

@@ -0,0 +1,27 @@
+package io.papermc.paper.datacomponent.item;
+
+import io.papermc.paper.registry.RegistryKey;
+import io.papermc.paper.registry.set.PaperRegistrySets;
+import io.papermc.paper.registry.set.RegistryKeySet;
+import org.bukkit.craftbukkit.util.Handleable;
+import org.bukkit.entity.EntityType;
+
+public record PaperMobVisibility(
+    net.minecraft.world.item.component.MobVisibility impl
+) implements MobVisibility, Handleable<net.minecraft.world.item.component.MobVisibility> {
+
+    @Override
+    public net.minecraft.world.item.component.MobVisibility getHandle() {
+        return this.impl;
+    }
+
+    @Override
+    public RegistryKeySet<EntityType> targetingEntityTypes() {
+        return PaperRegistrySets.convertToApi(RegistryKey.ENTITY_TYPE, this.impl.targetingEntityTypes());
+    }
+
+    @Override
+    public float visibility() {
+        return this.impl.visibility();
+    }
+}