Add block placement API

GamecraftModdingAPI/Blocks/BlockColors.cs

@@ -0,0 +1,17 @@
+namespace GamecraftModdingAPI.Blocks
+{
+    public enum BlockColors
+    {
+        Default = byte.MaxValue,
+        White = 0,
+        Pink,
+        Purple,
+        Blue,
+        Aqua,
+        Green,
+        Lime,
+        Yellow,
+        Orange,
+        Red
+    }
+}

GamecraftModdingAPI/Blocks/Placement.cs

@@ -0,0 +1,46 @@
+using System;
+using GamecraftModdingAPI.Utility;
+using GCMC;
+using Unity.Mathematics;
+
+namespace GamecraftModdingAPI.Blocks
+{
+    /// <summary>
+    /// Common block movement operations
+    /// </summary>
+    public static class Placement
+    {
+        private static PlacementEngine placementEngine = new PlacementEngine();
+
+        /// <summary>
+        /// Place a block at the given position. If scaled, position means the center of the block. The default block size is 0.2 in terms of position.
+        /// Place blocks next to each other to connect them.
+        /// </summary>
+        /// <param name="block">The block's type</param>
+        /// <param name="color">The block's color</param>
+        /// <param name="darkness">The block color's darkness (0-9) - 0 is default color</param>
+        /// <param name="position">The block's position in the grid - default block size is 0.2</param>
+        /// <param name="rotation">The block's rotation</param>
+        /// <param name="uscale">The block's uniform scale - default scale is 1 (with 0.2 width)</param>
+        /// <param name="scale">The block's non-uniform scale - less than 1 means <paramref name="uscale"/> is used</param>
+        /// <param name="playerId">The player who placed the block</param>
+        /// <exception cref="Exception"></exception>
+        public static bool PlaceBlock(ushort block, float3 position,
+            quaternion rotation = new quaternion(), BlockColors color = BlockColors.Default, byte darkness = 0,
+            int uscale = 1, float3 scale = new float3(), uint playerId = 0)
+        {
+            if (placementEngine.IsInGame && GameState.IsBuildMode())
+            {
+                placementEngine.PlaceBlock(block, color, darkness, position, uscale, scale, playerId, rotation);
+                return true;
+            }
+
+            return false;
+        }
+
+        public static void Init()
+        {
+            GameEngineManager.AddGameEngine(placementEngine);
+        }
+    }
+}

GamecraftModdingAPI/Blocks/PlacementEngine.cs

@@ -0,0 +1,156 @@
+using System;
+using System.Reflection;
+using DataLoader;
+using GamecraftModdingAPI.Blocks;
+using GamecraftModdingAPI.Utility;
+using Harmony;
+using JetBrains.Annotations;
+using RobocraftX.Blocks;
+using RobocraftX.Blocks.Ghost;
+using RobocraftX.Blocks.Scaling;
+using RobocraftX.Character;
+using RobocraftX.CommandLine.Custom;
+using RobocraftX.Common;
+using RobocraftX.Common.Input;
+using RobocraftX.Common.Utilities;
+using RobocraftX.CR.MachineEditing;
+using RobocraftX.StateSync;
+using Svelto.ECS;
+using Svelto.ECS.EntityStructs;
+using Unity.Jobs;
+using Unity.Mathematics;
+using UnityEngine;
+using uREPL;
+
+namespace GCMC
+{
+    public class PlacementEngine : IApiEngine
+    {
+        public bool IsInGame = false;
+
+        public void Dispose()
+        {
+            IsInGame = false;
+        }
+
+        public void Ready()
+        {
+            IsInGame = true;
+        }
+
+        public IEntitiesDB entitiesDB { get; set; }
+        internal static BlockEntityFactory _blockEntityFactory; //Injected from PlaceBlockEngine
+
+        /// <summary>
+        /// Places a block at the given position
+        /// </summary>
+        /// <param name="block">The block's type</param>
+        /// <param name="color">The block's color</param>
+        /// <param name="darkness">The block color's darkness - 0 is default color</param>
+        /// <param name="position">The block's position - default block size is 0.2</param>
+        /// <param name="uscale">The block's uniform scale - default scale is 1 (with 0.2 width)</param>
+        /// <param name="scale">The block's non-uniform scale - less than 1 means <paramref name="uscale"/> is used</param>
+        /// <param name="playerId">The player who placed the block</param>
+        /// <exception cref="Exception"></exception>
+        public void PlaceBlock(ushort block, BlockColors color, byte darkness, float3 position, int uscale,
+            float3 scale, uint playerId, quaternion rotation)
+        { //It appears that only the non-uniform scale has any visible effect, but if that's not given here it will be set to the uniform one
+            try
+            {
+                if (darkness > 9)
+                    throw new Exception("That is too dark. Make sure to use 0-9 as darkness. (0 is default.)");
+                BuildBlock(block, (byte) (color + darkness * 10), position, uscale, scale, rotation).Init(
+                    new BlockPlacementInfoStruct()
+                    {
+                        loadedFromDisk = false,
+                        placedBy = playerId
+                    });
+            }
+            catch (Exception e)
+            {
+                Console.WriteLine(e);
+                Log.Error(e.Message);
+            }
+        }
+
+        private EntityStructInitializer BuildBlock(ushort block, byte color, float3 position, int uscale, float3 scale, quaternion rot)
+        {
+            if (_blockEntityFactory == null)
+                throw new Exception("The factory is null.");
+            if (uscale < 1)
+                throw new Exception("Scale needs to be at least 1");
+            if (scale.x < 1) scale.x = uscale;
+            if (scale.y < 1) scale.y = uscale;
+            if (scale.z < 1) scale.z = uscale;
+            //RobocraftX.CR.MachineEditing.PlaceBlockEngine
+            ScalingEntityStruct scaling = new ScalingEntityStruct {scale = scale};
+            RotationEntityStruct rotation = new RotationEntityStruct {rotation = rot};
+            GridRotationStruct gridRotation = new GridRotationStruct
+                {position = float3.zero, rotation = quaternion.identity};
+            CubeCategoryStruct category = new CubeCategoryStruct
+                {category = CubeCategory.General, type = CubeType.Block};
+            uint dbid = block;
+            DBEntityStruct dbEntity = new DBEntityStruct {DBID = dbid};
+            uint num = PrefabsID.DBIDMAP[dbid];
+            GFXPrefabEntityStructGO gfx = new GFXPrefabEntityStructGO {prefabID = num};
+            BlockPlacementScaleEntityStruct placementScale = new BlockPlacementScaleEntityStruct
+            {
+                blockPlacementHeight = uscale, blockPlacementWidth = uscale, desiredScaleFactor = uscale,
+                snapGridScale = uscale,
+                unitSnapOffset = 0, isUsingUnitSize = true
+            };
+            EquippedColourStruct colour = new EquippedColourStruct {indexInPalette = color};
+            EGID egid2;
+            switch (category.category)
+            {
+                case CubeCategory.SpawnPoint:
+                case CubeCategory.BuildingSpawnPoint:
+                    egid2 = MachineEditingGroups.NewSpawnPointBlockID;
+                    break;
+                default:
+                    egid2 = MachineEditingGroups.NewBlockID;
+                    break;
+            }
+
+            int cubeId = PrefabsID.GenerateDBID((ushort) category.category, block);
+            EntityStructInitializer
+                structInitializer =
+                    _blockEntityFactory.Build(egid2, (uint) cubeId); //The ghost block index is only used for triggers
+            if (colour.indexInPalette != byte.MaxValue)
+                structInitializer.Init(new ColourParameterEntityStruct
+                {
+                    indexInPalette = colour.indexInPalette
+                });
+            structInitializer.Init(new GFXPrefabEntityStructGPUI(gfx.prefabID));
+            structInitializer.Init(new PhysicsPrefabEntityStruct(gfx.prefabID));
+            structInitializer.Init(dbEntity);
+            structInitializer.Init(new PositionEntityStruct {position = position});
+            structInitializer.Init(rotation);
+            structInitializer.Init(scaling);
+            structInitializer.Init(gridRotation);
+            structInitializer.Init(new UniformBlockScaleEntityStruct
+            {
+                scaleFactor = placementScale.desiredScaleFactor
+            });
+            return structInitializer;
+        }
+
+        public string Name { get; } = "Cube placer engine";
+
+        [HarmonyPatch]
+        [UsedImplicitly]
+        public class FactoryObtainerPatch
+        {
+            static void Postfix(BlockEntityFactory blockEntityFactory)
+            {
+                _blockEntityFactory = blockEntityFactory;
+                Debug.Log("Block entity factory injected.");
+            }
+
+            static MethodBase TargetMethod(HarmonyInstance instance)
+            {
+                return typeof(PlaceBlockEngine).GetConstructors()[0];
+            }
+        }
+    }
+}

GamecraftModdingAPI/Main.cs

@@ -61,6 +61,7 @@ namespace GamecraftModdingAPI
             Blocks.Movement.Init();
             Blocks.Rotation.Init();
             Blocks.Signals.Init();
+            Blocks.Placement.Init();
             Logging.MetaLog($"{currentAssembly.GetName().Name} v{currentAssembly.GetName().Version} initialized");
         }