added a command for marking a cell (for debugging purposes)

Author: Joachim Hofer

Scalatron/doc/markdown/Scalatron Protocol.md

@@ -244,7 +244,7 @@ to an empty string deletes it from the state.
 
 # Opcodes of Server-to-Plugin Commands
 
-These are the opcodes valid for commands sent by the server to a plug-in�s control function.
+These are the opcodes valid for commands sent by the server to a plug-in's control function.
 Only one opcode will be present per control function invocation.
 
 
@@ -333,7 +333,7 @@ Parameters:
 # Opcodes of Plugin-to-Server Commands
 
 These are the opcodes valid for commands returned by a plug-in to a server. Multiple such
-commands can be combined into a multi-command by separating them with a pipe (�|�) character.
+commands can be combined into a multi-command by separating them with a pipe ('|') character.
 
 ### Move(direction=int:int)
 
@@ -342,7 +342,7 @@ signed integers. The permitted range values are "-1", "0" or "1".
 
 Parameters:
 
-* `direction`   desired displacement for the move, e.g. �1:1� or �0:-1�
+* `direction`   desired displacement for the move, e.g. '1:1' or '0:-1'
 
 Example:
 
@@ -362,7 +362,7 @@ position, expressed relative to the current position.
 
 Parameters:
 
-* `direction`   desired displacement for the spawned mini-bot, e.g. �-1:1�
+* `direction`   desired displacement for the spawned mini-bot, e.g. '-1:1'
 * `name`        arbitrary string, except the following characters are
                 not permitted: '|', ',', '=', '('
 * `energy`      energy budget to transfer to the spawned mini-bot (minimum: 100 EU)
@@ -473,6 +473,22 @@ Energy Cost/Permissions:
 
 
 
+### MarkCell(position=int:int,color=string)
+
+Displays a cell as marked. You can use this as a debugging tool.
+
+Parameters:
+
+* `position`  desired displacement relative to the current bot, e.g. '-2:4' (defaults to '0:0')
+* `color`     color to use for marking the cell (defaults to '#8888ff'), e.g. '#ff8800'
+
+Energy Cost/Permissions:
+
+* for master bot:   permitted, no energy consumed
+* for mini-bot:     permitted, no energy consumed
+
+
+
 ### Log(text=string)
 
 Shortcut for setting the state property `debug`, which by convention contains an optional

Scalatron/src/scalatron/botwar/AugmentedDynamics.scala

@@ -302,6 +302,9 @@ case object AugmentedDynamics extends ((State,Random,Iterable[(Entity.Id,Iterabl
                             throw new IllegalStateException("Explode() command is illegal for non-player bots")
                     }
 
+                case markedCell: Command.MarkCell =>           // "MarkCell(position=x:y,color=#ff0000)"
+                    updatedBoard = updatedBoard.addDecoration(thisBotPos + markedCell.pos, time, Decoration.MarkedCell(markedCell.color))
+
                 case _ =>
                     // unknown command!
                     throw new IllegalStateException("unknown command: " + command)

Scalatron/src/scalatron/botwar/Command.scala

@@ -45,7 +45,11 @@ object Command
         def opcode = Protocol.PluginOpcode.Set
         def paramMap = map
     }
-
+    case class MarkCell(pos: XY, color: String) extends Command {
+        def opcode = Protocol.PluginOpcode.MarkCell
+        def paramMap = Map(Protocol.PluginOpcode.ParameterName.Position -> pos, Protocol.PluginOpcode.ParameterName.Color -> color)
+    }
+    
     def fromControlFunctionResponse(controlFunctionResponse: String): Iterable[Command] = {
         val commandMap = MultiCommandParser.splitStringIntoParsedCommandMap(controlFunctionResponse)
         if(commandMap.isEmpty)
@@ -83,6 +87,11 @@ object Command
         case Protocol.PluginOpcode.Log =>            // "Log(text=<string>)"
             Log(params.get(Protocol.PluginOpcode.ParameterName.Text).getOrElse(""))
 
+        case Protocol.PluginOpcode.MarkCell =>       // "MarkCell(position=x:y,color=#ff0000)"
+            MarkCell(
+                params.get(Protocol.PluginOpcode.ParameterName.Position).map(s => XY(s)).getOrElse( XY.Zero),
+                params.get(Protocol.PluginOpcode.ParameterName.Color).getOrElse("#8888ff")) // default to a light blue
+                
         case _ =>
             throw new IllegalStateException("unknown opcode: '" + opcode + "'")
     }

Scalatron/src/scalatron/botwar/Entity.scala

@@ -318,6 +318,7 @@ object Decoration {
     case object Bonk extends Variety { def lifeTime = 40 }
     case object Annihilation extends Variety { def lifeTime = 40 }
     case class Text(text: String) extends Variety { def lifeTime = 40 }
+    case class MarkedCell(color: String) extends Variety { def lifeTime = 40 }
 }
 
 

Scalatron/src/scalatron/botwar/Protocol.scala

@@ -23,11 +23,14 @@ object Protocol {
         val Set = "Set"
         val Explode = "Explode"
         val Log = "Log"
+        val MarkCell = "MarkCell"
 
         object ParameterName {
             val Direction = "direction"
             val Text = "text"
             val BlastRadius = "size"
+            val Position = "position"
+            val Color = "color"
         }
     }
 

Scalatron/src/scalatron/botwar/renderer/GameStateRenderer.scala

@@ -219,6 +219,13 @@ object GameStateRenderer {
                     val color = makeTransparent(AnnihilationColor, alpha)
                     ctx.setColor(color)
                     ctx.drawOval(centerX - age, centerY - age, age * 2, age * 2)
+                
+                case markedCell: Decoration.MarkedCell =>
+                    println("rendering marked cell: " + markedCell.color)
+                    val color = makeTransparent(Color.decode(markedCell.color), alpha)
+                    ctx.setColor(color)
+                    val radius = ctx.pixelsPerCell / 2
+                    ctx.fillOval(centerX - radius, centerY - radius, radius * 2, radius * 2)
 
                 case _ => // OK
             }