Commands can now return Message. Removed newLine field from Message, Message static functions for quick creation.

Author: Mpcs

engine/src/main/java/org/destinationsol/game/console/AbstractCommand.java

@@ -213,7 +213,7 @@ private Object[] processParametersMethod(List<String> rawParameters) throws Comm
     }
 
     @Override
-    public final String execute(List<String> rawParameters) throws CommandExecutionException {
+    public final Object execute(List<String> rawParameters) throws CommandExecutionException {
         Object[] processedParameters;
 
         try {
@@ -226,13 +226,13 @@ public final String execute(List<String> rawParameters) throws CommandExecutionE
                 warning += ": " + message;
             }
 
-            return warning;
+            return Message.WARN(warning);
         }
 
         try {
             Object result = executionMethod.getAccessibleObject().invoke(executionMethod.getTarget(), processedParameters);
 
-            return result != null ? String.valueOf(result) : null;
+            return result != null ? result : null;
         } catch (InvocationTargetException t) {
             if (t.getCause() != null) {
                 throw new CommandExecutionException(t.getCause()); //Skip InvocationTargetException

engine/src/main/java/org/destinationsol/game/console/Console.java

@@ -52,23 +52,6 @@ public interface Console {
      */
     void addMessage(Message message);
 
-    /**
-     * Adds a message to the console (as a CoreMessageType.CONSOLE message)
-     *
-     * @param message The message to be added, as a string.
-     * @param newLine A boolean: True causes a newline character to be appended at the end of the message. False doesn't.
-     */
-    void addMessage(String message, boolean newLine);
-
-    /**
-     * Adds a message to the console (as a CoreMessageType.CONSOLE message)
-     *
-     * @param message The message to be added, as a string.
-     * @param type    The type of the message
-     * @param newLine A boolean: True causes a newline character to be appended at the end of the message. False doesn't.
-     */
-    void addMessage(String message, MessageType type, boolean newLine);
-
     /**
      * @return An iterator over all messages in the console
      */

engine/src/main/java/org/destinationsol/game/console/ConsoleCommand.java

@@ -95,7 +95,7 @@ public int compare(ConsoleCommand o1, ConsoleCommand o2) {
      * @param parameters Parameters in an Object[] array as defined in {@link AbstractCommand#getCommandParameters()}.
      * @return A reply to the sender. TODO
      */
-    String execute(List<String> parameters) throws CommandExecutionException;
+    Object execute(List<String> parameters) throws CommandExecutionException;
 
     /**
      * Suggests valid parameters.

engine/src/main/java/org/destinationsol/game/console/ConsoleImpl.java

@@ -22,6 +22,7 @@
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 import org.destinationsol.game.SolGame;
+import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.RegisterCommands;
 import org.destinationsol.game.console.exceptions.CommandExecutionException;
 import org.destinationsol.game.context.Context;
@@ -155,24 +156,7 @@ private void addErrorMessage(String message) {
      * Adds a message to the console
      *
      * @param message The message to be added, as a string.
-     * @param newLine A boolean: True causes a newline character to be appended at the end of the message. False doesn't.
      */
-    @Override
-    public void addMessage(String message, boolean newLine) {
-        addMessage(new Message(message, newLine));
-    }
-
-    /**
-     * Adds a message to the console
-     *
-     * @param message The message to be added, as a string.
-     * @param type    The type of the message
-     * @param newLine A boolean: True causes a newline character to be appended at the end of the message. False doesn't.
-     */
-    @Override
-    public void addMessage(String message, MessageType type, boolean newLine) {
-        addMessage(new Message(message, type, newLine));
-    }
 
     /**
      * Adds a message to the console
@@ -189,7 +173,7 @@ public void addMessage(Message message) {
         //check for newlines and split into submessages
         if (message.getMessage().indexOf(NEW_LINE) > 0) {
             for (String line : message.getMessage().split(NEW_LINE)) {
-                newlinedMessages.add(new Message(line, message.getType(), false));
+                newlinedMessages.add(new Message(line, message.getType()));
             }
         } else {
             newlinedMessages.add(message);
@@ -206,13 +190,13 @@ public void addMessage(Message message) {
                 messageWidth += charWidth;
                 fittingMessageText.append(c);
                 if (messageWidth > MAX_WIDTH_OF_LINE) {
-                    Message newMessage = new Message(fittingMessageText.toString(), message.getType(), message.hasNewLine());
+                    Message newMessage = new Message(fittingMessageText.toString(), message.getType());
                     messageHistory.add(newMessage);
                     fittingMessageText = new StringBuilder();
                     messageWidth = 0;
                 }
             }
-            Message newMessage = new Message(fittingMessageText.toString(), message.getType(), message.hasNewLine());
+            Message newMessage = new Message(fittingMessageText.toString(), message.getType());
             messageHistory.add(newMessage);
         }
 
@@ -313,8 +297,16 @@ public boolean execute(String commandName, List<String> params) {
         }
 
         try {
-            String result = cmd.execute(params);
-            this.addMessage(result);
+            Object result = cmd.execute(params);
+            if (result == null) {
+                return true;
+            }
+            if (result instanceof Message) {
+                Message message = (Message)result;
+                this.addMessage(message.getMessage(), message.getType());
+            } else if (result instanceof String) {
+                this.addMessage(result.toString());
+            }
         } catch (CommandExecutionException e) {
             e.printStackTrace();
         }

engine/src/main/java/org/destinationsol/game/console/Message.java

@@ -19,30 +19,15 @@ public class Message {
 
     private final MessageType type;
     private final String message;
-    private final boolean newLine;
 
     public Message(String message) {
         this.message = message;
         this.type = CoreMessageType.INFO;
-        this.newLine = true;
     }
 
     public Message(String message, MessageType type) {
         this.message = message;
         this.type = type;
-        this.newLine = true;
-    }
-
-    public Message(String message, MessageType type, boolean newLine) {
-        this.message = message;
-        this.type = type;
-        this.newLine = newLine;
-    }
-
-    public Message(String message, boolean newLine) {
-        this.message = message;
-        this.type = CoreMessageType.INFO;
-        this.newLine = newLine;
     }
 
     public String getMessage() {
@@ -53,12 +38,20 @@ public MessageType getType() {
         return type;
     }
 
-    public boolean hasNewLine() {
-        return newLine;
-    }
-
     @Override
     public String toString() {
         return String.format("[%s] '%s'", type, message);
     }
+
+    public static Message SUCCESS(String status) {
+        return new Message(status, CoreMessageType.INFO);
+    }
+
+    public static Message FAILURE(String status) {
+        return new Message(status, CoreMessageType.ERROR);
+    }
+
+    public static Message WARN(String status) {
+        return new Message(status, CoreMessageType.WARN);
+    }
 }

engine/src/main/java/org/destinationsol/game/console/commands/ChangeShipCommandHandler.java

@@ -17,6 +17,7 @@
 
 import org.destinationsol.game.Hero;
 import org.destinationsol.game.SolGame;
+import org.destinationsol.game.console.Message;
 import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.CommandParam;
 import org.destinationsol.game.console.annotations.Game;
@@ -34,10 +35,10 @@
 public class ChangeShipCommandHandler {
 
     @Command(shortDescription = "changes hero ship")
-    public String changeShip(@Game SolGame game, @CommandParam(value = "newShip", suggester = HullConfigSuggester.class) HullConfig hullConfig) {
+    public Message changeShip(@Game SolGame game, @CommandParam(value = "newShip", suggester = HullConfigSuggester.class) HullConfig hullConfig) {
 
         if (hullConfig == null) {
-            return "Could not find such ship";
+            return Message.FAILURE("Could not find such ship");
         }
 
         Hero hero = game.getHero();
@@ -47,7 +48,7 @@ public String changeShip(@Game SolGame game, @CommandParam(value = "newShip", su
         game.getObjectManager().removeObjDelayed(hero.getShip());
         game.getObjectManager().addObjDelayed(newShip);
         hero.setSolShip(newShip, game);
-        return "Ship changed";
+        return Message.SUCCESS("Ship changed");
     }
 
 

engine/src/main/java/org/destinationsol/game/console/commands/DieCommandHandler.java

@@ -18,6 +18,7 @@
 import org.destinationsol.game.DmgType;
 import org.destinationsol.game.Hero;
 import org.destinationsol.game.SolGame;
+import org.destinationsol.game.console.Message;
 import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.Game;
 import org.destinationsol.game.console.annotations.RegisterCommands;
@@ -29,15 +30,15 @@
 public class DieCommandHandler {
 
     @Command(shortDescription = "Kills the hero")
-    public String die(@Game SolGame game) {
+    public Message die(@Game SolGame game) {
         Hero hero = game.getHero();
         if (hero.isTranscendent()) {
-            return "Cannot kill hero when transcendent!";
+            return Message.FAILURE("Cannot kill hero when transcendent!");
         }
         if (!hero.isAlive()) {
-            return "Hero is already dead!";
+            return Message.FAILURE("Hero is already dead!");
         }
         hero.getShip().receivePiercingDmg(hero.getHull().getHullConfig().getMaxLife() + 1f, game, hero.getPosition(), DmgType.CRASH);
-        return "Hero killed!";
+        return Message.SUCCESS("Hero killed!");
     }
 }

engine/src/main/java/org/destinationsol/game/console/commands/InvincibleCommandHandler.java

@@ -17,6 +17,7 @@
 
 import org.destinationsol.game.Hero;
 import org.destinationsol.game.SolGame;
+import org.destinationsol.game.console.Message;
 import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.Game;
 import org.destinationsol.game.console.annotations.RegisterCommands;
@@ -28,20 +29,20 @@
 public class InvincibleCommandHandler {
 
     @Command(shortDescription = "Makes the hero invincible")
-    public String godMode(@Game SolGame game) {
+    public Message godMode(@Game SolGame game) {
         Hero hero = game.getHero();
         if (hero.isDead()) {
-            return "Cannot make invincible when dead";
+            return Message.FAILURE("Cannot make invincible when dead");
         }
         if (hero.isTranscendent()) {
-            return "Cannot make invincible when transdencent";
+            return Message.FAILURE("Cannot make invincible when transdencent");
         }
         if (!hero.isInvincible()) {
             hero.setInvincible(true);
-            return "Set player as invincible";
+            return Message.SUCCESS("Set player as invincible");
         } else {
             hero.setInvincible(false);
-            return "Set player as non invincible";
+            return Message.SUCCESS("Set player as non invincible");
         }
     }
 }

engine/src/main/java/org/destinationsol/game/console/commands/RespawnCommandHandler.java

@@ -17,6 +17,7 @@
 
 import org.destinationsol.game.Hero;
 import org.destinationsol.game.SolGame;
+import org.destinationsol.game.console.Message;
 import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.Game;
 import org.destinationsol.game.console.annotations.RegisterCommands;
@@ -28,12 +29,12 @@
 public class RespawnCommandHandler {
 
     @Command(shortDescription = "Respawns player if dead")
-    public String respawn(@Game SolGame game) {
+    public Message respawn(@Game SolGame game) {
         Hero hero = game.getHero();
         if (hero.isAlive()) {
-            return "Cannot respawn hero when not dead!";
+            return Message.FAILURE("Cannot respawn hero when not dead!");
         }
         game.respawn();
-        return "Hero respawned!";
+        return Message.SUCCESS("Hero respawned!");
     }
 }