Some parts of the code depend on MC behavior and thus are volatile. D…

…ocument it so we know what can break across updates.
refinedmods · Aug 27, 2018 · 7f13a17 · 7f13a17
1 parent c9288a0
commit 7f13a17
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/main/java/com/raoulvdberge/refinedstorage/recipe/RecipeUpgradeWithEnchantedBook.java b/src/main/java/com/raoulvdberge/refinedstorage/recipe/RecipeUpgradeWithEnchantedBook.java
@@ -44,6 +44,7 @@ public boolean matches(InventoryCrafting inv, World world) {
             for (int i = 0; i < enchantments.tagCount(); ++i) {
                 NBTTagCompound enchantmentNbt = enchantments.getCompoundTagAt(i);
 
+                // @Volatile: NBT tags from ItemEnchantedBook
                 if (Enchantment.getEnchantmentByID(enchantmentNbt.getShort("id")) == enchant.enchantment && enchantmentNbt.getShort("lvl") == enchant.enchantmentLevel) {
                     return true;
                 }

diff --git a/src/main/java/com/raoulvdberge/refinedstorage/util/RenderUtils.java b/src/main/java/com/raoulvdberge/refinedstorage/util/RenderUtils.java
@@ -45,7 +45,7 @@
 public final class RenderUtils {
     public static final Matrix4f EMPTY_MATRIX_TRANSFORM = getTransform(0, 0, 0, 0, 0, 0, 1.0f).getMatrix();
 
-    // From ForgeBlockStateV1
+    // @Volatile: From ForgeBlockStateV1
     private static final TRSRTransformation FLIP_X = new TRSRTransformation(null, null, new Vector3f(-1, 1, 1), null);
 
     private static ImmutableMap<ItemCameraTransforms.TransformType, TRSRTransformation> DEFAULT_ITEM_TRANSFORM;
@@ -284,7 +284,7 @@ public static void addCombinedFluidsToTooltip(List<String> tooltip, boolean show
         }
     }
 
-    // Copied with some tweaks from GuiUtils#drawHoveringText(@Nonnull final ItemStack stack, List<String> textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, FontRenderer font)
+    // @Volatile: Copied with some tweaks from GuiUtils#drawHoveringText(@Nonnull final ItemStack stack, List<String> textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, FontRenderer font)
     public static void drawTooltipWithSmallText(List<String> textLines, List<String> smallTextLines, boolean showSmallText, @Nonnull ItemStack stack, int mouseX, int mouseY, int screenWidth, int screenHeight, FontRenderer fontRenderer) {
         if (!textLines.isEmpty()) {
             RenderTooltipEvent.Pre event = new RenderTooltipEvent.Pre(stack, textLines, mouseX, mouseY, screenWidth, screenHeight, -1, fontRenderer);
@@ -414,10 +414,10 @@ public static void drawTooltipWithSmallText(List<String> textLines, List<String>
         }
     }
 
+    // @Volatile: From GuiScreen#getItemToolTip
     public static List<String> getItemTooltip(ItemStack stack) {
         List<String> lines = stack.getTooltip(Minecraft.getMinecraft().player, Minecraft.getMinecraft().gameSettings.advancedItemTooltips ? ITooltipFlag.TooltipFlags.ADVANCED : ITooltipFlag.TooltipFlags.NORMAL);
 
-        // From GuiScreen#getItemToolTip
         for (int i = 0; i < lines.size(); ++i) {
             if (i == 0) {
                 lines.set(i, stack.getRarity().rarityColor + lines.get(i));