Added Item Tags

This commit is contained in:
Auxilor
2024-07-20 14:04:51 +01:00
parent a9a961ff2b
commit 2fb9525175
6 changed files with 264 additions and 5 deletions

View File

@@ -6,6 +6,7 @@ import com.willfp.eco.core.Eco;
import com.willfp.eco.core.fast.FastItemStack;
import com.willfp.eco.core.items.args.LookupArgParser;
import com.willfp.eco.core.items.provider.ItemProvider;
import com.willfp.eco.core.items.tag.ItemTag;
import com.willfp.eco.core.recipe.parts.EmptyTestableItem;
import com.willfp.eco.core.recipe.parts.MaterialTestableItem;
import com.willfp.eco.core.recipe.parts.ModifiedTestableItem;
@@ -13,7 +14,6 @@ import com.willfp.eco.core.recipe.parts.TestableStack;
import com.willfp.eco.core.recipe.parts.UnrestrictedMaterialTestableItem;
import com.willfp.eco.util.NamespacedKeyUtils;
import com.willfp.eco.util.NumberUtils;
import kotlin.Suppress;
import org.bukkit.Material;
import org.bukkit.NamespacedKey;
import org.bukkit.enchantments.Enchantment;
@@ -93,6 +93,11 @@ public final class Items {
*/
private static final Map<String, Material> FRIENDLY_MATERIAL_NAMES = new HashMap<>();
/**
* All tags.
*/
private static final Map<String, ItemTag> TAGS = new HashMap<>();
/**
* Register a new custom item.
*
@@ -217,7 +222,20 @@ public final class Items {
String[] split = args[0].toLowerCase().split(":");
if (split.length == 1) {
String base = split[0];
boolean isTag = base.startsWith("#");
if (isTag) {
String tag = base.substring(1);
ItemTag itemTag = TAGS.get(tag);
if (itemTag == null) {
return new EmptyTestableItem();
}
item = itemTag.toTestableItem();
}
if (split.length == 1 && !isTag) {
String itemType = args[0];
boolean isWildcard = itemType.startsWith("*");
if (isWildcard) {
@@ -230,7 +248,7 @@ public final class Items {
item = isWildcard ? new UnrestrictedMaterialTestableItem(material) : new MaterialTestableItem(material);
}
if (split.length == 2) {
if (split.length == 2 && !isTag) {
String namespace = split[0];
String keyID = split[1];
NamespacedKey namespacedKey = NamespacedKeyUtils.create(namespace, keyID);
@@ -274,7 +292,7 @@ public final class Items {
Legacy namespace:id:amount format
This has been superseded by namespace:id amount
*/
if (split.length == 3) {
if (split.length == 3 && !isTag) {
TestableItem part = REGISTRY.get(NamespacedKeyUtils.create(split[0], split[1]));
if (part == null) {
return new EmptyTestableItem();
@@ -306,7 +324,8 @@ public final class Items {
List<Predicate<ItemStack>> predicates = new ArrayList<>();
for (LookupArgParser argParser : ARG_PARSERS) {
for (
LookupArgParser argParser : ARG_PARSERS) {
Predicate<ItemStack> predicate = argParser.parseArguments(modifierArgs, meta);
if (predicate != null) {
predicates.add(argParser.parseArguments(modifierArgs, meta));
@@ -611,6 +630,15 @@ public final class Items {
return false;
}
/**
* Register a new item tag.
*
* @param tag The tag.
*/
public static void registerTag(@NotNull final ItemTag tag) {
TAGS.put(tag.getIdentifier(), tag);
}
private Items() {
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
}

View File

@@ -0,0 +1,76 @@
package com.willfp.eco.core.items.tag;
import org.bukkit.Material;
import org.bukkit.NamespacedKey;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
import java.util.function.Predicate;
import java.util.function.Supplier;
/**
* A custom item tag.
*/
public final class CustomItemTag implements ItemTag {
/**
* The key.
*/
private final NamespacedKey key;
/**
* The test.
*/
private final Predicate<@NotNull ItemStack> test;
/**
* The example item.
*/
private final Supplier<@NotNull ItemStack> exampleItem;
/**
* Create a new custom item tag.
*
* @param key The key.
* @param test The test.
*/
public CustomItemTag(@NotNull final NamespacedKey key,
@NotNull final Predicate<@NotNull ItemStack> test) {
this(
key,
test,
() -> new ItemStack(Material.STONE)
);
}
/**
* Create a new custom item tag with an example item.
*
* @param key The key.
* @param test The test.
* @param exampleItem The example item.
*/
public CustomItemTag(@NotNull final NamespacedKey key,
@NotNull final Predicate<@NotNull ItemStack> test,
@NotNull final Supplier<@NotNull ItemStack> exampleItem) {
this.key = key;
this.test = test;
this.exampleItem = exampleItem;
}
@Override
@NotNull
public String getIdentifier() {
return key.toString();
}
@Override
public boolean matches(@NotNull final ItemStack itemStack) {
return test.test(itemStack);
}
@Override
@NotNull
public ItemStack getExampleItem() {
return exampleItem.get();
}
}

View File

@@ -0,0 +1,62 @@
package com.willfp.eco.core.items.tag;
import com.willfp.eco.core.items.TestableItem;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* A group of items that share a common trait.
*/
public sealed interface ItemTag permits CustomItemTag, VanillaItemTag {
/**
* Get the identifier of the tag.
*
* @return The identifier.
*/
@NotNull
String getIdentifier();
/**
* Check if an item matches the tag.
*
* @param itemStack The item to check.
* @return If the item matches the tag.
*/
boolean matches(@NotNull ItemStack itemStack);
/**
* Get an example item.
*
* @return The example item.
*/
@NotNull
ItemStack getExampleItem();
/**
* Convert this tag to a testable item.
*
* @return The testable item.
*/
@NotNull
default TestableItem toTestableItem() {
return new TestableItem() {
@Override
public boolean matches(@Nullable final ItemStack itemStack) {
return itemStack != null && ItemTag.this.matches(itemStack);
}
@Override
public @NotNull ItemStack getItem() {
return ItemTag.this.getExampleItem();
}
@Override
public String toString() {
return "ItemTagTestableItem{" +
"tag=" + ItemTag.this.getIdentifier() +
'}';
}
};
}
}

View File

@@ -0,0 +1,49 @@
package com.willfp.eco.core.items.tag;
import org.bukkit.Material;
import org.bukkit.Tag;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
/**
* A vanilla item tag.
*/
public final class VanillaItemTag implements ItemTag {
/**
* The identifier.
*/
private final String identifier;
/**
* The tag.
*/
private final Tag<Material> tag;
/**
* Create a new vanilla item tag.
*
* @param identifier The identifier.
* @param tag The tag.
*/
public VanillaItemTag(@NotNull final String identifier,
@NotNull final Tag<Material> tag) {
this.identifier = identifier;
this.tag = tag;
}
@Override
@NotNull
public String getIdentifier() {
return identifier;
}
@Override
public boolean matches(@NotNull final ItemStack itemStack) {
return tag.isTagged(itemStack.getType());
}
@Override
public @NotNull ItemStack getExampleItem() {
return new ItemStack(tag.getValues().stream().findFirst().orElse(Material.STONE));
}
}