Fix #608: Add KubeJS event to register energy/fluid/item hatches (#1097)

Author: Technici4n

docs/ADDING_CABLE_TIERS.md

@@ -33,3 +33,6 @@ MIRegistrationEvents.registerCableTiers(event => {
 
 To register a corresponding cable with the [material system](ADDING_MATERIALS.md),
 use `.cable("iv")` on a material builder.
+
+To register corresponding energy input and output hatches,
+see the page on [adding hatches](ADDING_HATCHES.md).

docs/ADDING_HATCHES.md

@@ -0,0 +1,60 @@
+# Adding hatches
+To add new energy, fluid, or item hatches, use the `MIRegistrationEvents.registerHatches` startup event.
+
+## Energy
+Use the `energy` registration method to register energy input and output hatches for the given cable tier.
+For example:
+```js
+MIMachineEvents.registerHatches(event => {
+    // Takes the internal name for the cable tier.
+    event.energy("iv");
+});
+```
+
+The default generated model for energy hatches will use the casing corresponding to the cable tier.
+
+See also [Adding cable tiers](ADDING_CABLE_TIERS.md) for more information on how to add a cable tier.
+
+## Fluid
+Use the `fluid` registration method to register fluid input and output hatches.
+These hatches are not necessarily bound to a cable or progression tier.
+
+Here is an example:
+```js
+MIMachineEvents.registerHatches(event => {
+    event.fluid(
+        // English name for the hatch tier. " Fluid Input/Output Hatch" will be added by MI.
+        "Huge",
+        // Internal name for the tier.
+        // In this cases, the block IDs of the hatches will be huge_fluid_input_hatch and huge_fluid_output_hatch.
+        "huge",
+        // Machine casing for the model of the hatch.
+        "superconductor",
+        // Number of buckets that the hatch can hold.
+        1000,
+    );
+});
+```
+
+## Item
+Use the `item` registration method to register item input and output hatches.
+These hatches are not necessarily bound to a cable or progression tier.
+
+Here is an example:
+```js
+MIMachineEvents.registerHatches(event => {
+    event.item(
+        // English name for the hatch tier. " Item Input/Output Hatch" will be added by MI.
+        "Huge",
+        // Internal name for the tier.
+        // In this cases, the block IDs of the hatches will be huge_item_input_hatch and huge_item_output_hatch.
+        "huge",
+        // Machine casing for the model of the hatch.
+        "superconductor",
+        // Number of slot rows and columns for the hatch slots:
+        3, 7, // 3 rows and 7 columns here
+        // Starting position of the slot grid:
+        10, 18, // the first slot will be at (10, 18) inside the GUI
+    );
+});
+```

docs/README.md

@@ -52,6 +52,7 @@ Here are some examples to get you started:
 Refer to the page that interests you:
 - [Cable tiers](ADDING_CABLE_TIERS.md)
 - [Fluids](ADDING_FLUIDS.md)
+- [Hatches](ADDING_HATCHES.md)
 - [Machines](ADDING_MACHINES.md)
 - [Materials](ADDING_MATERIALS.md)
 - [Nuclear reactor components](ADDING_NUCLEAR_COMPONENTS.md)

src/main/java/aztech/modern_industrialization/compat/kubejs/KubeJSProxy.java

@@ -56,6 +56,9 @@ public void fireRegisterMachineCasingsEvent() {
     public void fireRegisterMachinesEvent() {
     }
 
+    public void fireRegisterHatchesEvent() {
+    }
+
     public void fireRegisterUpgradesEvent() {
     }
 

src/main/java/aztech/modern_industrialization/compat/kubejs/LoadedKubeJSProxy.java

@@ -69,6 +69,11 @@ public void fireRegisterMachinesEvent() {
         MIMachineKubeJSEvents.REGISTER_MACHINES.post(new RegisterMachinesEventJS());
     }
 
+    @Override
+    public void fireRegisterHatchesEvent() {
+        MIMachineKubeJSEvents.REGISTER_HATCHES.post(new RegisterHatchesEventJS());
+    }
+
     @Override
     public void fireAddMultiblockSlotsEvent(String category, SlotPositions.Builder itemInputs, SlotPositions.Builder itemOutputs,
             SlotPositions.Builder fluidInputs, SlotPositions.Builder fluidOutputs) {

src/main/java/aztech/modern_industrialization/compat/kubejs/machine/MIMachineKubeJSEvents.java

@@ -34,6 +34,7 @@ public interface MIMachineKubeJSEvents {
     EventHandler REGISTER_RECIPE_TYPES = EVENT_GROUP.startup("registerRecipeTypes", () -> RegisterRecipeTypesEventJS.class);
     EventHandler REGISTER_CASINGS = EVENT_GROUP.startup("registerCasings", () -> RegisterCasingsEventJS.class);
     EventHandler REGISTER_MACHINES = EVENT_GROUP.startup("registerMachines", () -> RegisterMachinesEventJS.class);
+    EventHandler REGISTER_HATCHES = EVENT_GROUP.startup("registerHatches", () -> RegisterHatchesEventJS.class);
     TargetedEventHandler<String> ADD_MULTIBLOCK_SLOTS = EVENT_GROUP.startup("addMultiblockSlots", () -> AddMultiblockSlotsEventJS.class)
             .requiredTarget(EventTargetType.STRING);
     EventHandler ADD_EBF_TIERS = EVENT_GROUP.startup("addEbfTiers", () -> AddEbfTiersEventJS.class);

src/main/java/aztech/modern_industrialization/compat/kubejs/machine/RegisterHatchesEventJS.java

@@ -0,0 +1,43 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Azercoco & Technici4n
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package aztech.modern_industrialization.compat.kubejs.machine;
+
+import aztech.modern_industrialization.api.energy.CableTier;
+import aztech.modern_industrialization.machines.init.MultiblockHatches;
+import aztech.modern_industrialization.machines.models.MachineCasings;
+import dev.latvian.mods.kubejs.event.KubeEvent;
+
+public class RegisterHatchesEventJS implements KubeEvent {
+    public void energy(String cableTier) {
+        MultiblockHatches.registerEnergyHatches(CableTier.getTier(cableTier));
+    }
+
+    public void fluid(String englishPrefix, String prefix, String casing, int bucketCapacity) {
+        MultiblockHatches.registerFluidHatches(englishPrefix, prefix, MachineCasings.get(casing), bucketCapacity);
+    }
+
+    public void item(String englishPrefix, String prefix, String casing, int rows, int columns, int xStart, int yStart) {
+        MultiblockHatches.registerItemHatches(englishPrefix, prefix, MachineCasings.get(casing), rows, columns, xStart, yStart);
+    }
+}

src/main/java/aztech/modern_industrialization/machines/init/MultiblockHatches.java

@@ -24,6 +24,7 @@
 package aztech.modern_industrialization.machines.init;
 
 import aztech.modern_industrialization.api.energy.CableTier;
+import aztech.modern_industrialization.compat.kubejs.KubeJSProxy;
 import aztech.modern_industrialization.inventory.ConfigurableFluidStack;
 import aztech.modern_industrialization.inventory.ConfigurableItemStack;
 import aztech.modern_industrialization.inventory.MIInventory;
@@ -72,9 +73,11 @@ public static void init() {
 
         MachineRegistrationHelper.registerMachine("Large Tank Hatch", "large_tank_hatch", LargeTankHatch::new, LargeTankHatch::registerFluidApi);
         MachineRegistrationHelper.addMachineModel("large_tank_hatch", "hatch_fluid", MachineCasings.STEEL, false, false, true, false);
+
+        KubeJSProxy.instance.fireRegisterHatchesEvent();
     }
 
-    private static void registerItemHatches(
+    public static void registerItemHatches(
             String englishPrefix, String prefix, MachineCasing casing, int rows, int columns, int xStart, int yStart) {
         for (int iter = 0; iter < 2; ++iter) {
             boolean input = iter == 0;
@@ -97,10 +100,10 @@ private static void registerItemHatches(
         }
     }
 
-    public static final int FLUID_HATCH_SLOT_X = 80;
-    public static final int FLUID_HATCH_SLOT_Y = 40;
+    private static final int FLUID_HATCH_SLOT_X = 80;
+    private static final int FLUID_HATCH_SLOT_Y = 40;
 
-    private static void registerFluidHatches(String englishPrefix, String prefix, MachineCasing casing, int bucketCapacity) {
+    public static void registerFluidHatches(String englishPrefix, String prefix, MachineCasing casing, int bucketCapacity) {
         for (int iter = 0; iter < 2; ++iter) {
             boolean input = iter == 0;
             String machine = prefix + "_fluid_" + (input ? "input" : "output") + "_hatch";
@@ -117,7 +120,7 @@ private static void registerFluidHatches(String englishPrefix, String prefix, Ma
         }
     }
 
-    private static void registerEnergyHatches(CableTier tier) {
+    public static void registerEnergyHatches(CableTier tier) {
         for (int iter = 0; iter < 2; ++iter) {
             boolean input = iter == 0;
             String machine = tier.name + "_energy_" + (input ? "input" : "output") + "_hatch";