Replace AdvancementProvider patch with Forge helper (#9188)

This commit is contained in:
ChampionAsh5357 authored and GitHub committed 2022-12-12 10:23:10 -08:00
1 parent 2ea16d89ca
commit 4802ceeccc
4 files changed
+86 -65

No files matched your search

@@ -0,0 +1,67 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.common.data;
import net.minecraft.advancements.Advancement;
import net.minecraft.core.HolderLookup;
import net.minecraft.data.PackOutput;
import net.minecraft.data.advancements.AdvancementProvider;
import net.minecraft.data.advancements.AdvancementSubProvider;
import net.minecraft.resources.ResourceLocation;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
/**
* An extension of the {@link AdvancementProvider} to provide a feature-complete
* experience to generate modded advancements.
*/
public abstract class ForgeAdvancementProvider extends AdvancementProvider
{
/**
* Default constructor.
*
* @param output the target directory of the data generator
* @param registries a future of a lookup for registries and their objects
* @param existingFileHelper a helper used to find whether a file exists
* @param subProviders the generators used to create the advancements
*/
public ForgeAdvancementProvider(PackOutput output, CompletableFuture<HolderLookup.Provider> registries, ExistingFileHelper existingFileHelper, List<AdvancementGenerator> subProviders)
{
super(output, registries, subProviders.stream().map(generator -> generator.toSubProvider(existingFileHelper)).toList());
}
/**
* An interface used to generated modded advancements. This is parallel to
* vanilla's {@link AdvancementSubProvider} with access to the {@link ExistingFileHelper}.
*
* @see AdvancementSubProvider
*/
public interface AdvancementGenerator
{
/**
* A method used to generate advancements for a mod. Advancements should be
* built via {@link net.minecraftforge.common.extensions.IForgeAdvancementBuilder#save(Consumer, ResourceLocation, ExistingFileHelper)}.
*
* @param registries a lookup for registries and their objects
* @param saver a consumer used to write advancements to a file
* @param existingFileHelper a helper used to find whether a file exists
*/
void generate(HolderLookup.Provider registries, Consumer<Advancement> saver, ExistingFileHelper existingFileHelper);
/**
* Creates an {@link AdvancementSubProvider} from this generator.
*
* @param existingFileHelper a helper used to find whether a file exists
* @return a sub provider wrapping this generator
*/
default AdvancementSubProvider toSubProvider(ExistingFileHelper existingFileHelper)
{
return (registries, saver) -> this.generate(registries, saver, existingFileHelper);
}
}
}