[1.18.2] Fix tags for custom forge registries. (#8495)

Tag-enabled registries must now be registered to vanilla's root registry. See RegistryBuilder#hasTags.
Modded tag-enabled registries have to use the format `data/<namespace>/tags/<registrynamespace>/<registryname>/<tag>.json`
This format is to prevent conflicts for registries with the same path but different namespaces
EX: Registry name `examplemod:shoe`, tag name `blue_shoes` would be `data/<namespace>/tags/examplemod/shoe/blue_shoes.json`
RegistryEvent.NewRegistry has been moved and renamed to NewRegistryEvent.
RegistryBuilder#create has been made private. See NewRegistryEvent#create
Created new ITagManager system for looking up Forge tags. See IForgeRegistry#tags.
Add lookup methods for Holders from forge registries. See IForgeRegistry#getHolder.
This commit is contained in:
SizableShrimp authored and GitHub committed 2022-03-16 13:36:00 -07:00
1 parent 30f3a7dbba
commit ad75cb8644
51 files changed
+1621 -531

No files matched your search

@@ -21,6 +21,7 @@ public class ForgeCommand
.then(GenerateCommand.register())
.then(DimensionsCommand.register())
.then(ModListCommand.register())
.then(TagsCommand.register())
);
}
}
@@ -0,0 +1,267 @@
/*
* Minecraft Forge - Forge Development LLC
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.server.command;
import com.mojang.brigadier.arguments.IntegerArgumentType;
import com.mojang.brigadier.builder.ArgumentBuilder;
import com.mojang.brigadier.context.CommandContext;
import com.mojang.brigadier.exceptions.CommandSyntaxException;
import com.mojang.brigadier.exceptions.Dynamic2CommandExceptionType;
import com.mojang.brigadier.exceptions.DynamicCommandExceptionType;
import com.mojang.brigadier.suggestion.SuggestionProvider;
import com.mojang.brigadier.suggestion.Suggestions;
import com.mojang.brigadier.suggestion.SuggestionsBuilder;
import com.mojang.datafixers.util.Pair;
import net.minecraft.ChatFormatting;
import net.minecraft.commands.CommandSourceStack;
import net.minecraft.commands.Commands;
import net.minecraft.commands.SharedSuggestionProvider;
import net.minecraft.commands.arguments.ResourceKeyArgument;
import net.minecraft.commands.arguments.ResourceLocationArgument;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderSet;
import net.minecraft.core.Registry;
import net.minecraft.network.chat.ClickEvent;
import net.minecraft.network.chat.ComponentUtils;
import net.minecraft.network.chat.HoverEvent;
import net.minecraft.network.chat.MutableComponent;
import net.minecraft.network.chat.TextComponent;
import net.minecraft.network.chat.TranslatableComponent;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.tags.TagKey;
import net.minecraft.util.Mth;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* The {@code /forge tags} command for listing a registry's tags, getting the elements of tags, and querying the tags of a
* registry object.
*
* <p>Each command is paginated, showing {@value PAGE_SIZE} entries at a time. When there are more than 0 entries,
* the text indicating the amount of entries is highlighted and can be clicked to copy the list of all entries (across
* all pages) to the clipboard. (This is reflected by the use of green text in brackets, mimicking the clickable
* coordinates in the {@code /locate} command's message)</p>
*
* <p>The command has three subcommands:</p>
* <ul>
* <li>{@code /forge tags &lt;registry> list [page]} - Lists all available tags in the given registry.</li>
* <li>{@code /forge tags &lt;registry> get &lt;tag> [page]} - Gets all elements of the given tag in the given registry.</li>
* <li>{@code /forge tags &lt;registry> query &lt;element> [page]} - Queries for all tags in the given registry which
* contain the given registry object.</li>
* </ul>
*/
class TagsCommand
{
private static final long PAGE_SIZE = 8;
private static final ResourceKey<Registry<Registry<?>>> ROOT_REGISTRY_KEY =
ResourceKey.createRegistryKey(new ResourceLocation("root"));
private static final DynamicCommandExceptionType UNKNOWN_REGISTRY = new DynamicCommandExceptionType(key ->
new TranslatableComponent("commands.forge.tags.error.unknown_registry", key));
private static final Dynamic2CommandExceptionType UNKNOWN_TAG = new Dynamic2CommandExceptionType((tag, registry) ->
new TranslatableComponent("commands.forge.tags.error.unknown_tag", tag, registry));
private static final Dynamic2CommandExceptionType UNKNOWN_ELEMENT = new Dynamic2CommandExceptionType((tag, registry) ->
new TranslatableComponent("commands.forge.tags.error.unknown_element", tag, registry));
public static ArgumentBuilder<CommandSourceStack, ?> register()
{
/*
* /forge tags <registry> list [page]
* /forge tags <registry> get <tag> [page]
* /forge tags <registry> query <element> [page]
*/
return Commands.literal("tags")
.requires(cs -> cs.hasPermission(2))
.then(Commands.argument("registry", ResourceKeyArgument.key(ROOT_REGISTRY_KEY))
.suggests(TagsCommand::suggestRegistries)
.then(Commands.literal("list")
.executes(ctx -> listTags(ctx, 1))
.then(Commands.argument("page", IntegerArgumentType.integer(1))
.executes(ctx -> listTags(ctx, IntegerArgumentType.getInteger(ctx, "page")))
)
)
.then(Commands.literal("get")
.then(Commands.argument("tag", ResourceLocationArgument.id())
.suggests(suggestFromRegistry(r -> r.getTagNames().map(TagKey::location)::iterator))
.executes(ctx -> listTagElements(ctx, 1))
.then(Commands.argument("page", IntegerArgumentType.integer(1))
.executes(ctx -> listTagElements(ctx, IntegerArgumentType.getInteger(ctx, "page")))
)
)
)
.then(Commands.literal("query")
.then(Commands.argument("element", ResourceLocationArgument.id())
.suggests(suggestFromRegistry(Registry::keySet))
.executes(ctx -> queryElementTags(ctx, 1))
.then(Commands.argument("page", IntegerArgumentType.integer(1))
.executes(ctx -> queryElementTags(ctx, IntegerArgumentType.getInteger(ctx, "page")))
)
)
)
);
}
private static int listTags(final CommandContext<CommandSourceStack> ctx, final int page) throws CommandSyntaxException
{
final ResourceKey<? extends Registry<?>> registryKey = getResourceKey(ctx, "registry", ROOT_REGISTRY_KEY)
.orElseThrow(); // Expect to be always retrieve a resource key for the root registry (registry key)
final Registry<?> registry = ctx.getSource().getServer().registryAccess().registry(registryKey)
.orElseThrow(() -> UNKNOWN_REGISTRY.create(registryKey.location()));
final long tagCount = registry.getTags().count();
ctx.getSource().sendSuccess(createMessage(
new TranslatableComponent("commands.forge.tags.registry_key", new TextComponent(registryKey.location().toString()).withStyle(ChatFormatting.GOLD)),
"commands.forge.tags.tag_count",
"commands.forge.tags.copy_tag_names",
tagCount,
page,
ChatFormatting.DARK_GREEN,
() -> registry.getTags()
.map(Pair::getSecond)
.map(s -> s.unwrap().map(k -> k.location().toString(), Object::toString))
), false);
return (int) tagCount;
}
private static int listTagElements(final CommandContext<CommandSourceStack> ctx, final int page) throws CommandSyntaxException
{
final ResourceKey<? extends Registry<?>> registryKey = getResourceKey(ctx, "registry", ROOT_REGISTRY_KEY)
.orElseThrow(); // Expect to be always retrieve a resource key for the root registry (registry key)
final Registry<?> registry = ctx.getSource().getServer().registryAccess().registry(registryKey)
.orElseThrow(() -> UNKNOWN_REGISTRY.create(registryKey.location()));
final ResourceLocation tagLocation = ResourceLocationArgument.getId(ctx, "tag");
final TagKey<?> tagKey = TagKey.create(cast(registryKey), tagLocation);
final HolderSet.Named<?> tag = registry.getTag(cast(tagKey))
.orElseThrow(() -> UNKNOWN_TAG.create(tagKey.location(), registryKey.location()));
ctx.getSource().sendSuccess(createMessage(
new TranslatableComponent("commands.forge.tags.tag_key",
new TextComponent(tagKey.registry().location().toString()).withStyle(ChatFormatting.GOLD),
new TextComponent(tagKey.location().toString()).withStyle(ChatFormatting.DARK_GREEN)),
"commands.forge.tags.element_count",
"commands.forge.tags.copy_element_names",
tag.size(),
page,
ChatFormatting.YELLOW,
() -> tag.stream().map(s -> s.unwrap().map(k -> k.location().toString(), Object::toString))
), false);
return tag.size();
}
private static int queryElementTags(final CommandContext<CommandSourceStack> ctx, final int page) throws CommandSyntaxException
{
final ResourceKey<? extends Registry<?>> registryKey = getResourceKey(ctx, "registry", ROOT_REGISTRY_KEY)
.orElseThrow(); // Expect to be always retrieve a resource key for the root registry (registry key)
final Registry<?> registry = ctx.getSource().getServer().registryAccess().registry(registryKey)
.orElseThrow(() -> UNKNOWN_REGISTRY.create(registryKey.location()));
final ResourceLocation elementLocation = ResourceLocationArgument.getId(ctx, "element");
final ResourceKey<?> elementKey = ResourceKey.create(cast(registryKey), elementLocation);
final Holder<?> elementHolder = registry.getHolder(cast(elementKey))
.orElseThrow(() -> UNKNOWN_ELEMENT.create(elementLocation, registryKey.location()));
final long containingTagsCount = elementHolder.tags().count();
ctx.getSource().sendSuccess(createMessage(
new TranslatableComponent("commands.forge.tags.element",
new TextComponent(registryKey.location().toString()).withStyle(ChatFormatting.GOLD),
new TextComponent(elementLocation.toString()).withStyle(ChatFormatting.YELLOW)),
"commands.forge.tags.containing_tag_count",
"commands.forge.tags.copy_tag_names",
containingTagsCount,
page,
ChatFormatting.DARK_GREEN,
() -> elementHolder.tags().map(k -> k.location().toString())
), false);
return (int) containingTagsCount;
}
private static MutableComponent createMessage(final TranslatableComponent header,
final String containsText,
final String copyHoverText,
final long count,
final long currentPage,
final ChatFormatting elementColor,
final Supplier<Stream<String>> names)
{
final String allElementNames = names.get().sorted().collect(Collectors.joining("\n"));
final long totalPages = (count - 1) / PAGE_SIZE + 1;
final long actualPage = Mth.clamp(currentPage, 1, totalPages);
MutableComponent containsComponent = new TranslatableComponent(containsText, count);
if (count > 0) // Highlight the count text, make it clickable, and append page counters
{
containsComponent = ComponentUtils.wrapInSquareBrackets(containsComponent.withStyle(s -> s
.withColor(ChatFormatting.GREEN)
.withClickEvent(new ClickEvent(ClickEvent.Action.COPY_TO_CLIPBOARD, allElementNames))
.withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT,
new TranslatableComponent(copyHoverText)))));
containsComponent = new TranslatableComponent("commands.forge.tags.page_info",
containsComponent, actualPage, totalPages);
}
final MutableComponent tagElements = new TextComponent("").append(containsComponent);
names.get()
.sorted()
.skip(PAGE_SIZE * (actualPage - 1))
.limit(PAGE_SIZE)
.map(TextComponent::new)
.map(t -> t.withStyle(elementColor))
.map(t -> new TextComponent("\n - ").append(t))
.forEach(tagElements::append);
return header.append("\n").append(tagElements);
}
private static CompletableFuture<Suggestions> suggestRegistries(final CommandContext<CommandSourceStack> ctx,
final SuggestionsBuilder builder)
{
ctx.getSource().suggestRegistryElements(Registry.REGISTRY,
SharedSuggestionProvider.ElementSuggestionType.ELEMENTS, builder);
return builder.buildFuture();
}
private static SuggestionProvider<CommandSourceStack> suggestFromRegistry(
final Function<Registry<?>, Iterable<ResourceLocation>> namesFunction)
{
return (ctx, builder) -> getResourceKey(ctx, "registry", ROOT_REGISTRY_KEY)
.flatMap(key -> ctx.getSource().registryAccess().registry(key).map(registry -> {
SharedSuggestionProvider.suggestResource(namesFunction.apply(registry), builder);
return builder.buildFuture();
}))
.orElseGet(builder::buildFuture);
}
@SuppressWarnings("SameParameterValue")
private static <T> Optional<ResourceKey<T>> getResourceKey(final CommandContext<CommandSourceStack> ctx,
final String name,
final ResourceKey<Registry<T>> registryKey)
{
// Don't inline to avoid an unchecked cast warning due to raw types
final ResourceKey<?> key = ctx.getArgument(name, ResourceKey.class);
return key.cast(registryKey);
}
@SuppressWarnings("unchecked")
private static <O> O cast(final Object input)
{
return (O) input;
}
}