More command examples

A5H73Y · Aug 9, 2023 · b5f19a8 · b5f19a8
1 parent 96c549c
commit b5f19a8
Show file tree

Hide file tree

Showing 8 changed files with 584 additions and 161 deletions.
diff --git a/docs/css/style.css b/docs/css/style.css
@@ -82,4 +82,8 @@ summary.deprecated {
     padding-top: 0;
 }
 
+.markdown-section ol, .markdown-section ul {
+    margin: 0;
+}
+
 
diff --git a/docs/files/parkourCommands.json b/docs/files/parkourCommands.json
diff --git a/docs/js/script.js b/docs/js/script.js
@@ -41,11 +41,11 @@ function appendData(data, elementId, markupCallback) {
 }
 
 function createCommandSummary(command) {
-    const yoyo = group[command.commandGroup];
+    const group = group[command.commandGroup];
     const styleClass = command.deprecated ? 'deprecated' : '';
     let result = `<details>
                     <summary class="${styleClass}">
-                        <strong>${command.command}</strong> - ${command.title} <em>${yoyo}</em>
+                        <strong>${command.command}</strong> - ${command.title} <em>${group || ''}</em>
                     </summary>
                     <div>
                         <table>
@@ -66,8 +66,8 @@ function createCommandSummary(command) {
                                     <td><code>/pa ${command.command} ${command.arguments || ''}</code></td>
                                 </tr>
                                 <tr>
-                                    <th scope="row">Example</th>
-                                    <td><code>${command.example}</code></td>
+                                    <th scope="row">Examples</th>
+                                    <td><ul>${command.examples.map(example => `<li><code>${example}</code></li>`).join(' ')}</ul></td>
                                 </tr>
                                 <tr>
                                     <th scope="row">Permission</th>

diff --git a/src/main/java/io/github/a5h73y/parkour/commands/CommandUsage.java b/src/main/java/io/github/a5h73y/parkour/commands/CommandUsage.java
@@ -4,6 +4,8 @@
 import static io.github.a5h73y.parkour.other.ParkourConstants.COMMAND_PLACEHOLDER;
 import static io.github.a5h73y.parkour.utility.permission.PermissionUtils.WILDCARD;
 
+import java.util.List;
+
 import io.github.a5h73y.parkour.utility.StringUtils;
 import io.github.a5h73y.parkour.utility.TranslationUtils;
 import org.bukkit.command.CommandSender;
@@ -24,7 +26,7 @@ public class CommandUsage {
 	private String command;
 	private String title;
 	private String arguments;
-	private String example;
+	private List<String> examples;
 	private String description;
 	private String permission;
 	private String commandGroup;
@@ -49,7 +51,10 @@ public void displayHelpInformation(CommandSender commandSender) {
 			String commandSyntax = arguments != null ? command + SPACE + arguments : command;
 			TranslationUtils.sendValueTranslation("Help.CommandSyntax", commandSyntax, false, commandSender);
 		}
-		TranslationUtils.sendValueTranslation("Help.CommandExample", example, false, commandSender);
+		if (getExamples() != null && !getExamples().isEmpty()) {
+			TranslationUtils.sendTranslation("Help.CommandExamples", false, commandSender);
+			getExamples().forEach(example -> commandSender.sendMessage("  " + example));
+		}
 		TranslationUtils.sendHeading("Description", commandSender);
 		commandSender.sendMessage(description);
 	}
@@ -97,8 +102,8 @@ public String getArguments() {
 		return arguments;
 	}
 
-	public String getExample() {
-		return example;
+	public List<String> getExamples() {
+		return examples;
 	}
 
 	public String getDescription() {

diff --git a/src/main/java/io/github/a5h73y/parkour/commands/ParkourAutoTabCompleter.java b/src/main/java/io/github/a5h73y/parkour/commands/ParkourAutoTabCompleter.java
@@ -125,7 +125,7 @@ private List<String> populateMainCommands(Player player) {
         }
 
         return parkour.getParkourCommands().getCommandUsages().stream()
-                .filter(commandUsage -> commandUsage.getExample() != null)
+                .filter(commandUsage -> commandUsage.getExamples() != null)
                 .filter(commandUsage -> commandUsage.getPermission() == null
                         || player.hasPermission(commandUsage.getPermission()))
                 .map(CommandUsage::getCommand)

diff --git a/src/main/java/io/github/a5h73y/parkour/configuration/impl/StringsConfig.java b/src/main/java/io/github/a5h73y/parkour/configuration/impl/StringsConfig.java
@@ -155,7 +155,7 @@ public StringsConfig(File file) {
 		this.setDefault("Help.SignCommands", "To display the sign commands menu, enter &b/pa cmds signs");
 		this.setDefault("Help.CommandSyntax", "&7Syntax: &f/pa %VALUE%");
 		this.setDefault("Help.ConsoleCommandSyntax", "&7Syntax: &f%VALUE%");
-		this.setDefault("Help.CommandExample", "&7Example: &f%VALUE%");
+		this.setDefault("Help.CommandExamples", "&7Examples:");
 		this.setDefault("Help.CommandUsage", "&3/pa &b%COMMAND%&e%ARGUMENTS% &0: &f%TITLE%");
 		this.setDefault("Help.SignUsage", "&b%COMMAND% &e%SHORTCUT% &0: &f%DESCRIPTION%");
 		this.setDefault("Help.DisplayValue", "%TITLE%: &b%VALUE%");

diff --git a/src/main/java/io/github/a5h73y/parkour/plugin/EconomyApi.java b/src/main/java/io/github/a5h73y/parkour/plugin/EconomyApi.java
@@ -8,6 +8,7 @@
 import static org.bukkit.Bukkit.getServer;
 
 import io.github.a5h73y.parkour.Parkour;
+import io.github.a5h73y.parkour.type.course.CourseConfig;
 import io.github.a5h73y.parkour.utility.PluginUtils;
 import io.github.a5h73y.parkour.utility.TranslationUtils;
 import io.github.a5h73y.parkour.utility.ValidationUtils;
@@ -278,9 +279,10 @@ private void processSetFeeCommand(CommandSender commandSender, String... args) {
 			return;
 		}
 
-		boolean value = args.length == 5 && args[4].equalsIgnoreCase("true") ? true : false;
-		parkour.getConfigManager().getCourseConfig(args[2]).setEconomyJoiningFee(Double.parseDouble(args[3]));
-		parkour.getConfigManager().getCourseConfig(args[2]).setEconomyOneTimeFee(value);
+		boolean oneTimeFee = args.length == 5 && args[4].equalsIgnoreCase("true");
+		CourseConfig config = parkour.getConfigManager().getCourseConfig(args[2]);
+		config.setEconomyJoiningFee(Double.parseDouble(args[3]));
+		config.setEconomyOneTimeFee(oneTimeFee);
 		TranslationUtils.sendPropertySet(commandSender, "Join Fee", args[2], args[3]);
 	}