more documentation efforts

GTNewHorizons · Sep 16, 2022 · 978938d · 978938d
1 parent 7a2328c
commit 978938d
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/src/main/java/com/gtnewhorizon/structurelib/structure/AutoPlaceEnvironment.java b/src/main/java/com/gtnewhorizon/structurelib/structure/AutoPlaceEnvironment.java
@@ -6,6 +6,7 @@
 import java.util.function.Predicate;
 import javax.annotation.Nonnull;
 import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.entity.player.EntityPlayerMP;
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.IChatComponent;
 
@@ -96,7 +97,9 @@ void setSource(IItemSource source) {
     }
 
     public APILevel getAPILevel() {
-        return definition == null ? APILevel.Legacy : APILevel.V2;
+        return definition == null
+                ? actor instanceof EntityPlayerMP ? APILevel.Legacy : APILevel.LegacyRelaxed
+                : APILevel.V2;
     }
 
     /**
@@ -126,6 +129,7 @@ public Consumer<IChatComponent> getChatter() {
 
     /**
      * Test if given location is contained within the current piece.
+     *
      * @param offsetA offset in A direction <b>relative to current element</b>
      * @param offsetB offset in B direction <b>relative to current element</b>
      * @param offsetC offset in C direction <b>relative to current element</b>
@@ -210,8 +214,25 @@ public boolean takeAll(ItemStack stack, boolean simulate) {
         }
     }
 
+    /**
+     * Defines the various API level an {@link AutoPlaceEnvironment} has implemented.
+     * <p>
+     * Enum constants are defined in chronological order.
+     */
     public enum APILevel {
+        /**
+         * Implements {@link #getChatter()}, {@link #getActor()} and {@link #getSource()}.
+         * {@link #getActor()} is guaranteed to be an {@link net.minecraft.entity.player.EntityPlayerMP}
+         */
         Legacy,
+        /**
+         * Implements {@link #getChatter()}, {@link #getActor()} and {@link #getSource()}.
+         * {@link #getActor()} is <b>NOT</b> guaranteed to be an {@link net.minecraft.entity.player.EntityPlayerMP}
+         */
+        LegacyRelaxed,
+        /**
+         * Implements everything so far we have defined.
+         */
         V2,
     }
 }