Improved the help messages for /uh spawns generate.

Author: AmauryCarrade

src/main/java/me/azenet/UHPlugin/UHPluginCommand.java

@@ -667,8 +667,24 @@ else if(subcommand.equalsIgnoreCase("dump")) { // /uh spawns dump
 			else if(subcommand.equalsIgnoreCase("generate")) { // /uh spawns generate
 				// Usage: /uh spawns generate <circular|squared|random> [size = current size of the map] [distanceMin = 250] [count = number of teams registered] [xCenter = xSpawn] [zCenter = zSpawn] [world = sender's world]
 
-				if(args.length < 3) { // No enough arguments.
-					sender.sendMessage(i.t("spawns.syntaxError"));
+				if(args.length < 3) { // Documentation
+					displaySeparator(sender);
+					sender.sendMessage(i.t("cmd.titleHelp", p.getDescription().getDescription(), p.getDescription().getVersion()));
+					sender.sendMessage(i.t("cmd.legendHelp"));
+					
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsCmd"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsShapesTitle"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsShapesRandom"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsShapesGrid"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsShapesCircular"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsTitle"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsSize"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsDistanceMin"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsCount"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsCenter"));
+					sender.sendMessage(i.t("cmd.spawnsHelpGenerateDetailsArgsWorld"));
+					
+					displaySeparator(sender);
 					return;
 				}
 

src/main/resources/i18n/en_US.yml

@@ -72,7 +72,18 @@ keys:
         spawnsHelpTitle: "{aqua}------ Spawns points commands ------"
         spawnsHelpAdd: "{cc}/uh spawns add {ci}: adds a spawn point for a team or a player, at the current location of the sender."
         spawnsHelpAddXZ: "{cc}/uh spawns add <x> <z> {ci}: adds a spawn point for a team or a player, at the provided coordinates, in the default world."
-        spawnsHelpGenerate: "{cc}/uh spawns generate <circular|grid|random> [size = current size] [distanceMin = 250] [count = teams count] [xCenter = xSpawn] [zCenter = zSpawn] [world = sender's world] {ci}: automagically generates the spawn points following the given shape."
+        spawnsHelpGenerate: "{cc}/uh spawns generate {ci}: automagically generates spawn points. See /uh spawns generate for details."
+        spawnsHelpGenerateDetailsCmd: "{cc}/uh spawns generate <circular|grid|random> [size] [distanceMin] [count] [xCenter] [zCenter] [world]"
+        spawnsHelpGenerateDetailsShapesTitle: "{aqua}Shapes"
+        spawnsHelpGenerateDetailsShapesRandom: " - {cc}random{ci}: generates random spawn points on the map, with a minimal distance between them."
+        spawnsHelpGenerateDetailsShapesGrid: " - {cc}grid{ci}: generates the spawn points on concentric squares, with a constant distance between two generated points."
+        spawnsHelpGenerateDetailsShapesCircular: " - {cc}circular{ci}: generates the spawn points on concentric circles, with a minimal distance between two generated points. In each circle, the angle (and the distance) between two spawn points is constant."
+        spawnsHelpGenerateDetailsArgsTitle: "{aqua}Arguments"
+        spawnsHelpGenerateDetailsArgsSize: " - {cc}size{ci}: the size of the region where the spawn points will be generated. Squared or circular, following the shape of the map. Default: map' size."
+        spawnsHelpGenerateDetailsArgsDistanceMin: " - {cc}distanceMin{ci}: the minimal distance between two spawn points. Default: 250 blocks."
+        spawnsHelpGenerateDetailsArgsCount: " - {cc}count{ci}: the number of spawn points to generate. Default: the number of players or teams."
+        spawnsHelpGenerateDetailsArgsCenter: " - {cc}xCenter{ci}, {cc}zCenter{ci}: the center of the region where the points are generated. Default: world' spawn point."
+        spawnsHelpGenerateDetailsArgsWorld: " - {cc}world{ci}: the world where the spawn points will be generated."
         spawnsHelpList: "{cc}/uh spawns list {ci}: lists the registered spawn points."
         spawnsHelpDump: "{cc}/uh spawns dump {ci}: displays the registered spawn points in an exportable format. {gray}Use this to plot the spawn points, as example."
         spawnsHelpRemove: "{cc}/uh spawns remove [<x> <z>] {ci}: removes the spawn points at the specified coordinates, or at the current location if the sender without coordinates."

src/main/resources/i18n/fr_FR.yml

@@ -72,7 +72,18 @@ keys:
         spawnsHelpTitle: "{aqua}------ Commandes de gestion des points de démarrage ------"
         spawnsHelpAdd: "{cc}/uh spawns add {ci}: ajoute un point de démarrage à la position de l'exécutant."
         spawnsHelpAddXZ: "{cc}/uh spawns add <x> <z> {ci}: ajoute un point de démarrage aux coordonnées données, dans le monde principal."
-        spawnsHelpGenerate: "{cc}/uh spawns generate <circular|grid|random> [taille = taille actuelle] [distanceMin = 250] [nombre = nombre d'équipes] [xCentre = xSpawn] [zCentre = zSpawn] [monde = monde de l'envoyeur] {ci}: génère automagiquement des points de démarrage selon la forme donnée."
+        spawnsHelpGenerate: "{cc}/uh spawns generate {ci}: génère automatiquement des points de démarrage. Consultez /uh spawns generate pour plus de détails."
+        spawnsHelpGenerateDetailsCmd: "{cc}/uh spawns generate <circular|grid|random> [taille] [distanceMin] [nombre] [xCentre] [zCentre] [monde]"
+        spawnsHelpGenerateDetailsShapesTitle: "{aqua}Formes"
+        spawnsHelpGenerateDetailsShapesRandom: " - {cc}random{ci} : génère des points aléatoirement sur la carte, avec une distance minimale entre eux."
+        spawnsHelpGenerateDetailsShapesGrid: " - {cc}grid{ci} : génère les points sur des carrés concentriques, en commençant par le plus grand. La distance entre deux points est constante."
+        spawnsHelpGenerateDetailsShapesCircular: " - {cc}circular{ci}: génère les points sur des cercles concentriques, avec une distance minimale entre deux points. Sur chaque cercle, l'angle (et donc la distance) entre deux points est constant."
+        spawnsHelpGenerateDetailsArgsTitle: "{aqua}Arguments"
+        spawnsHelpGenerateDetailsArgsSize: " - {cc}taille{ci} : la taille de la région dans laquelle les points vont être générés. La région est carrée ou circulaire, selon la configuration. Par défaut : la taille de la carte."
+        spawnsHelpGenerateDetailsArgsDistanceMin: " - {cc}distanceMin{ci} : la distance minimale entre deux points. Par défaut : 250 blocs."
+        spawnsHelpGenerateDetailsArgsCount: " - {cc}nombre{ci} : le nombre de points à générer. Par défaut : le nombre de joueurs ou d'équipes."
+        spawnsHelpGenerateDetailsArgsCenter: " - {cc}xCentre{ci}, {cc}zCentre{ci} : le centre de la région dans laquelle les points sont générés. Par défaut : le point d'apparition du monde."
+        spawnsHelpGenerateDetailsArgsWorld: " - {cc}monde{ci} : le monde dans lequel les points seront générés."
         spawnsHelpList: "{cc}/uh spawns list {ci}: liste les points de démarrage enregistrés."
         spawnsHelpDump: "{cc}/uh spawns dump {ci}: affiche les points de démarrage dans un format exportable. {gray}Utilisez ceci pour afficher les points sur un graph, par exemple."
         spawnsHelpRemove: "{cc}/uh spawns remove [<x> <z>] {ci}: supprime les points de démarrage aux coordonnées spécifiées, ou à la position de l'envoyeur sans coordonnées."