feat: suggestion pages

Author: MC-XiaoHei

docs/en/create-commands/arguments/suggestions/async-suggestions.md

@@ -1,9 +1,11 @@
 ---
 order: 6
+title: Async suggestions
 authors:
   - DerEchtePilz
   - willkroboth
   - JorelAli
+  - MC-XiaoHei
 ---
 
 # Asynchronous suggestions
@@ -42,7 +44,6 @@ As with all asynchronous operations running in a Minecraft server, you should **
 
 ```java
 CompletableFuture.supplyAsync(() -> {
-
    Bukkit.getScheduler().scheduleAsyncDelayedTask(plugin, () -> 
        // Your code here
    );
@@ -66,13 +67,11 @@ We make use of the `ArgumentSuggestions.stringsAsync` method to provide asynchro
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:asyncSuggestions1}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/AsyncSuggestions.java#asyncSuggestionsExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:asyncSuggestions1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/AsyncSuggestions.kt#asyncSuggestionsExample
+===Kotlin DSL
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/AsyncSuggestions.kt#asyncSuggestionsExampleDSL
 :::
 
 ::::

docs/en/create-commands/arguments/suggestions/safe-suggestions.md

@@ -121,26 +121,18 @@ To do this, we first register our custom items:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions1}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#registerCustomItem
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#registerCustomItem
 :::
 
 Once we've done that, we can now include them in our command registration. To do this, we use `replaceSafeSuggestions(recipes)` and then register our command as normal:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions2}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#registerCommandWithSafeSuggestions
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions2}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#registerCommandWithSafeSuggestions
 :::
 
 ::::
@@ -157,44 +149,32 @@ Now say that we don't want non-op players to spawn bosses. To do this, we'll cre
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions3}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#createForbiddenMobsList
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions3}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#createForbiddenMobsList
 :::
 
 We then use our safe arguments to return an `EntityType[]` as the list of values that are suggested to the player. In this example, we use the `sender()` method to determine if the sender has permissions to view the suggestions:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions4}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#createSafeArguments
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions4}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#createSafeArguments
 :::
 
 Now we register our command as normal:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions5}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#registerSpawnMobCommand
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions5}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#registerSpawnMobCommand
 :::
 
 ::::
 
-:::: Example - Removing a potion effect from a player
+::::tip Example – Removing a potion effect from a player
 
 Say we wanted to remove a potion effect from a player. To do this, we'll use the following command syntax:
 
@@ -206,26 +186,18 @@ Now, we don't want to remove a potion effect that doesn't exist on a player, so
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions6}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#createSafePotionEffectArguments
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions6}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#createSafePotionEffectArguments
 :::
 
 And then we can register our command as normal:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:safeArgumentSuggestions7}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/SafeSuggestions.java#registerRemoveEffectCommand
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:safeArgumentSuggestions7}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/SafeSuggestions.kt#registerRemoveEffectCommand
 :::
 
 ::::

docs/en/create-commands/arguments/suggestions/string-suggestions.md

@@ -24,13 +24,9 @@ We then implement our warp teleporting command using `replaceSuggestions()` on t
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:stringArgumentSuggestions1}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/StringSuggestions.java#createWarpCommand
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:stringArgumentSuggestions1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/StringSuggestions.kt#createWarpCommand
 :::
 
 ::::
@@ -53,26 +49,18 @@ Let's say we have a simple class to get the friends of a command sender:
 
 :::tabs
 ===Java
-```java
-// todo public {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:stringArgumentSuggestions2}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/StringSuggestions.java#createFriendsClass
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:stringArgumentSuggestions2}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/StringSuggestions.kt#createFriendsClass
 :::
 
 We can then use this to generate our suggested list of friends:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:stringArgumentSuggestions3}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/StringSuggestions.java#createFriendCommand
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:stringArgumentSuggestions3}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/StringSuggestions.kt#createFriendCommand
 :::
 
 ::::
@@ -117,13 +105,9 @@ When run, this command will send a message to a target player within the provide
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:stringArgumentSuggestions4}}
-```
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/StringSuggestions.java#createLocalMessageCommand
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:stringArgumentSuggestions4}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/StringSuggestions.kt#createLocalMessageCommand
 :::
 
 As shown in this code, we use the `previousArgs()` method access the previously declared arguments. In this example, `info.previousArgs()` will be `{ int }`, where this `int` refers to the radius. Note how this object array only has the previously declared arguments (and not for example `{ int, Player, String }`).

docs/en/create-commands/arguments/suggestions/tooltips.md

@@ -50,18 +50,18 @@ First, we'll declare our arguments. Here, we'll use the `stringsWithTooltips` me
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#stringSuggestionTooltipsExampleDeclare
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#createArgumentsWithTooltips
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#stringSuggestionTooltipsExampleDeclare
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#createArgumentsWithTooltips
 :::
 
 Finally, we declare our command as normal:
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#stringSuggestionTooltipsExampleRegister
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#registerEmoteCommand
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#stringSuggestionTooltipsExampleRegister
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#registerEmoteCommand
 :::
 
 ::::
@@ -87,9 +87,9 @@ Let's say we've created a simple plugin which has custom items. For a custom ite
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#customTooltipExampleDeclare
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#createCustomItemClass
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#customTooltipExampleDeclare
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#createCustomItemClass
 :::
 
 We make use of the `Tooltip.messageFromString()` method to generate a Brigadier `Message` object from our string tooltip.
@@ -98,9 +98,9 @@ Let's also say that our plugin has registered lots of `CustomItem`s and has this
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#customTooltipExampleRegister
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#registerCustomItemCommand
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#customTooltipExampleRegister
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#registerCustomItemCommand
 :::
 
 ::::
@@ -144,18 +144,18 @@ First, we'll declare our arguments. Here, we use a `LocationArgument` and use th
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#tooltipsWithSafeSuggestionsExampleDeclare
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#createArgumentsWithTooltipsAndSafeSuggestions
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#tooltipsWithSafeSuggestionsExampleDeclare
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#createArgumentsWithTooltipsAndSafeSuggestions
 :::
 
 In the argument declaration, we've cast the command sender to a player. To ensure that the command sender is definitely a player, we'll use the `executesPlayer` command execution method in our command declaration:
 
 :::tabs
 ===Java
-<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#tooltipsWithSafeSuggestionsExampleRegister
+<<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#registerWarpCommand
 ===Kotlin
-<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#tooltipsWithSafeSuggestionsExampleRegister
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#registerWarpCommand
 :::
 
 ::::

reference-code/src/main/java/createcommands/arguments/suggestions/AsyncSuggestions.java

@@ -0,0 +1,32 @@
+package createcommands.arguments.suggestions;
+
+import dev.jorel.commandapi.CommandAPICommand;
+import dev.jorel.commandapi.arguments.ArgumentSuggestions;
+import dev.jorel.commandapi.arguments.StringArgument;
+import dev.jorel.commandapi.arguments.TextArgument;
+import org.bukkit.plugin.java.JavaPlugin;
+
+import java.util.concurrent.CompletableFuture;
+
+class AsyncSuggestions {
+    {
+        JavaPlugin plugin = null;
+        // #region asyncSuggestionsExample
+        new CommandAPICommand("setconfig")
+            .withArguments(new StringArgument("key")
+                .replaceSuggestions(ArgumentSuggestions.stringsAsync(info ->
+                    CompletableFuture.supplyAsync(() ->
+                        plugin.getConfig().getKeys(false).toArray(new String[0])
+                    )
+                ))
+            )
+            .withArguments(new TextArgument("value"))
+            .executes((sender, args) -> {
+                String key = (String) args.get("key");
+                String value = (String) args.get("value");
+                plugin.getConfig().set(key, value);
+            })
+            .register();
+        // #endregion asyncSuggestionsExample
+    }
+}