Command now can return only String or void. Commands can now throw CommandExecutionErrors, displayed in red in console

Mpcs · NicholasBatesNZ · commit 171cd791a882 · 2020-02-11T13:10:02.000+13:00
diff --git a/engine/src/main/java/org/destinationsol/game/console/AbstractCommand.java b/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 Object execute(List<String> rawParameters) throws CommandExecutionException {
+    public final String execute(List<String> rawParameters) throws CommandExecutionException {
         Object[] processedParameters;
 
         try {
@@ -226,13 +226,13 @@ public final Object execute(List<String> rawParameters) throws CommandExecutionE
                 warning += ": " + message;
             }
 
-            return Message.WARN(warning);
+            return warning;
         }
 
         try {
             Object result = executionMethod.getAccessibleObject().invoke(executionMethod.getTarget(), processedParameters);
 
-            return result != null ? result : null;
+            return result != null ? String.valueOf(result) : null;
         } catch (InvocationTargetException t) {
             if (t.getCause() != null) {
                 throw new CommandExecutionException(t.getCause()); //Skip InvocationTargetException
diff --git a/engine/src/main/java/org/destinationsol/game/console/ConsoleCommand.java b/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
      */
-    Object execute(List<String> parameters) throws CommandExecutionException;
+    String execute(List<String> parameters) throws CommandExecutionException;
 
     /**
      * Suggests valid parameters.
diff --git a/engine/src/main/java/org/destinationsol/game/console/ConsoleImpl.java b/engine/src/main/java/org/destinationsol/game/console/ConsoleImpl.java
@@ -16,6 +16,7 @@
 package org.destinationsol.game.console;
 
 import com.badlogic.gdx.graphics.g2d.BitmapFont;
+import com.google.common.base.Strings;
 import com.google.common.collect.Collections2;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Lists;
@@ -297,21 +298,30 @@ public boolean execute(String commandName, List<String> params) {
         }
 
         try {
-            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());
+            String result = cmd.execute(params);
+            if (result != null) {
+                this.addMessage(result);
             }
+            return true;
         } catch (CommandExecutionException e) {
-            e.printStackTrace();
-        }
+            Throwable cause = e.getCause();
+            String causeMessage;
+            if (cause != null) {
+                causeMessage = cause.getLocalizedMessage();
+                if (Strings.isNullOrEmpty(causeMessage)) {
+                    causeMessage = cause.toString();
+                }
+            } else {
+                causeMessage = e.getLocalizedMessage();
+            }
 
-        return true;
+            logger.error("An error occurred while executing a command '" + cmd.getName() + "' : " + e.getMessage(), CoreMessageType.ERROR);
+
+            if (!Strings.isNullOrEmpty(causeMessage)) {
+                this.addMessage(new Message("Error: " + causeMessage));
+            }
+            return false;
+        }
     }
 
     @Override
diff --git a/engine/src/main/java/org/destinationsol/game/console/commands/ChangeShipCommandHandler.java b/engine/src/main/java/org/destinationsol/game/console/commands/ChangeShipCommandHandler.java
@@ -17,11 +17,11 @@
 
 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;
 import org.destinationsol.game.console.annotations.RegisterCommands;
+import org.destinationsol.game.console.exceptions.CommandExecutionException;
 import org.destinationsol.game.console.suggesters.HullConfigSuggester;
 import org.destinationsol.game.ship.ShipRepairer;
 import org.destinationsol.game.ship.SolShip;
@@ -35,10 +35,10 @@
 public class ChangeShipCommandHandler {
 
     @Command(shortDescription = "changes hero ship")
-    public Message changeShip(@Game SolGame game, @CommandParam(value = "newShip", suggester = HullConfigSuggester.class) HullConfig hullConfig) {
+    public String changeShip(@Game SolGame game, @CommandParam(value = "newShip", suggester = HullConfigSuggester.class) HullConfig hullConfig) throws CommandExecutionException {
 
         if (hullConfig == null) {
-            return Message.FAILURE("Could not find such ship");
+            throw new CommandExecutionException("Could not find such ship");
         }
 
         Hero hero = game.getHero();
@@ -48,7 +48,7 @@ public Message changeShip(@Game SolGame game, @CommandParam(value = "newShip", s
         game.getObjectManager().removeObjDelayed(hero.getShip());
         game.getObjectManager().addObjDelayed(newShip);
         hero.setSolShip(newShip, game);
-        return Message.SUCCESS("Ship changed");
+        return "Ship changed";
     }
 
 
diff --git a/engine/src/main/java/org/destinationsol/game/console/commands/DieCommandHandler.java b/engine/src/main/java/org/destinationsol/game/console/commands/DieCommandHandler.java
@@ -18,10 +18,10 @@
 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;
+import org.destinationsol.game.console.exceptions.CommandExecutionException;
 
 /**
  * A command used to instantly destroy the hero's ship, mostly for debugging purposes.
@@ -30,15 +30,15 @@
 public class DieCommandHandler {
 
     @Command(shortDescription = "Kills the hero")
-    public Message die(@Game SolGame game) {
+    public String die(@Game SolGame game) throws CommandExecutionException {
         Hero hero = game.getHero();
         if (hero.isTranscendent()) {
-            return Message.FAILURE("Cannot kill hero when transcendent!");
+            throw new CommandExecutionException("Cannot kill hero when transcendent!");
         }
         if (!hero.isAlive()) {
-            return Message.FAILURE("Hero is already dead!");
+            throw new CommandExecutionException("Hero is already dead!");
         }
         hero.getShip().receivePiercingDmg(hero.getHull().getHullConfig().getMaxLife() + 1f, game, hero.getPosition(), DmgType.CRASH);
-        return Message.SUCCESS("Hero killed!");
+        return "Hero killed!";
     }
 }
diff --git a/engine/src/main/java/org/destinationsol/game/console/commands/HelpCommandHandler.java b/engine/src/main/java/org/destinationsol/game/console/commands/HelpCommandHandler.java
@@ -18,7 +18,6 @@
 import com.google.common.collect.Ordering;
 import org.destinationsol.game.SolGame;
 import org.destinationsol.game.console.Console;
-import org.destinationsol.game.console.ConsoleColors;
 import org.destinationsol.game.console.ConsoleCommand;
 import org.destinationsol.game.console.annotations.Command;
 import org.destinationsol.game.console.annotations.CommandParam;
diff --git a/engine/src/main/java/org/destinationsol/game/console/commands/InvincibleCommandHandler.java b/engine/src/main/java/org/destinationsol/game/console/commands/InvincibleCommandHandler.java
@@ -17,10 +17,10 @@
 
 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;
+import org.destinationsol.game.console.exceptions.CommandExecutionException;
 
 /**
  * A command used to make player invincible
@@ -29,20 +29,20 @@
 public class InvincibleCommandHandler {
 
     @Command(shortDescription = "Makes the hero invincible")
-    public Message godMode(@Game SolGame game) {
+    public String godMode(@Game SolGame game) throws CommandExecutionException {
         Hero hero = game.getHero();
         if (hero.isDead()) {
-            return Message.FAILURE("Cannot make invincible when dead");
+            throw new IllegalArgumentException("Cannot make invincible when dead");
         }
         if (hero.isTranscendent()) {
-            return Message.FAILURE("Cannot make invincible when transdencent");
+            throw new IllegalArgumentException("Cannot make invincible when transdencent");
         }
         if (!hero.isInvincible()) {
             hero.setInvincible(true);
-            return Message.SUCCESS("Set player as invincible");
+            return "Set player as invincible";
         } else {
             hero.setInvincible(false);
-            return Message.SUCCESS("Set player as non invincible");
+            return "Set player as non invincible";
         }
     }
 }
diff --git a/engine/src/main/java/org/destinationsol/game/console/commands/RespawnCommandHandler.java b/engine/src/main/java/org/destinationsol/game/console/commands/RespawnCommandHandler.java
@@ -17,10 +17,10 @@
 
 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;
+import org.destinationsol.game.console.exceptions.CommandExecutionException;
 
 /**
  * A command used to respawn player's ship
@@ -29,12 +29,12 @@
 public class RespawnCommandHandler {
 
     @Command(shortDescription = "Respawns player if dead")
-    public Message respawn(@Game SolGame game) {
+    public String respawn(@Game SolGame game) throws CommandExecutionException {
         Hero hero = game.getHero();
         if (hero.isAlive()) {
-            return Message.FAILURE("Cannot respawn hero when not dead!");
+            throw new CommandExecutionException("Cannot respawn hero when not dead!");
         }
         game.respawn();
-        return Message.SUCCESS("Hero respawned!");
+        return "Hero respawned!";
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ private Object[] processParametersMethod(List<String> rawParameters) throws Comm`
`213`	`213`	`}`
`214`	`214`
`215`	`215`	`@Override`
`216`		`- public final Object execute(List<String> rawParameters) throws CommandExecutionException {`
	`216`	`+ public final String execute(List<String> rawParameters) throws CommandExecutionException {`
`217`	`217`	`Object[] processedParameters;`
`218`	`218`
`219`	`219`	`try {`
`@@ -226,13 +226,13 @@ public final Object execute(List<String> rawParameters) throws CommandExecutionE`
`226`	`226`	`warning += ": " + message;`
`227`	`227`	`}`
`228`	`228`
`229`		`- return Message.WARN(warning);`
	`229`	`+ return warning;`
`230`	`230`	`}`
`231`	`231`
`232`	`232`	`try {`
`233`	`233`	`Object result = executionMethod.getAccessibleObject().invoke(executionMethod.getTarget(), processedParameters);`
`234`	`234`
`235`		`- return result != null ? result : null;`
	`235`	`+ return result != null ? String.valueOf(result) : null;`
`236`	`236`	`} catch (InvocationTargetException t) {`
`237`	`237`	`if (t.getCause() != null) {`
`238`	`238`	`throw new CommandExecutionException(t.getCause()); //Skip InvocationTargetException`