diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java index 131538e..221939b 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java @@ -12,11 +12,17 @@ import java.nio.file.Files; import java.nio.file.Path; import java.util.Map; +/** + * Config class, defines config values. + */ public class Config { public boolean lecternToggle = true; public int scale = 10; public boolean useRoman = false; + /** + * Loads the config file in to mod + */ public void loadConfig(){ Path configPath = Services.PLATFORM.getConfigPath("bookshelfinspector-config.yml"); if(!Files.exists(configPath))createConfig(configPath); @@ -47,6 +53,9 @@ public class Config { } } + /** + * Saves config settings to config file + */ public void saveConfig(){ Path configPath = Services.PLATFORM.getConfigPath("bookshelfinspector-config.yml"); if(!Files.exists(configPath)) createConfig(configPath); diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java index 970d547..aedb2e0 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java @@ -3,17 +3,26 @@ package com.lukasabbe.bookshelfinspector.data; import net.minecraft.core.BlockPos; import net.minecraft.world.item.ItemStack; +/** + * Data for a slot in a chiseled bookshelf + */ public class BookData { public ItemStack itemStack; public BlockPos pos; public int slotId; + /** + * Creates data object with its data + */ public BookData(ItemStack itemStack, BlockPos pos, int slotId) { this.itemStack = itemStack; this.pos = pos; this.slotId = slotId; } + /** + * Gets an empty BookData + */ public static BookData empty(){ return new BookData(ItemStack.EMPTY, null, -1); } diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java index a3ae45a..61123dd 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java @@ -2,6 +2,9 @@ package com.lukasabbe.bookshelfinspector.data; import net.minecraft.core.BlockPos; +/** + * Data for bookshelf + */ public class BookShelfData { public boolean isCurrentBookDataToggled = false; public BlockPos latestPos = null; diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java index 77d2cbb..381303d 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java @@ -5,6 +5,9 @@ import net.minecraft.resources.ResourceLocation; import net.minecraft.tags.TagKey; import net.minecraft.world.level.block.Block; +/** + * Tags for blocks used in the mod + */ public class Tags { public static final TagKey CHISELED_BOOKSHELVES = TagKey.create(Registries.BLOCK, ResourceLocation.fromNamespaceAndPath("c", "chiseled_bookshelves")); public static final TagKey LECTERNS = TagKey.create(Registries.BLOCK, ResourceLocation.fromNamespaceAndPath("c", "lectern"));