feat: code operation messages

Author: RedVortexDev

src/main/java/com/mcdiamondfire/proto/ModAPIMessages.java

@@ -38,8 +38,8 @@ public final class ModAPIMessages {
 		// Server-bound.
 
 		// Plot.
-		registerMessage(C2SGetTemplate.class, "c2s_get_template");
-		registerMessage(C2SPlaceTemplate.class, "c2s_place_template");
+		registerMessage(C2SCodeOperation.class, "c2s_code_operation");
+		registerMessage(C2SMultiCodeOperations.class, "c2s_multi_code_operations");
 
 		// Player.
 		registerMessage(C2SPlayerTeleport.class, "c2s_player_teleport");

src/main/proto/data_type.proto

@@ -24,3 +24,19 @@ enum PlayerMode {
 	VANISH = 5; // Mod vanish mode.
 	IDLE = 6; // Spawn (idle) mode.
 }
+
+// Represents a code template.
+message Template {
+	oneof template {
+		string json = 2; // The template JSON string.
+		string data = 3; // The template code data.
+	}
+}
+
+// Represents a line starter type.
+enum LineStarterType {
+	PLAYER_EVENT = 0; // A Player Event.
+	ENTITY_EVENT = 1; // An Entity Event.
+	FUNCTION = 2; // A Function.
+	PROCESS = 3; // A Process.
+}

src/main/proto/serverbound_plot.proto

@@ -4,23 +4,80 @@ import "data_type.proto";
 option java_package = "com.mcdiamondfire.proto.messages.serverbound.player";
 option java_multiple_files = true;
 
-// Requests the template at the given location,
+// Requests to get the template for the code block at the given location,
 // requires the player to have developer permissions on the plot,
-// and the location being a valid code block position.
-// An S2CCodeTemplate packet will be sent as a response.
-message C2SGetTemplate {
-	Location location = 1; // The location of the code block to get the template of.
+// and the location being a valid line starter.
+message GetByLocationOperation {
+	Location location = 1; // The location of the code block to get the template for.
+}
+
+// Requests to get the template for the code block with the given line starter type and action name,
+// requires the player to have developer permissions on the plot,
+// and that the code block exists.
+message GetByBlockOperation {
+	LineStarterType type = 1; // The type of line starter of the code block to get the template for.
+	string action = 2; // The sign action name of the code block to get the template for.
 }
 
 // Requests to place a template at the given location,
 // requires the player to have developer permissions on the plot,
-// the location being a valid code block position,
+// the location being a valid line starter,
 // and that the template will not override any blocks nor exit the plot bounds.
-// An S2CPlaceTemplateResult packet will be sent as a response.
-message C2SPlaceTemplate {
-	Location location = 1; // The location of the code block to place the template at.
-	oneof template {
-		string json = 2; // The template JSON string.
-		string data = 3; // The template code data.
+message PlaceOperation {
+	Location location = 1; // The location to place the template at.
+	Template template = 2; // The template to place.
+}
+
+// Requests to delete the code block at the given location,
+// requires the player to have developer permissions on the plot,
+// and the location being a valid line starter.
+message DeleteByLocationOperation {
+	Location location = 1; // The location of the code block to delete.
+}
+
+// Requests to delete the code block with the given line starter type and action name,
+// requires the player to have developer permissions on the plot,
+// and that the code block exists.
+message DeleteByBlockOperation {
+	LineStarterType type = 1; // The type of line starter of the code block to delete.
+	string action = 2; // The sign action name of the code block to delete.
+}
+
+// Requests to replace the code block at the given location with the given template,
+// requires the player to have developer permissions on the plot,
+// the location being a valid line starter,
+// and that the template will not override any blocks nor exit the plot bounds (except for the blocks being replaced).
+message ReplaceByLocationOperation {
+	Location location = 1; // The location of the code block to replace.
+	Template template = 2; // The template to replace the code block with.
+}
+
+// Requests to replace the code block with the given line starter type and action name with the given template,
+// requires the player to have developer permissions on the plot,
+// and that the code block exists,
+// and that the template will not override any blocks nor exit the plot bounds (except for the blocks being replaced).
+message ReplaceByBlockOperation {
+	LineStarterType type = 1; // The type of line starter of the code block to replace.
+	string action = 2; // The sign action name of the code block to replace.
+	Template template = 3; // The template to replace the code block with.
+}
+
+// Requests a code operation.
+// An S2CCodeOperationResult packet will be sent as a response, the relevant field will be set depending on the operation requested.
+message C2SCodeOperation {
+	oneof operation {
+		GetByLocationOperation get_by_location = 1; // The operation to get the template for the code block at the given location.
+		GetByBlockOperation get_by_block = 2; // The operation to get the template for the code block with the given line starter type and action name.
+		PlaceOperation place = 3; // The operation to place a template at the given location.
+		DeleteByLocationOperation delete_by_location = 4; // The operation to delete the code block at the given location.
+		DeleteByBlockOperation delete_by_block = 5; // The operation to delete the code block with the given line starter type and action name.
+		ReplaceByLocationOperation replace_by_location = 6; // The operation to replace the code block at the given location with the given template.
+		ReplaceByBlockOperation replace_by_block = 7; // The operation to replace the code block with the given line starter type and action name with the given template.
 	}
 }
+
+// Requests multiple code operations in one packet.
+// An S2CMultiCodeOperationResult packet will be sent as a response, containing the results of all operations requested.
+message C2SMultiCodeOperations {
+	repeated C2SCodeOperation operations = 1; // The operations to perform.
+}