add test multiblock to example mod (closes #3)

Author: devpikachu

Common.Mod.Example/BlockBehaviors/TestMultiblockBlockBehavior.cs

@@ -0,0 +1,114 @@
+using Common.Mod.Blocks;
+using Vintagestory.API.Common;
+using Vintagestory.API.MathTools;
+using Vintagestory.GameContent;
+
+namespace Common.Mod.Example.BlockBehaviors;
+
+public class TestMultiblockBlockBehavior : StrongBlockBehavior, IMultiBlockColSelBoxes, IMultiBlockParticleColBoxes
+{
+    public const string RegistryId = "TestMultiblock";
+
+    public TestMultiblockBlockBehavior(Block block) : base(block)
+    {
+    }
+
+    public override bool CanPlaceBlock(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling, ref string failureCode)
+    {
+        var topBlockSel = blockSel.AddPosCopy(0, 1, 0);
+
+        var bottomBlockPlaceable = world.BlockAccessor.GetBlock(blockSel.Position).IsReplacableBy(block);
+        var topBlockPlaceable = world.BlockAccessor.GetBlock(topBlockSel.Position).IsReplacableBy(block);
+
+        if (!bottomBlockPlaceable || !topBlockPlaceable)
+        {
+            handling = EnumHandling.PreventDefault;
+            failureCode = "notenoughspace";
+            return false;
+        }
+
+        return base.CanPlaceBlock(world, byPlayer, blockSel, ref handling, ref failureCode);
+    }
+
+    public override bool TryPlaceBlock(
+        IWorldAccessor world,
+        IPlayer byPlayer,
+        ItemStack itemstack,
+        BlockSelection blockSel,
+        ref EnumHandling handling,
+        ref string failureCode
+    )
+    {
+        handling = EnumHandling.PreventDefault;
+
+        if (!block.CanPlaceBlock(world, byPlayer, blockSel, ref failureCode))
+        {
+            return false;
+        }
+
+        world.BlockAccessor.SetBlock(block.Id, blockSel.Position);
+
+        if (world.Side is EnumAppSide.Server)
+        {
+            var assetLocation = new AssetLocation("common:multiblock-monolithic-0-p1-0");
+            var topBlockSel = blockSel.AddPosCopy(0, 1, 0);
+            world.BlockAccessor.SetBlock(world.GetBlock(assetLocation).Id, topBlockSel.Position);
+            world.BlockAccessor.TriggerNeighbourBlockUpdate(topBlockSel.Position);
+        }
+
+        return true;
+    }
+
+    public override void OnBlockRemoved(IWorldAccessor world, BlockPos pos, ref EnumHandling handling)
+    {
+        if (world.Side is EnumAppSide.Client)
+        {
+            return;
+        }
+
+        var topBlockPos = pos.Add(0, 1, 0);
+        if (world.BlockAccessor.GetBlock(topBlockPos) is BlockMultiblock)
+        {
+            world.BlockAccessor.SetBlock(0, topBlockPos);
+            if (world.Side is EnumAppSide.Server)
+            {
+                world.BlockAccessor.TriggerNeighbourBlockUpdate(topBlockPos);
+            }
+        }
+
+        base.OnBlockRemoved(world, pos, ref handling);
+    }
+
+    public override Cuboidf[] GetCollisionBoxes(IBlockAccessor blockAccessor, BlockPos pos, ref EnumHandling handled)
+    {
+        handled = EnumHandling.PreventSubsequent;
+        return block.SelectionBoxes;
+    }
+
+    public override Cuboidf[] GetSelectionBoxes(IBlockAccessor blockAccessor, BlockPos pos, ref EnumHandling handled)
+    {
+        handled = EnumHandling.PreventSubsequent;
+        return block.SelectionBoxes;
+    }
+
+    public override Cuboidf[] GetParticleCollisionBoxes(IBlockAccessor blockAccessor, BlockPos pos, ref EnumHandling handled)
+    {
+        handled = EnumHandling.PreventSubsequent;
+        return block.SelectionBoxes;
+    }
+
+    public Cuboidf[] MBGetCollisionBoxes(IBlockAccessor blockAccessor, BlockPos pos, Vec3i offset)
+    {
+        return block.SelectionBoxes.Select(box => box.OffsetCopy(offset)).ToArray();
+    }
+
+    public Cuboidf[] MBGetSelectionBoxes(IBlockAccessor blockAccessor, BlockPos pos, Vec3i offset)
+    {
+        return block.SelectionBoxes.Select(box => box.OffsetCopy(offset)).ToArray();
+    }
+
+    public Cuboidf[] MBGetParticleCollisionBoxes(IBlockAccessor blockAccessor, BlockPos pos, Vec3i offset)
+    {
+        return block.SelectionBoxes.Select(box => box.OffsetCopy(offset)).ToArray();
+    }
+}

Common.Mod.Example/Common.Mod.Example.csproj

@@ -15,6 +15,10 @@
       <HintPath>../vendor/VintagestoryAPI.dll</HintPath>
       <Private>false</Private>
     </Reference>
+    <Reference Include="VSEssentials">
+      <HintPath>../vendor/VSEssentials.dll</HintPath>
+      <Private>false</Private>
+    </Reference>
 
     <Reference Include="protobuf-net">
       <HintPath>../vendor/protobuf-net.dll</HintPath>

Common.Mod.Example/ExampleSystem.cs

@@ -1,4 +1,5 @@
 using Common.Mod.Common.Config;
+using Common.Mod.Example.BlockBehaviors;
 using JetBrains.Annotations;
 using Vintagestory.API.Common;
 
@@ -19,4 +20,10 @@ protected override void RegisterConfigs(IConfigSystem configSystem)
         configSystem.Register<ExampleServerConfig>();
         configSystem.Register<ExampleClientConfig>();
     }
+
+    protected override void RegisterClasses(ICoreAPI api)
+    {
+        base.RegisterClasses(api);
+        RegisterBlockBehaviorClass<TestMultiblockBlockBehavior>(api, TestMultiblockBlockBehavior.RegistryId);
+    }
 }

Common.Mod.Example/assets/example/blocktypes/test-multiblock.json

@@ -1,6 +1,11 @@
 {
   "code": "test-multiblock",
   "class": "BlockGeneric",
+  "behaviors": [
+    {
+      "name": "example:TestMultiblock"
+    }
+  ],
   "creativeInventory": {
     "general": [
       "*"
@@ -12,5 +17,23 @@
   "drawType": "JSON",
   "shape": {
     "base": "example:block/test-multiblock"
-  }
+  },
+  "selectionBoxes": [
+    {
+      "x1": 0,
+      "y1": 0,
+      "z1": 0,
+      "x2": 1,
+      "y2": 1,
+      "z2": 1
+    },
+    {
+      "x1": 0.0625,
+      "y1": 1,
+      "z1": 0.0625,
+      "x2": 0.9375,
+      "y2": 1.875,
+      "z2": 0.9375
+    }
+  ]
 }

Common.Mod/System.cs

@@ -217,10 +217,7 @@ protected virtual void ClientStartPre(ICoreClientAPI api)
     [UsedImplicitly]
     protected virtual void RegisterClasses(ICoreAPI api)
     {
-        if (api.ClassRegistry.GetBlockClass($"common:{MultiblockBlock.RegistryId}") is null)
-        {
-            api.RegisterBlockClass($"common:{MultiblockBlock.RegistryId}", typeof(MultiblockBlock));
-        }
+        api.RegisterBlockClass($"common:{MultiblockBlock.RegistryId}", typeof(MultiblockBlock));
     }
 
     #endregion Virtuals