Merge 1.20.1 8.0.0 into mui2 refactor (#4448)

Co-authored-by: YoungOnion <39562198+YoungOnionMC@users.noreply.github.com>
Co-authored-by: Gustavo <77560533+gustovafing@users.noreply.github.com>

Author: 3 people

docs/content/Modpacks/Changes/v8.0.0.md

@@ -0,0 +1,71 @@
+---
+title: "Version 8.0.0"
+---
+
+
+# Updating from `7.4.0` to `8.0.0`
+
+## Machine Refactor
+
+Many aspects of the machine classes have been refactored and changed in order to streamline the machine system and remove legacy and unnecessary abstraction.
+
+### `MetaMachine` and `MetaMachineBlockEntity` merge
+
+- The `MetaMachineBlockEntity`(MMBE) class has been removed, and `MetaMachine`(MM) is now a BlockEntity.
+- Most methods and properties of MMBE have been moved onto MM.
+- The `IMachineBlockEntity` interface has been removed. Use `MetaMachineBlock` directly instead.
+- Many methods common to all block entities have been moved to the `IGregtechBlockEntity` interface.
+- Machine instance creation functions have signature `(BlockEntityCreationInfo) -> MetaMachine` instead of `(IMachineBlockEntity) -> MetaMachine` 
+
+References to MMBE can generally be replaced with references to MM:
+```java
+/////// OLD
+if (level.getBlockEntity(getPos()) instanceof MetaMachineBlockEntity mmbe) {
+    MetaMachine machine = mmbe.getMetaMachine();
+    ...
+}
+
+////// NEW
+if (level.getBlockEntity(getPos()) instanceof MetaMachine machine) {
+    ... 
+} 
+```
+
+The `IMachineBlockEntity holder` argument in machine constructors has been replaced with `BlockEntityCreationInfo info`:
+```java
+////// OLD
+public MetaMachine(IMachineBlockEntity holder);
+////// NEW
+public MetaMachine(BlockEntityCreationInfo info);
+```
+A number of methods have been renamed across a number of different interfaces and classes to ensure consistency with default BlockEntity methods:
+- `BlockPos getPipePos()` -> `BlockPos getBlockPos()`
+- `Level getPipeLevel()` -> `Level getLevel()`
+- `BlockPos getPos()` -> `BlockPos getBlockPos()`
+- `BlockState getState()` -> `BlockState getBlockState()`
+- `boolean isInvalid()` -> `boolean isRemoved()`
+- `void markAsDirty()` -> `void markAsChanged()`
+
+### Machine constructor and trait initialisation changes
+
+The constructors for a large number of machines have changed in order to simply machine instance creation. Additionally, methods for trait creation have also been removed and now form part of the machine constructor.
+
+#### **All Machines**
+- Replace the first constructor argument `IMachineBlockEntity holder` with `BlockEntityCreationInfo info`
+#### `TieredEnergyMachine`
+- Removed `createEnergyContainer` method
+- Constructor now has an optional `Supplier<NotifiableEnergyContainer>` argument
+#### `WorkableTieredMachine`
+- Removed `createRecipeLogic`, `createImportItemHandler`, `createExportItemHandler`, `createImportFluidHandler`, `createExportFluidHandler` methods
+- Added a new constructor:
+    - `BlockEntityCreationInfo info` 
+    - `int tier`
+    - `Supplier<RecipeLogic> recipeLogicSupplier` Recipe logic supplier, defaults to the standard `RecipeLogic` class.
+    - `int importSlots` Item import slots, defaults to the amount of slots in the machine's default recipe type.
+    - `int exportSlots` Same as above, but for item export slots.
+    - `int fluidImportSlots` As above, but for fluid import slots.
+    - `int fluidExportSlots` As above, but for fluid export slots.
+    - `Int2IntFunction tankScalingFunction` Fluid tank capacity scaling function.
+#### `WorkableMultiblockMachine`, `WorkableElectricMultiblockMachine` and `SteamWorkableMachine`
+- Removed `createRecipeLogic` method
+- Constructor now has an optional `Supplier<RecipeLogic>` argument, defaults to the standard `RecipeLogic` class

src/main/java/com/gregtechceu/gtceu/api/block/IMachineBlock.java

@@ -6,20 +6,19 @@
 import com.gregtechceu.gtceu.api.item.MetaMachineItem;
 import com.gregtechceu.gtceu.api.item.tool.GTToolType;
 import com.gregtechceu.gtceu.api.item.tool.ToolHelper;
-import com.gregtechceu.gtceu.api.machine.IMachineBlockEntity;
 import com.gregtechceu.gtceu.api.machine.MachineDefinition;
 import com.gregtechceu.gtceu.api.machine.MetaMachine;
 import com.gregtechceu.gtceu.api.machine.MultiblockMachineDefinition;
 import com.gregtechceu.gtceu.api.machine.feature.*;
 import com.gregtechceu.gtceu.common.data.GTItems;
 import com.gregtechceu.gtceu.common.machine.owner.MachineOwner;
+import com.gregtechceu.gtceu.syncsystem.ManagedSyncBlockEntity;
 import com.gregtechceu.gtceu.utils.GTUtil;
 
 import net.minecraft.MethodsReturnNonnullByDefault;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.locale.Language;
-import net.minecraft.nbt.CompoundTag;
 import net.minecraft.network.chat.Component;
 import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.util.RandomSource;
@@ -37,9 +36,12 @@
 import net.minecraft.world.level.BlockGetter;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.EntityBlock;
 import net.minecraft.world.level.block.RenderShape;
 import net.minecraft.world.level.block.Rotation;
 import net.minecraft.world.level.block.entity.BlockEntity;
+import net.minecraft.world.level.block.entity.BlockEntityTicker;
+import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
 import net.minecraft.world.level.block.state.StateDefinition;
 import net.minecraft.world.level.storage.loot.LootParams;
@@ -60,7 +62,7 @@
 @SuppressWarnings("deprecation")
 @MethodsReturnNonnullByDefault
 @ParametersAreNonnullByDefault
-public class MetaMachineBlock extends Block implements IMachineBlock {
+public class MetaMachineBlock extends Block implements EntityBlock {
 
     @Getter
     public final MachineDefinition definition;
@@ -90,6 +92,10 @@ protected void createBlockStateDefinition(StateDefinition.Builder<Block, BlockSt
         }
     }
 
+    public RotationState getRotationState() {
+        return getDefinition().getRotationState();
+    }
+
     @Override
     public VoxelShape getShape(BlockState pState, BlockGetter pLevel, BlockPos pPos, CollisionContext pContext) {
         return getRotationState() == RotationState.NONE ? definition.getShape(Direction.NORTH) :
@@ -104,7 +110,7 @@ public RenderShape getRenderShape(BlockState state) {
     @Override
     public void animateTick(BlockState state, Level level, BlockPos pos, RandomSource random) {
         super.animateTick(state, level, pos, random);
-        var machine = getMachine(level, pos);
+        var machine = MetaMachine.getMachine(level, pos);
         if (machine != null) {
             machine.animateTick(random);
         }
@@ -114,20 +120,9 @@ public void animateTick(BlockState state, Level level, BlockPos pos, RandomSourc
     public void setPlacedBy(Level pLevel, BlockPos pPos, BlockState pState, @Nullable LivingEntity player,
                             ItemStack pStack) {
         if (!pLevel.isClientSide) {
-            var machine = getMachine(pLevel, pPos);
+            var machine = MetaMachine.getMachine(pLevel, pPos);
             if (machine != null) {
-                if (player instanceof ServerPlayer sPlayer) {
-                    machine.setOwnerUUID(sPlayer.getUUID());
-                }
-            }
-            if (machine instanceof IDropSaveMachine dropSaveMachine) {
-                CompoundTag tag = pStack.getTag();
-                if (tag != null) {
-                    dropSaveMachine.loadFromItem(tag);
-                }
-            }
-            if (machine instanceof IMachineLife machineLife) {
-                machineLife.onMachinePlaced(player, pStack);
+                machine.onMachinePlaced(player, pStack);
             }
         }
     }
@@ -178,7 +173,8 @@ public BlockState getStateForPlacement(BlockPlaceContext context) {
     @Override
     public ItemStack getCloneItemStack(BlockGetter level, BlockPos pos, BlockState state) {
         ItemStack itemStack = super.getCloneItemStack(level, pos, state);
-        if (getMachine(level, pos) instanceof IDropSaveMachine dropSaveMachine && dropSaveMachine.savePickClone()) {
+        if (MetaMachine.getMachine(level, pos) instanceof IDropSaveMachine dropSaveMachine &&
+                dropSaveMachine.savePickClone()) {
             dropSaveMachine.saveToItem(itemStack.getOrCreateTag());
         }
         return itemStack;
@@ -228,8 +224,7 @@ public BlockState rotate(BlockState pState, Rotation pRotation) {
     public List<ItemStack> getDrops(BlockState state, LootParams.Builder builder) {
         BlockEntity tileEntity = builder.getOptionalParameter(LootContextParams.BLOCK_ENTITY);
         var drops = super.getDrops(state, builder);
-        if (tileEntity instanceof IMachineBlockEntity holder) {
-            var machine = holder.getMetaMachine();
+        if (tileEntity instanceof MetaMachine machine) {
             if (machine instanceof IMachineModifyDrops machineModifyDrops) {
                 machineModifyDrops.onDrops(drops);
             }
@@ -250,7 +245,7 @@ public List<ItemStack> getDrops(BlockState state, LootParams.Builder builder) {
     public void onRemove(BlockState pState, Level pLevel, BlockPos pPos, BlockState pNewState, boolean pIsMoving) {
         if (pState.hasBlockEntity()) {
             if (!pState.is(pNewState.getBlock())) { // new block
-                MetaMachine machine = getMachine(pLevel, pPos);
+                MetaMachine machine = MetaMachine.getMachine(pLevel, pPos);
                 if (machine instanceof IMachineLife machineLife) {
                     machineLife.onMachineRemoved();
                 }
@@ -266,7 +261,7 @@ public void onRemove(BlockState pState, Level pLevel, BlockPos pPos, BlockState
                 var oldFacing = pState.getValue(getRotationState().property);
                 var newFacing = pNewState.getValue(getRotationState().property);
                 if (newFacing != oldFacing) {
-                    var machine = getMachine(pLevel, pPos);
+                    var machine = MetaMachine.getMachine(pLevel, pPos);
                     if (machine != null) {
                         machine.onRotated(oldFacing, newFacing);
                     }
@@ -278,7 +273,7 @@ public void onRemove(BlockState pState, Level pLevel, BlockPos pPos, BlockState
     @Override
     public InteractionResult use(BlockState state, Level world, BlockPos pos, Player player, InteractionHand hand,
                                  BlockHitResult hit) {
-        var machine = getMachine(world, pos);
+        var machine = MetaMachine.getMachine(world, pos);
         ItemStack itemStack = player.getItemInHand(hand);
         boolean shouldOpenUi = true;
 
@@ -325,28 +320,32 @@ public InteractionResult use(BlockState state, Level world, BlockPos pos, Player
         return shouldOpenUi ? InteractionResult.PASS : InteractionResult.CONSUME;
     }
 
-    @Override
-    @SuppressWarnings("deprecation") // This is fine to override, just not to be called.
-    public int getSignal(BlockState state, BlockGetter level, BlockPos pos, Direction direction) {
-        return getMachine(level, pos).getOutputSignal(direction);
+    //////////////////////////////////////
+    // ***** Redstone Signals ****//
+    //////////////////////////////////////
+
+    public boolean canConnectRedstone(BlockGetter level, BlockPos pos, Direction side) {
+        return MetaMachine.getMachine(level, pos).canConnectRedstone(side);
     }
 
     @Override
     @SuppressWarnings("deprecation") // This is fine to override, just not to be called.
-    public int getDirectSignal(BlockState state, BlockGetter level, BlockPos pos, Direction direction) {
-        return getMachine(level, pos).getOutputDirectSignal(direction);
+    public int getSignal(BlockState state, BlockGetter level, BlockPos pos, Direction direction) {
+        return MetaMachine.getMachine(level, pos).getOutputSignal(direction);
     }
 
     @Override
     @SuppressWarnings("deprecation") // This is fine to override, just not to be called.
     public int getAnalogOutputSignal(BlockState state, Level level, BlockPos pos) {
-        return getMachine(level, pos).getAnalogOutputSignal();
+        return MetaMachine.getMachine(level, pos).getAnalogOutputSignal();
     }
 
+    /////////
+
     @Override
     public void neighborChanged(BlockState state, Level level, BlockPos pos, Block block, BlockPos fromPos,
                                 boolean isMoving) {
-        var machine = getMachine(level, pos);
+        var machine = MetaMachine.getMachine(level, pos);
         if (machine != null) {
             machine.onNeighborChanged(block, fromPos, isMoving);
         }
@@ -356,7 +355,7 @@ public void neighborChanged(BlockState state, Level level, BlockPos pos, Block b
     @Override
     public BlockState getAppearance(BlockState state, BlockAndTintGetter level, BlockPos pos, Direction side,
                                     @Nullable BlockState sourceState, @Nullable BlockPos sourcePos) {
-        var machine = getMachine(level, pos);
+        var machine = MetaMachine.getMachine(level, pos);
         if (machine != null) {
             return machine.getBlockAppearance(state, level, pos, side, sourceState, sourcePos);
         }
@@ -368,4 +367,51 @@ public boolean isValidSpawn(BlockState state, BlockGetter level, BlockPos pos, S
                                 EntityType<?> entityType) {
         return false;
     }
+
+    public Direction getFrontFacing(BlockState state) {
+        return getRotationState() == RotationState.NONE ? Direction.NORTH : state.getValue(getRotationState().property);
+    }
+
+    public static int colorTinted(BlockState blockState, @Nullable BlockAndTintGetter level, @Nullable BlockPos pos,
+                                  int index) {
+        if (level != null && pos != null) {
+            var machine = MetaMachine.getMachine(level, pos);
+            if (machine != null) {
+                return machine.tintColor(index);
+            }
+        }
+        return -1;
+    }
+
+    @Nullable
+    @Override
+    public final BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
+        return getDefinition().getBlockEntityType().create(pos, state);
+    }
+
+    @Nullable
+    @Override
+    public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state,
+                                                                  BlockEntityType<T> blockEntityType) {
+        if (blockEntityType == getDefinition().getBlockEntityType()) {
+            if (!level.isClientSide) {
+                return (pLevel, pPos, pState, pTile) -> {
+                    pTile.setChanged();
+                    if (pTile instanceof MetaMachine metaMachine) {
+                        metaMachine.serverTick();
+                    }
+                    if (pTile instanceof ManagedSyncBlockEntity syncObj) {
+                        syncObj.updateTick();
+                    }
+                };
+            } else {
+                return (pLevel, pPos, pState, pTile) -> {
+                    if (pTile instanceof MetaMachine metaMachine) {
+                        metaMachine.clientTick();
+                    }
+                };
+            }
+        }
+        return null;
+    }
 }