Merge branch 'feat/tunnels-api' into 1.16.x

Author: robotgryphon

.github/workflows/tagged-release.yml

@@ -137,7 +137,9 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: libs
-          path: build/libs/**${{ needs.vars.outputs.mod_version }}**.jar
+          path: |
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}.jar
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}-api.jar
 
   view:
     name: View Changelog Output
@@ -160,7 +162,7 @@ jobs:
         uses: actions/download-artifact@v2
         with:
           name: libs
-          path: buildfiles
+          path: build-out
       - name: Download Changelog Results
         uses: actions/download-artifact@v2
         with:
@@ -179,7 +181,8 @@ jobs:
           prerelease: false
           files: |
             changelog/CHANGELOG.md
-            buildfiles/**${{ needs.vars.outputs.mod_version }}**.jar
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}.jar
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}-api.jar
 
       - name: Full File
         id: filename

.github/workflows/test-build.yml

@@ -6,7 +6,7 @@ on:
 jobs:
   vars:
     name: Get Variables
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     outputs:
       release_type: ${{steps.cf_release_type.outputs.value }}
       cf_project: ${{steps.cf_project.outputs.value }}
@@ -46,7 +46,7 @@ jobs:
 
   changelog:
     name: Generate Changelog (tags)
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -95,7 +95,7 @@ jobs:
 
   jar:
     name: Publish JAR
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: [vars, changelog]
     steps:
       - name: Download Changelog Results
@@ -107,10 +107,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Set up JDK 1.8
+      - name: Set up JDK
         uses: actions/setup-java@v1
         with:
-          java-version: 1.8
+          java-version: "8.0.282"
 
       - name: Cache Gradle packages
         uses: actions/cache@v2
@@ -129,15 +129,20 @@ jobs:
           GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Output Dir Structure
+        run: ls -lhR build-out
+
       - name: Add Artifact
         uses: actions/upload-artifact@v2
         with:
           name: libs
-          path: build/libs/**${{ needs.vars.outputs.mod_version }}**.jar
+          path: |
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}.jar
+            build-out/${{ needs.vars.outputs.mod_id }}-${{ needs.vars.outputs.mod_version }}-api.jar
 
   view:
     name: View Changelog Output
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: [changelog]
     steps:
       - name: Download Build Results

.gitignore

@@ -29,3 +29,4 @@ forge*changelog.txt
 
 logs/
 /mods/
+/build-out/

build.gradle

@@ -10,6 +10,10 @@ buildscript {
     }
 }
 
+plugins {
+    id "idea"
+}
+
 apply plugin: 'net.minecraftforge.gradle'
 // Only edit below this line, the above code adds and enables the necessary things for Forge to be setup.
 apply plugin: 'eclipse'
@@ -21,6 +25,15 @@ archivesBaseName = mod_id
 
 sourceCompatibility = targetCompatibility = compileJava.sourceCompatibility = compileJava.targetCompatibility = '1.8' // Need this here so eclipse task generates correctly.
 
+sourceSets {
+    main{
+        resources {
+            srcDir 'src/generated/resources'
+        }
+    }
+    test
+}
+
 println('Java: ' + System.getProperty('java.version') + ' JVM: ' + System.getProperty('java.vm.version') + '(' + System.getProperty('java.vendor') + ') Arch: ' + System.getProperty('os.arch'))
 minecraft {
     mappings channel: 'snapshot', version: mappings_version
@@ -85,8 +98,6 @@ minecraft {
     }
 }
 
-sourceSets.main.resources { srcDir 'src/generated/resources' }
-
 def getModVersion(filename) {
     // println(filename);
     def pattern = /^(?<modid>[^-]+)(?:-(?<mcversion>[0-9.]+))?(?:-(?<modver>[0-9.\-]+))\.jar$/;
@@ -177,11 +188,23 @@ jar {
     }
 }
 
-// Example configuration to allow publishing using the maven-publish task
-// This is the preferred method to reobfuscate your jar file
-jar.finalizedBy('reobfJar')
-// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing
-//publish.dependsOn('reobfJar')
+jar {
+    destinationDir = file("$rootDir/build-out")
+    finalizedBy('reobfJar')
+}
+
+task apiJar(type: Jar) {
+    // Sources included because of MinecraftForge/ForgeGradle#369
+    from(sourceSets.main.allJava)
+    from(sourceSets.main.output)
+    include 'com/robotgryphon/compactmachines/api/**'
+    classifier = 'api'
+    destinationDir = file("$rootDir/build-out")
+}
+
+artifacts {
+    archives jar, apiJar
+}
 
 publishing {
     publications {

src/main/java/com/robotgryphon/compactmachines/tunnels/EnumTunnelSide.java renamed to src/main/java/com/robotgryphon/compactmachines/api/tunnels/EnumTunnelSide.java

@@ -1,4 +1,4 @@
-package com.robotgryphon.compactmachines.tunnels;
+package com.robotgryphon.compactmachines.api.tunnels;
 
 /**
  * Represents the side of a tunnel (inside or outside).

src/main/java/com/robotgryphon/compactmachines/tunnels/api/ICapableTunnel.java renamed to src/main/java/com/robotgryphon/compactmachines/api/tunnels/ICapableTunnel.java

@@ -1,4 +1,4 @@
-package com.robotgryphon.compactmachines.tunnels.api;
+package com.robotgryphon.compactmachines.api.tunnels;
 
 import net.minecraft.util.Direction;
 import net.minecraft.util.math.BlockPos;

src/main/java/com/robotgryphon/compactmachines/tunnels/api/IItemTunnel.java renamed to src/main/java/com/robotgryphon/compactmachines/api/tunnels/IItemTunnel.java

@@ -1,4 +1,4 @@
-package com.robotgryphon.compactmachines.tunnels.api;
+package com.robotgryphon.compactmachines.api.tunnels;
 
 public interface IItemTunnel extends ICapableTunnel {
 

src/main/java/com/robotgryphon/compactmachines/api/tunnels/ITunnelConnectionInfo.java

@@ -0,0 +1,29 @@
+package com.robotgryphon.compactmachines.api.tunnels;
+
+import com.robotgryphon.compactmachines.teleportation.DimensionalPosition;
+import net.minecraft.block.BlockState;
+import net.minecraft.util.Direction;
+import net.minecraft.world.IWorldReader;
+
+import javax.annotation.Nonnull;
+import java.util.Optional;
+
+public interface ITunnelConnectionInfo {
+    @Nonnull
+    Optional<DimensionalPosition> getConnectedPosition(EnumTunnelSide side);
+
+    @Nonnull
+    Optional<BlockState> getConnectedState(EnumTunnelSide side);
+
+    Optional<? extends IWorldReader> getConnectedWorld(EnumTunnelSide side);
+
+    /**
+     * Gets the connection information for sidedness.
+     *
+     * For inside the machine, gets the side the tunnel was placed on.
+     * For outside the machine, gets the side of the machine the tunnel is connected to.
+     *
+     * @param side Which side of the tunnel to get directional info for.
+     */
+    Direction getConnectedSide(EnumTunnelSide side);
+}

src/main/java/com/robotgryphon/compactmachines/tunnels/TunnelDefinition.java renamed to src/main/java/com/robotgryphon/compactmachines/api/tunnels/TunnelDefinition.java

@@ -1,30 +1,23 @@
-package com.robotgryphon.compactmachines.tunnels;
+package com.robotgryphon.compactmachines.api.tunnels;
 
-import net.minecraft.item.Item;
 import net.minecraftforge.registries.ForgeRegistryEntry;
 
-public abstract class TunnelDefinition extends ForgeRegistryEntry<TunnelDefinition> {
-    protected Item item;
-
+public abstract class TunnelDefinition extends ForgeRegistryEntry<TunnelDefinition>
+{
     /**
      * The color of a non-indicator (the same color as the wall)
      */
     public static final int NO_INDICATOR_COLOR = 3751749;
 
-    public TunnelDefinition(Item item) {
-        this.item = item;
-    }
-
-    public Item getItem() {
-        return this.item;
-    }
-
     public abstract int getTunnelRingColor();
 
     /**
      * Gets the color for the indicator at the top-right of the block texture.
      *
      * @return
      */
-    public abstract int getTunnelIndicatorColor();
+    public int getTunnelIndicatorColor() {
+        return NO_INDICATOR_COLOR;
+    }
+
 }

src/main/java/com/robotgryphon/compactmachines/api/tunnels/redstone/IRedstoneReaderTunnel.java

@@ -0,0 +1,38 @@
+package com.robotgryphon.compactmachines.api.tunnels.redstone;
+
+import com.robotgryphon.compactmachines.api.tunnels.ITunnelConnectionInfo;
+import net.minecraft.block.BlockState;
+import net.minecraft.server.MinecraftServer;
+import net.minecraft.util.Direction;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.world.IBlockReader;
+
+/**
+ * A redstone reader reads a redstone value from outside the machine (from a given side).
+ */
+public interface IRedstoneReaderTunnel extends IRedstoneTunnel {
+
+    /**
+     * Gets the weak (passive) power level from the outside of the machine.
+     *
+     * @param connectionInfo
+     * @return
+     */
+    default int getPowerLevel(ITunnelConnectionInfo connectionInfo) {
+        return 0;
+    }
+
+    /**
+     * Called by the tunnel wall blocks to check if a redstone signal can be pulled
+     * from the outside. This should almost always return true, but if you need custom
+     * logic then you can implement it here.
+     *
+     * @param connectionInfo Connection information for the tunnel instance.
+     * @return
+     */
+    default boolean canConnectRedstone(ITunnelConnectionInfo connectionInfo) {
+        return true;
+    }
+
+    default void onPowerChanged(ITunnelConnectionInfo connectionInfo, int latestPower) {}
+}