feat: add kotlin source, finish code ref in tooltips.md

MC-XiaoHei · MC-XiaoHei · commit cf035d049708 · 2024-11-24T13:47:13.000+08:00
diff --git a/docs/en/create-commands/arguments/suggestions/tooltips.md b/docs/en/create-commands/arguments/suggestions/tooltips.md
@@ -52,9 +52,7 @@ First, we'll declare our arguments. Here, we'll use the `stringsWithTooltips` me
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#stringSuggestionTooltipsExampleDeclare
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#stringSuggestionTooltipsExampleDeclare
 :::
 
 Finally, we declare our command as normal:
@@ -63,9 +61,7 @@ Finally, we declare our command as normal:
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#stringSuggestionTooltipsExampleRegister
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips2}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#stringSuggestionTooltipsExampleRegister
 :::
 
 ::::
@@ -93,9 +89,7 @@ Let's say we've created a simple plugin which has custom items. For a custom ite
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#customTooltipExampleDeclare
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips3}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#customTooltipExampleDeclare
 :::
 
 We make use of the `Tooltip.messageFromString()` method to generate a Brigadier `Message` object from our string tooltip.
@@ -106,9 +100,7 @@ Let's also say that our plugin has registered lots of `CustomItem`s and has this
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#customTooltipExampleRegister
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips4}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#customTooltipExampleRegister
 :::
 
 ::::
@@ -154,9 +146,7 @@ First, we'll declare our arguments. Here, we use a `LocationArgument` and use th
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#tooltipsWithSafeSuggestionsExampleDeclare
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips5}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#tooltipsWithSafeSuggestionsExampleDeclare
 :::
 
 In the arguments 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:
@@ -165,9 +155,7 @@ In the arguments declaration, we've cast the command sender to a player. To ensu
 ===Java
 <<< @/../reference-code/src/main/java/createcommands/arguments/suggestions/Tooltips.java#tooltipsWithSafeSuggestionsExampleRegister
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:tooltips6}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt#tooltipsWithSafeSuggestionsExampleRegister
 :::
 
 ::::
diff --git a/reference-code/pom.xml b/reference-code/pom.xml
@@ -47,6 +47,12 @@
                     <execution>
                         <id>compile</id>
                         <phase>process-sources</phase>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>${project.basedir}/src/main/java</sourceDir>
+                                <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
+                            </sourceDirs>
+                        </configuration>
                         <goals>
                             <goal>compile</goal>
                         </goals>
diff --git a/reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt b/reference-code/src/main/kotlin/createcommands/arguments/suggestions/Tooltips.kt
@@ -0,0 +1,116 @@
+package createcommands.arguments.suggestions
+
+import com.mojang.brigadier.Message
+import dev.jorel.commandapi.BukkitTooltip
+import dev.jorel.commandapi.CommandAPICommand
+import dev.jorel.commandapi.IStringTooltip
+import dev.jorel.commandapi.StringTooltip
+import dev.jorel.commandapi.arguments.Argument
+import dev.jorel.commandapi.arguments.ArgumentSuggestions
+import dev.jorel.commandapi.arguments.LocationArgument
+import dev.jorel.commandapi.arguments.PlayerArgument
+import dev.jorel.commandapi.arguments.SafeSuggestions
+import dev.jorel.commandapi.arguments.StringArgument
+import dev.jorel.commandapi.executors.PlayerCommandExecutor
+import org.bukkit.Location
+import org.bukkit.Material
+import org.bukkit.entity.Player
+import org.bukkit.inventory.ItemStack
+
+fun stringSuggestionTooltipsExample() {
+    // #region stringSuggestionTooltipsExampleDeclare
+    val arguments = mutableListOf<Argument<*>>()
+    arguments.add(
+        StringArgument("emote")
+            .replaceSuggestions(ArgumentSuggestions.stringsWithTooltips { info ->
+                arrayOf<IStringTooltip>(
+                    StringTooltip.ofString("wave", "Waves at a player"),
+                    StringTooltip.ofString("hug", "Gives a player a hug"),
+                    StringTooltip.ofString("glare", "Gives a player the death glare")
+                )
+            })
+    )
+    arguments.add(PlayerArgument("target"))
+    // #endregion stringSuggestionTooltipsExampleDeclare
+
+    // #region stringSuggestionTooltipsExampleRegister
+    CommandAPICommand("emote")
+        .withArguments(*arguments.toTypedArray())
+        .executesPlayer(PlayerCommandExecutor { player, args ->
+            val emote = args["emote"] as String
+            val target = args["target"] as Player
+
+            when (emote) {
+                "wave" -> target.sendMessage("${player.name} waves at you!")
+                "hug" -> target.sendMessage("${player.name} hugs you!")
+                "glare" -> target.sendMessage("${player.name} gives you the death glare...")
+            }
+        })
+        .register()
+    // #endregion stringSuggestionTooltipsExampleRegister
+}
+
+fun customTooltipExample() {
+    // #region customTooltipExampleDeclare
+    class CustomItem(val item: ItemStack, val name: String, lore: String) : IStringTooltip {
+        init {
+            val meta = item.itemMeta
+            meta.setDisplayName(name)
+            meta.lore = listOf(lore)
+            item.itemMeta = meta
+        }
+
+        override fun getSuggestion(): String = this.item.itemMeta.displayName
+
+        override fun getTooltip(): Message = BukkitTooltip.messageFromString(this.item.itemMeta.lore?.get(0) ?: "")
+    }
+    // #endregion customTooltipExampleDeclare
+
+    // #region customTooltipExampleRegister
+    val customItems = arrayOf<CustomItem>(
+        CustomItem(ItemStack(Material.DIAMOND_SWORD), "God sword", "A sword from the heavens"),
+        CustomItem(ItemStack(Material.PUMPKIN_PIE), "Sweet pie", "Just like grandma used to make")
+    )
+
+    CommandAPICommand("giveitem")
+        .withArguments(StringArgument("item").replaceSuggestions(ArgumentSuggestions.stringsWithTooltips(*customItems))) // We use customItems[] as the input for our suggestions with tooltips
+        .executesPlayer(PlayerCommandExecutor { player, args ->
+            val itemName = args["item"] as String
+
+            // Give them the item
+            for (item in customItems) {
+                if (item.name == itemName) {
+                    player.inventory.addItem(item.item)
+                    break
+                }
+            }
+        })
+        .register()
+    // #endregion customTooltipExampleRegister
+}
+
+fun tooltipsWithSafeSuggestionsExample() {
+    // #region tooltipsWithSafeSuggestionsExampleDeclare
+    val arguments = listOf<Argument<*>>(
+        LocationArgument("location")
+            .replaceSafeSuggestions(SafeSuggestions.tooltips { info ->
+                // We know the sender is a player if we use .executesPlayer()
+                val player = info.sender() as Player
+                BukkitTooltip.arrayOf(
+                    BukkitTooltip.ofString(player.world.spawnLocation, "World spawn"),
+                    BukkitTooltip.ofString(player.bedSpawnLocation, "Your bed"),
+                    BukkitTooltip.ofString(player.getTargetBlockExact(256)?.location, "Target block")
+                )
+            })
+    )
+    // #endregion tooltipsWithSafeSuggestionsExampleDeclare
+
+    // #region tooltipsWithSafeSuggestionsExampleRegister
+    CommandAPICommand("warp")
+        .withArguments(arguments)
+        .executesPlayer(PlayerCommandExecutor { player, args ->
+            player.teleport(args["location"] as Location)
+        })
+        .register()
+    // #endregion tooltipsWithSafeSuggestionsExampleRegister
+}
