Package io.papermc.paper.tag
Interface PostFlattenTagRegistrar<T>
- Type Parameters:
T- the type of value in the tag
- All Superinterfaces:
Registrar
Registrar for tags after they have been flattened. Flattened
tags are tags which have any nested tags resolved to the tagged
values the nested tags point to. This registrar, being a post-flatten
registrar, allows for modification after that flattening has happened, when
tags only point to individual entries and not other nested tags.
An example of a custom enchant being registered to the vanilla
#minecraft:in_enchanting_table tag.
class YourBootstrapClass implements PluginBootstrap {
@Override
public void bootstrap(@NotNull BootstrapContext context) {
LifecycleEventManager<BootstrapContext> manager = context.getLifecycleManager();
manager.registerEventHandler(LifecycleEvents.TAGS.postFlatten(RegistryKey.ENCHANTMENT), event -> {
final PostFlattenTagRegistrar<Enchantment> registrar = event.registrar();
registrar.addToTag(
EnchantmentTagKeys.IN_ENCHANTING_TABLE,
Set.of(CUSTOM_ENCHANT)
);
});
}
}
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidAdds values to the given tag.@Unmodifiable @NonNull Map<TagKey<T>, Collection<TypedKey<T>>> Get a copy of all tags currently held in this registrar.@Unmodifiable @NonNull Collection<TypedKey<T>> Get the tag with the given key.booleanChecks if this registrar has a tag with the given key.@NonNull RegistryKey<T> Get the registry key for this tag registrar.voidSets the values of the given tag.
-
Method Details
-
registryKey
@NonNull RegistryKey<T> registryKey()Get the registry key for this tag registrar.- Returns:
- the registry key
-
getAllTags
@Contract(value="-> new", pure=true) @Unmodifiable @NonNull Map<TagKey<T>,Collection<TypedKey<T>>> getAllTags()Get a copy of all tags currently held in this registrar.- Returns:
- an immutable map of all tags
-
hasTag
Checks if this registrar has a tag with the given key.- Parameters:
tagKey- the key to check for- Returns:
- true if the tag exists, false otherwise
-
getTag
@Contract(value="_ -> new", pure=true) @Unmodifiable @NonNull Collection<TypedKey<T>> getTag(@NonNull TagKey<T> tagKey) Get the tag with the given key. UsehasTag(TagKey)to check if a tag exists first.- Parameters:
tagKey- the key of the tag to get- Returns:
- an immutable list of tag entries
- Throws:
NoSuchElementException- if the tag does not exist- See Also:
-
addToTag
@Contract(mutates="this") void addToTag(@NonNull TagKey<T> tagKey, @NonNull Collection<TypedKey<T>> values) Adds values to the given tag. If the tag does not exist, it will be created.- Parameters:
tagKey- the key of the tag to add tovalues- the values to add- See Also:
-
setTag
@Contract(mutates="this") void setTag(@NonNull TagKey<T> tagKey, @NonNull Collection<TypedKey<T>> values) Sets the values of the given tag. If the tag does not exist, it will be created. If the tag does exist, it will be overwritten.- Parameters:
tagKey- the key of the tag to setvalues- the values to set- See Also:
-