From eda626fe108acb2307be0f2a70e3cf82b5be08bd Mon Sep 17 00:00:00 2001 From: Frank Bauer Date: Mon, 26 Jul 2021 21:36:34 +0200 Subject: [PATCH] Doc update --- src/main/java/ru/bclib/api/WorldDataAPI.java | 9 +++++++++ src/main/java/ru/bclib/api/datafixer/DataFixerAPI.java | 4 ++++ 2 files changed, 13 insertions(+) diff --git a/src/main/java/ru/bclib/api/WorldDataAPI.java b/src/main/java/ru/bclib/api/WorldDataAPI.java index 616791fd..78bbd980 100644 --- a/src/main/java/ru/bclib/api/WorldDataAPI.java +++ b/src/main/java/ru/bclib/api/WorldDataAPI.java @@ -6,6 +6,7 @@ import net.fabricmc.loader.api.FabricLoader; import net.fabricmc.loader.api.ModContainer; import net.minecraft.nbt.CompoundTag; import net.minecraft.nbt.NbtIo; +import net.minecraft.world.level.storage.LevelStorageSource.LevelStorageAccess; import ru.bclib.BCLib; import ru.bclib.api.datafixer.DataFixerAPI; @@ -14,7 +15,15 @@ import java.io.IOException; import java.util.List; import java.util.Map; import java.util.Optional; +import java.util.function.Consumer; +/** + * Mod-specifix data-storage for a world. + * + * This class provides the ability for mod to store persistent data inside a world. The Storage for the world is + * currently initialized as part of the {@link DataFixerAPI} in {@link DataFixerAPI#fixData(LevelStorageAccess, boolean, Consumer)} + * or {@link DataFixerAPI#initializeWorldData(File, boolean)} + */ public class WorldDataAPI { private static final Map TAGS = Maps.newHashMap(); private static final List MODS = Lists.newArrayList(); diff --git a/src/main/java/ru/bclib/api/datafixer/DataFixerAPI.java b/src/main/java/ru/bclib/api/datafixer/DataFixerAPI.java index 269096b3..6f995919 100644 --- a/src/main/java/ru/bclib/api/datafixer/DataFixerAPI.java +++ b/src/main/java/ru/bclib/api/datafixer/DataFixerAPI.java @@ -119,6 +119,10 @@ public class DataFixerAPI { } /** * Initializes the DataStorage for this world. If the world is new, the patch registry is initialized to the + * current versions of the plugins. + *

+ * This implementation will create a new {@link LevelStorageAccess} and call {@link #initializeWorldData(File, boolean)} + * using the provided root path. * @param levelSource The SourceStorage for this Minecraft instance, You can get this using * {@code Minecraft.getInstance().getLevelSource()} * @param levelID The ID of the Level you want to patch