Multiblock Refactor

docs/content/Development/Data-Sync-System/Usage.md

@@ -6,28 +6,59 @@ title: "Usage"
 
 ### Registering classes with the sync system
 
-At the core of the system is the interface `ISyncManaged`, which represents a class that to be synchronised with the client or saved.
+At the core of the system are the `ISyncManaged` and `ISyncAnnotated` interfaces, which allow for their fields to have sync annotations..
 All block entities which should be synchronised or saved must extend the abstract class `ManagedSyncBlockEntity`.
 
+`ISyncManaged` should be used for classes with any form of persistent state, and cannot be instantiated or reassigned.<br>
+`ISyncAnnotated` should be used for record-like classes that hold data, and must define a no-args constructor.
+
+
 !!! warning 
   Block entities that inherit `ManagedSyncBlockEntity` must call `ManagedSyncBlockEntity::updateTick`***every tick*** within their ticker, or they will not be saved.
 
+#### Example of `ISyncManaged` usage
 ```java
 class MySyncObject implements ISyncManaged {
-    // Any class that directly implements ISyncManaged must have the following:
+
+    // Any class that directly implements ISyncManaged must have a SyncDataHolder:
      @Getter
      protected final SyncDataHolder syncDataHolder = new SyncDataHolder(this);
+
+    // ISyncManaged objects should be attached to a parent sync managed object,
+    // unless the sync managed object is a blockentity
+    // ISyncManaged classes must implement a getter for their parent sync object
+    @Getter
+    private final MetaMachine parentSyncObject; 
+
+    @SaveField
+    @SyncToClient
+    private BlockPos syncPos;
 
+    @SaveField
+    @SyncToClient
+    private ExampleSyncAnnotated syncAnnotatedField;
+
+    public MySyncObject(MetaMachine machine) {
+        this.parentSyncObject = machine;
+    }
+
+    public void doChanges() {
+
+      syncPos = BlockPos.ZERO;
+        // Client sync fields do not update automatically.
+      getSyncDataHolder().markClientSyncFieldDirty("syncPos")
+
+      syncAnnotatedField.someValue = 10;
+      /*
+       * Because ISyncAnnotated classes do not manage their own sync state, 
+       * updating a field in an ISyncAnnotated class requires the parent field to be marked as changed.
+       */
+      getSyncDataHolder().markClientSyncFieldDirty("syncAnnotatedField");        
+    }
 
-    /**
-     * Function called when the SyncDataHolder requests a rerender
-     */
-    void scheduleRenderUpdate();
-
-    /**
-     * Function called to notify the server that this object has been updated and must be synced to clients
-     */
-    void markAsChanged();
+    private static class ExampleSyncAnnotated implements ISyncAnnotated {
+        public int someValue = 0;
+    }
 }
 ```
 

docs/content/Development/General-Topics/Tick-Updates.md

@@ -61,10 +61,9 @@ Lets look at how we implement it in `QuantumChest`.
     @Override
     public void onLoad() {
         super.onLoad();
-        if (getLevel() instanceof ServerLevel serverLevel) {
-            // you cant call ItemTransferHelper.getItemTransfer while chunk is loading, so lets defer it next tick.
-            serverLevel.getServer().tell(new TickTask(0, this::updateAutoOutputSubscription));
-        }
+
+        // you cant call ItemTransferHelper.getItemTransfer while chunk is loading, so lets defer it next tick.
+        scheduleForNextServerTick(this::updateAutoOutputSubscription);
         // add a listener to listen the changes of inner inventory. (for ex, if inventory not empty anymore, we may need to unpdate logic)
         exportItemSubs = cache.addChangedListener(this::updateAutoOutputSubscription);
     }

src/generated/resources/assets/gtceu/blockstates/active_transformer.json

@@ -1,5 +1,8 @@
 {
   "variants": {
+    "facing=down,upwards_facing=down": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=down,upwards_facing=east": {
       "gtceu:z": 90,
       "model": "gtceu:block/machine/active_transformer",
@@ -14,56 +17,77 @@
       "model": "gtceu:block/machine/active_transformer",
       "x": 90
     },
+    "facing=down,upwards_facing=up": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=down,upwards_facing=west": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer",
       "x": 90
     },
-    "facing=east,upwards_facing=east": {
-      "gtceu:z": 270,
+    "facing=east,upwards_facing=down": {
+      "gtceu:z": 180,
       "model": "gtceu:block/machine/active_transformer",
       "y": 90
     },
+    "facing=east,upwards_facing=east": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=east,upwards_facing=north": {
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer",
       "y": 90
     },
     "facing=east,upwards_facing=south": {
-      "gtceu:z": 180,
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/active_transformer",
       "y": 90
     },
-    "facing=east,upwards_facing=west": {
-      "gtceu:z": 90,
+    "facing=east,upwards_facing=up": {
       "model": "gtceu:block/machine/active_transformer",
       "y": 90
     },
+    "facing=east,upwards_facing=west": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
+    "facing=north,upwards_facing=down": {
+      "gtceu:z": 180,
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=north,upwards_facing=east": {
-      "gtceu:z": 270,
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/active_transformer"
     },
     "facing=north,upwards_facing=north": {
       "model": "gtceu:block/machine/active_transformer"
     },
     "facing=north,upwards_facing=south": {
-      "gtceu:z": 180,
+      "model": "gtceu:block/machine/active_transformer"
+    },
+    "facing=north,upwards_facing=up": {
       "model": "gtceu:block/machine/active_transformer"
     },
     "facing=north,upwards_facing=west": {
-      "gtceu:z": 90,
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer"
     },
+    "facing=south,upwards_facing=down": {
+      "gtceu:z": 180,
+      "model": "gtceu:block/machine/active_transformer",
+      "y": 180
+    },
     "facing=south,upwards_facing=east": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer",
       "y": 180
     },
     "facing=south,upwards_facing=north": {
-      "model": "gtceu:block/machine/active_transformer",
-      "y": 180
+      "model": "gtceu:block/machine/active_transformer"
     },
     "facing=south,upwards_facing=south": {
-      "gtceu:z": 180,
+      "model": "gtceu:block/machine/active_transformer"
+    },
+    "facing=south,upwards_facing=up": {
       "model": "gtceu:block/machine/active_transformer",
       "y": 180
     },
@@ -72,6 +96,9 @@
       "model": "gtceu:block/machine/active_transformer",
       "y": 180
     },
+    "facing=up,upwards_facing=down": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=up,upwards_facing=east": {
       "gtceu:z": 90,
       "model": "gtceu:block/machine/active_transformer",
@@ -86,29 +113,38 @@
       "model": "gtceu:block/machine/active_transformer",
       "x": 270
     },
+    "facing=up,upwards_facing=up": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=up,upwards_facing=west": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer",
       "x": 270
     },
-    "facing=west,upwards_facing=east": {
-      "gtceu:z": 270,
+    "facing=west,upwards_facing=down": {
+      "gtceu:z": 180,
       "model": "gtceu:block/machine/active_transformer",
       "y": 270
     },
+    "facing=west,upwards_facing=east": {
+      "model": "gtceu:block/machine/active_transformer"
+    },
     "facing=west,upwards_facing=north": {
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/active_transformer",
       "y": 270
     },
     "facing=west,upwards_facing=south": {
-      "gtceu:z": 180,
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/active_transformer",
       "y": 270
     },
-    "facing=west,upwards_facing=west": {
-      "gtceu:z": 90,
+    "facing=west,upwards_facing=up": {
       "model": "gtceu:block/machine/active_transformer",
       "y": 270
+    },
+    "facing=west,upwards_facing=west": {
+      "model": "gtceu:block/machine/active_transformer"
     }
   }
 }

src/generated/resources/assets/gtceu/blockstates/advanced_monitor.json

@@ -1,5 +1,8 @@
 {
   "variants": {
+    "facing=down,upwards_facing=down": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=down,upwards_facing=east": {
       "gtceu:z": 90,
       "model": "gtceu:block/machine/advanced_monitor",
@@ -14,56 +17,77 @@
       "model": "gtceu:block/machine/advanced_monitor",
       "x": 90
     },
+    "facing=down,upwards_facing=up": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=down,upwards_facing=west": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor",
       "x": 90
     },
-    "facing=east,upwards_facing=east": {
-      "gtceu:z": 270,
+    "facing=east,upwards_facing=down": {
+      "gtceu:z": 180,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 90
     },
+    "facing=east,upwards_facing=east": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=east,upwards_facing=north": {
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 90
     },
     "facing=east,upwards_facing=south": {
-      "gtceu:z": 180,
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 90
     },
-    "facing=east,upwards_facing=west": {
-      "gtceu:z": 90,
+    "facing=east,upwards_facing=up": {
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 90
     },
+    "facing=east,upwards_facing=west": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
+    "facing=north,upwards_facing=down": {
+      "gtceu:z": 180,
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=north,upwards_facing=east": {
-      "gtceu:z": 270,
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/advanced_monitor"
     },
     "facing=north,upwards_facing=north": {
       "model": "gtceu:block/machine/advanced_monitor"
     },
     "facing=north,upwards_facing=south": {
-      "gtceu:z": 180,
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
+    "facing=north,upwards_facing=up": {
       "model": "gtceu:block/machine/advanced_monitor"
     },
     "facing=north,upwards_facing=west": {
-      "gtceu:z": 90,
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor"
     },
+    "facing=south,upwards_facing=down": {
+      "gtceu:z": 180,
+      "model": "gtceu:block/machine/advanced_monitor",
+      "y": 180
+    },
     "facing=south,upwards_facing=east": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 180
     },
     "facing=south,upwards_facing=north": {
-      "model": "gtceu:block/machine/advanced_monitor",
-      "y": 180
+      "model": "gtceu:block/machine/advanced_monitor"
     },
     "facing=south,upwards_facing=south": {
-      "gtceu:z": 180,
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
+    "facing=south,upwards_facing=up": {
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 180
     },
@@ -72,6 +96,9 @@
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 180
     },
+    "facing=up,upwards_facing=down": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=up,upwards_facing=east": {
       "gtceu:z": 90,
       "model": "gtceu:block/machine/advanced_monitor",
@@ -86,29 +113,38 @@
       "model": "gtceu:block/machine/advanced_monitor",
       "x": 270
     },
+    "facing=up,upwards_facing=up": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=up,upwards_facing=west": {
       "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor",
       "x": 270
     },
-    "facing=west,upwards_facing=east": {
-      "gtceu:z": 270,
+    "facing=west,upwards_facing=down": {
+      "gtceu:z": 180,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 270
     },
+    "facing=west,upwards_facing=east": {
+      "model": "gtceu:block/machine/advanced_monitor"
+    },
     "facing=west,upwards_facing=north": {
+      "gtceu:z": 90,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 270
     },
     "facing=west,upwards_facing=south": {
-      "gtceu:z": 180,
+      "gtceu:z": 270,
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 270
     },
-    "facing=west,upwards_facing=west": {
-      "gtceu:z": 90,
+    "facing=west,upwards_facing=up": {
       "model": "gtceu:block/machine/advanced_monitor",
       "y": 270
+    },
+    "facing=west,upwards_facing=west": {
+      "model": "gtceu:block/machine/advanced_monitor"
     }
   }
 }