feat(minecraft): add list of bukkit parsers

Incendo · Jan 23, 2024 · 84b37ec · 84b37ec
1 parent 7eae6b2
commit 84b37ec
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/minecraft/bukkit.md b/docs/minecraft/bukkit.md
@@ -33,3 +33,24 @@ Cloud for Bukkit is available through [Maven Central](https://search.maven.org/s
     ```groovy
     implementation 'cloud.commandframework:cloud-bukkit:2.0.0-SNAPSHOT'
     ```
+
+## Parsers
+
+| Parser                       | Type (\* = cloud type)                                                                   | Brigadier Type      |
+| ---------------------------- | ---------------------------------------------------------------------------------------- | ------------------- |
+| UUIDParser                   | [UUID](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/UUID.html) | `uuid`              |
+| NamespacedKeyParser          | [NamespacedKey](https://jd.papermc.io/paper/1.20/org/bukkit/NamespacedKey.html)          | `resource_location` |
+| EnchantmentParser            | [Enchantment](https://jd.papermc.io/paper/1.20/org/bukkit/enchantments/Enchantment.html) | `enchantment`       |
+| ItemStackParser              | ProtoItemStack\*                                                                         | `item_stack`        |
+| ItemStackPredicateParser     | ItemStackPredicate\*                                                                     | `item_predicate`    |
+| BlockPredicateParser         | BlockPredicate\*                                                                         | `block_predicate`   |
+| SingleEntitySelectorParser   | SingleEntitySelector\*                                                                   | `entity`            |
+| SinglePlayerSelectorParser   | SinglePlayerSelector\*                                                                   | `entity`            |
+| MultipleEntitySelectorParser | MultipleEntitySelector\*                                                                 | `entity`            |
+| MultiplePlayerSelectorParser | MultiplePlayerSelector\*                                                                 | `entity`            |
+| LocationParser               | [Location](https://jd.papermc.io/paper/1.20/org/bukkit/Location.html)                    | `vec3`              |
+| Location2DParser             | Location2D\*                                                                             | `vec2`              |
+| MaterialParser               | [Material](https://jd.papermc.io/paper/1.20/org/bukkit/Material.html)                    |                     |
+| OfflinePlayerParser          | [OfflinePlayer](https://jd.papermc.io/paper/1.20/org/bukkit/OfflinePlayer.html)          |                     |
+| PlayerPayer                  | [Player](https://jd.papermc.io/paper/1.20/org/bukkit/entity/Player.html)                 |                     |
+| WorldParser                  | [World](https://jd.papermc.io/paper/1.20/org/bukkit/World.html)                          |                     |
diff --git a/docs/minecraft/paper.md b/docs/minecraft/paper.md
@@ -63,3 +63,7 @@ if (commandManager.hasCapability(CloudBukkitCapabilities.ASYNCHRONOUS_COMPLETION
   commandManager.registerAsynchronousCompletions();
 }
 ```
+
+## Parsers
+
+`cloud-paper` has access to all the parsers from [cloud-bukkit](bukkit.md#parsers).