Loonium with data-driven structure loot #4639
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package vazkii.botania.common.config; | ||
|
|
||
| import com.google.gson.Gson; | ||
| import com.google.gson.JsonElement; | ||
| import com.mojang.serialization.Codec; | ||
| import com.mojang.serialization.JsonOps; | ||
|
|
||
| import net.minecraft.resources.ResourceLocation; | ||
| import net.minecraft.server.packs.PackType; | ||
| import net.minecraft.server.packs.resources.PreparableReloadListener; | ||
| import net.minecraft.server.packs.resources.ResourceManager; | ||
| import net.minecraft.server.packs.resources.SimpleJsonResourceReloadListener; | ||
| import net.minecraft.util.profiling.ProfilerFiller; | ||
|
|
||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| import vazkii.botania.api.BotaniaAPI; | ||
| import vazkii.botania.api.configdata.LooniumStructureConfiguration; | ||
| import vazkii.botania.xplat.XplatAbstractions; | ||
|
|
||
| import java.util.*; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.Executor; | ||
| import java.util.function.BiConsumer; | ||
| import java.util.function.Consumer; | ||
|
|
||
| import static vazkii.botania.common.lib.ResourceLocationHelper.prefix; | ||
|
|
||
| public class ConfigDataManager implements PreparableReloadListener { | ||
| public static void registerListener() { | ||
| XplatAbstractions.INSTANCE.registerReloadListener(PackType.SERVER_DATA, prefix("configdata"), new ConfigDataManager()); | ||
| } | ||
|
|
||
| private final Map<ResourceLocation, LooniumStructureConfiguration> looniumConfigs = new HashMap<>(); | ||
|
|
||
| public LooniumStructureConfiguration getEffectiveLooniumStructureConfiguration(ResourceLocation id) { | ||
| LooniumStructureConfiguration configuration = this.looniumConfigs.get(id); | ||
| return configuration != null ? configuration.getEffectiveConfig(looniumConfigs::get) : null; | ||
| } | ||
|
|
||
| private static void validateLooniumConfig(Map<ResourceLocation, LooniumStructureConfiguration> map) { | ||
| Set<ResourceLocation> errorEntries = new HashSet<>(); | ||
| Set<ResourceLocation> visitedEntries = new LinkedHashSet<>(); | ||
| do { | ||
| errorEntries.clear(); | ||
| for (var entry : map.entrySet()) { | ||
| ResourceLocation id = entry.getKey(); | ||
| ResourceLocation parent = entry.getValue().parent; | ||
| if (id.equals(parent)) { | ||
| BotaniaAPI.LOGGER.warn("Ignoring Loonium structure configuration, because it specified itself as parent: {}", id); | ||
| errorEntries.add(id); | ||
| } else { | ||
| visitedEntries.clear(); | ||
| if (!findTopmostParent(map, id, parent, visitedEntries)) { | ||
| BotaniaAPI.LOGGER.warn("Ignoring Loonium structure configuration(s) without top-most parent: {}", visitedEntries); | ||
| errorEntries.addAll(visitedEntries); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| errorEntries.forEach(map::remove); | ||
| } while (!errorEntries.isEmpty() && !map.isEmpty()); | ||
|
|
||
| if (!map.containsKey(LooniumStructureConfiguration.DEFAULT_CONFIG_ID)) { | ||
| BotaniaAPI.LOGGER.error("Default Loonium configuration not found!"); | ||
| } | ||
| } | ||
|
|
||
| private static boolean findTopmostParent(Map<ResourceLocation, LooniumStructureConfiguration> map, | ||
| ResourceLocation id, ResourceLocation parent, Set<ResourceLocation> visitedEntries) { | ||
| if (!visitedEntries.add(id)) { | ||
| BotaniaAPI.LOGGER.warn("Cyclic dependency between Loonium structure configurations detected: {}", visitedEntries); | ||
| return false; | ||
| } | ||
| if (parent == null) { | ||
| return true; | ||
| } | ||
| var parentConfig = map.get(parent); | ||
| return parentConfig != null && findTopmostParent(map, parent, parentConfig.parent, visitedEntries); | ||
|
There was a problem hiding this comment. From what i can see, specifying a missing ID as the parent, will lead to the There was a problem hiding this comment. The config loading logic should be validating that any specified parent ID actually exists. |
||
| } | ||
|
|
||
| private void applyLooniumConfig(Map<ResourceLocation, LooniumStructureConfiguration> looniumConfigs) { | ||
| this.looniumConfigs.putAll(looniumConfigs); | ||
| } | ||
|
|
||
| @NotNull | ||
| @Override | ||
| public CompletableFuture<Void> reload(@NotNull PreparationBarrier barrier, @NotNull ResourceManager manager, | ||
| @NotNull ProfilerFiller prepProfiler, @NotNull ProfilerFiller reloadProfiler, | ||
| @NotNull Executor backgroundExecutor, @NotNull Executor gameExecutor) { | ||
| var looniumTask = scheduleConfigParse(barrier, manager, backgroundExecutor, gameExecutor, ConfigDataType.LOONUIM); | ||
|
|
||
| return CompletableFuture.allOf(looniumTask).thenRun(() -> BotaniaAPI.instance().setConfigData(this)); | ||
| } | ||
|
|
||
| private <T> CompletableFuture<Void> scheduleConfigParse(PreparationBarrier barrier, ResourceManager manager, | ||
| Executor backgroundExecutor, Executor gameExecutor, ConfigDataType<T> type) { | ||
| return CompletableFuture.supplyAsync(() -> { | ||
| Map<ResourceLocation, JsonElement> resourceMap = new HashMap<>(); | ||
| SimpleJsonResourceReloadListener.scanDirectory(manager, "config/" + type.directory, new Gson(), resourceMap); | ||
| Map<ResourceLocation, T> configs = new HashMap<>(resourceMap.size()); | ||
| resourceMap.forEach((id, jsonElement) -> type.codec.parse(JsonOps.INSTANCE, jsonElement).result().ifPresent(c -> configs.put(id, c))); | ||
| type.validateFunction.accept(configs); | ||
| return configs; | ||
| }, backgroundExecutor) | ||
| .thenCompose(barrier::wait) | ||
| .thenAcceptAsync(c -> type.applyFunction.accept(this, c), gameExecutor); | ||
| } | ||
|
|
||
| private record ConfigDataType<T> (Codec<T> codec, String directory, | ||
| Consumer<Map<ResourceLocation, T>> validateFunction, | ||
| BiConsumer<ConfigDataManager, Map<ResourceLocation, T>> applyFunction) { | ||
| private static final ConfigDataType<LooniumStructureConfiguration> LOONUIM = | ||
| new ConfigDataType<>(LooniumStructureConfiguration.CODEC, "loonium", | ||
| ConfigDataManager::validateLooniumConfig, ConfigDataManager::applyLooniumConfig); | ||
|
|
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(forgive me if this changes in a later commit)
I don't think you can import a non-api class in the api. Someone depending on just the API wouldn't be able to call this method anyway.
Also, i'm not entirely clear on the purpose of this method. From what i can tell, the api impl starts with an instance of the config manager, and another instance is registered as a listener from the class itself. Then, whenever data is reloaded, setConfigData is called with that instance, which has the correct data. But, the instance stays there and doesn't need to be set again on next reload, so this all just seems a bit weird.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, right. Probably need to extract an API interface for the ConfigDataManager to use in those methods.
The way data pack reloading (for vanilla, and also for this) works is as follows: The game starts without any loaded data, which is an empty accessible instance of the data manager. When data packs are reloaded, a new instance (not yet accessible outside the loading logic) is created, and when loading is done, that instance replaces the previous accessible one.
I'm not sure if there's any better place to put this, but BotaniaAPI seemed like a good place for the method that returns the currently valid config data instance. I'm also not quite sure if the setter should be publicly accessible, but I couldn't figure out a clean way to set the instance to return.