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 221939b..0e5ae66 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/config/Config.java @@ -16,12 +16,21 @@ import java.util.Map; * Config class, defines config values. */ public class Config { + /** + * If lectern's inspection is turned on! + */ public boolean lecternToggle = true; + /** + * In game size for text + */ public int scale = 10; + /** + * If enchantments should use roman numerals or normal numbers + */ public boolean useRoman = false; /** - * Loads the config file in to mod + * Loads the config into memory */ public void loadConfig(){ Path configPath = Services.PLATFORM.getConfigPath("bookshelfinspector-config.yml"); 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 aedb2e0..b91c9da 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookData.java @@ -7,8 +7,17 @@ import net.minecraft.world.item.ItemStack; * Data for a slot in a chiseled bookshelf */ public class BookData { + /** + * Item in that slot + */ public ItemStack itemStack; + /** + * Block position for bookshelf + */ public BlockPos pos; + /** + * Slot were the item is located in + */ public int slotId; /** 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 61123dd..ef92a9f 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/BookShelfData.java @@ -3,11 +3,23 @@ package com.lukasabbe.bookshelfinspector.data; import net.minecraft.core.BlockPos; /** - * Data for bookshelf + * Data for mod */ public class BookShelfData { + /** + * If mod should display text on the screen. + */ public boolean isCurrentBookDataToggled = false; + /** + * latest position of bookshelf, used for reducing requests to server + */ public BlockPos latestPos = null; + /** + * If a request has been sent, used to limit request to one at a time. + */ public boolean requestSent = false; + /** + * Last spot in bookshelf, used to limit requests. + */ public int currentSlotInt = -1; } 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 381303d..d04e23c 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/data/Tags.java @@ -9,6 +9,12 @@ import net.minecraft.world.level.block.Block; * Tags for blocks used in the mod */ public class Tags { + /** + * Tag for chiseled bookshelves using the common tag, so inspection can work for modded bookshelf's + */ public static final TagKey CHISELED_BOOKSHELVES = TagKey.create(Registries.BLOCK, ResourceLocation.fromNamespaceAndPath("c", "chiseled_bookshelves")); + /** + * Tag for lecterns using the common tag, so inspection can work for modded lectern's + */ public static final TagKey LECTERNS = TagKey.create(Registries.BLOCK, ResourceLocation.fromNamespaceAndPath("c", "lectern")); } diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/BookshelfMixin.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/BookshelfMixin.java index 65b5fcd..15415ea 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/BookshelfMixin.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/BookshelfMixin.java @@ -1,6 +1,5 @@ package com.lukasabbe.bookshelfinspector.mixin; -import com.lukasabbe.bookshelfinspector.Constants; import com.lukasabbe.bookshelfinspector.renderer.Inspector; import net.minecraft.client.Minecraft; import net.minecraft.client.player.LocalPlayer; diff --git a/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/InGameHudMixin.java b/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/InGameHudMixin.java index ebf8a57..1fabb7d 100644 --- a/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/InGameHudMixin.java +++ b/common/src/main/java/com/lukasabbe/bookshelfinspector/mixin/InGameHudMixin.java @@ -1,6 +1,5 @@ package com.lukasabbe.bookshelfinspector.mixin; -import com.lukasabbe.bookshelfinspector.Constants; import com.lukasabbe.bookshelfinspector.renderer.HudRenderer; import net.minecraft.client.DeltaTracker; import net.minecraft.client.Minecraft;