feat: Unregistration page

MC-XiaoHei · MC-XiaoHei · commit dfd369d71885 · 2024-11-24T18:49:56.000+08:00
diff --git a/docs/en/create-commands/arguments/types/index.md b/docs/en/create-commands/arguments/types/index.md
@@ -0,0 +1,4 @@
+---
+title: Types
+order: 5
+---
diff --git a/docs/en/create-commands/registration.md b/docs/en/create-commands/registration.md
@@ -15,13 +15,9 @@ I think the easiest way to explain it is with an example:
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandRegistration1}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Registration.java#registrationExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandRegistration1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Registration.kt#registrationExample
 :::
 
 - First, we create a new `CommandAPICommand`, with the name of the command that the sender must enter to run it.
diff --git a/docs/en/create-commands/unregistration.md b/docs/en/create-commands/unregistration.md
@@ -63,13 +63,9 @@ Since this command exists in the Bukkit CommandMap, we'll need to use `CommandAP
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration1}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterBukkitExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration1}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterBukkitExample
 :::
 
 With this plugin, executing `/version` or `/bukkit:version` will give the unknown command message. Note that aliases like `/ver` and its namespaced version `/bukkit:ver` will still work. To remove aliases as well, you need to unregister each as its own command. For, `/ver`, that would mean calling `CommandAPIBukkit.unregister("ver", true, true)`.
@@ -82,13 +78,9 @@ Since this command exists in the Vanilla CommandDispatcher, we can use `CommandA
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration2}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterVanillaExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration2}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterVanillaExample
 :::
 
 With this code, executing `/gamemode` will give the unknown command exception as expected. However, even though `unregisterNamespaces` was `false`, `/minecraft:gamemode` can also not be run. This happens because Vanilla commands are given their namespace in step 6, after our plugin has removed `/gamemode`.
@@ -101,13 +93,9 @@ To replace a command, first unregister the original command, then register a new
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration3}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterVanillaAndReplaceExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration3}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterVanillaAndReplaceExample
 :::
 
 Now, when `/gamemode` is executed, it will use the new implementation defined using the CommandAPI.
@@ -130,13 +118,9 @@ Since plugin commands are stored in the Bukkit CommandMap, we need to use `Comma
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration4}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterPluginExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration4}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterPluginExample
 :::
 
 Executing `/luckperms` will work as normal, but `/luckperms:luckperms` will give the unknown command message.
@@ -179,13 +163,9 @@ In summary, we will unregister the `/break` command in our plugin's `onEnable`.
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration5}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterCommandAPIExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration5}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterCommandAPIExample
 :::
 
 Now, when you try to execute `/break`, you will just get the unknown command message as if it never existed.
@@ -200,13 +180,9 @@ Since `/help` is in the Bukkit CommandMap, we need to use `CommandAPIBukkit#unre
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration6}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterBukkitHelpExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration6}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterBukkitHelpExample
 :::
 
 Funnily, if you try to execute `/help`, the server will still tell you: `Unknown command. Type "/help" for help.`. Luckily, `unregisterNamespaces` was `false`, so you can still use `/bukkit:help` to figure out your problem.
@@ -223,13 +199,9 @@ Finally, `unregisterNamespaces` should be `false`, and since that's the default
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration7}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterVanillaNamespaceOnlyExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration7}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterVanillaNamespaceOnlyExample
 :::
 
 With this code, `/gamemode` will execute as normal, but `/minecraft:gamemode` will give the unknown command message.
@@ -240,13 +212,9 @@ Doing the opposite action here -- only unregistering `/gamemode` but keeping `/m
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration8}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterDelayedVanillaBadExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration8}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterDelayedVanillaBadExample
 :::
 
 The expected outcome of this code is that `/minecraft:gamemode` would work as expected, and `/gamemode` would give the command not found message. However, that is only true for the player's commands. If you try to use `/minecraft:gamemode` in the console, it *will not work* properly. Specifically, while you can tab-complete the command's label, `minecraft:gamemode` the command's arguments will not have any suggestions. If you try to execute `/minecraft:gamemode` in the console, it will always tell you your command is unknown or incomplete.
@@ -255,13 +223,9 @@ The main point is that if you ever try to unregister a Vanilla command after the
 
 :::tabs
 ===Java
-```java
-// todo {{#include ../../commandapi-documentation-code/src/main/java/dev/jorel/commandapi/examples/java/Examples.java:commandUnregistration9}}
-```
+<<< @/../reference-code/src/main/java/createcommands/Unregistration.java#unregisterDelayedVanillaGoodExample
 ===Kotlin
-```kotlin
-// todo {{#include ../../commandapi-documentation-code/src/main/kotlin/dev/jorel/commandapi/examples/kotlin/Examples.kt:commandUnregistration9}}
-```
+<<< @/../reference-code/src/main/kotlin/createcommands/Unregistration.kt#unregisterDelayedVanillaGoodExample
 :::
 
 ::::
diff --git a/reference-code/src/main/java/createcommands/Registration.java b/reference-code/src/main/java/createcommands/Registration.java
@@ -0,0 +1,23 @@
+package createcommands;
+
+import dev.jorel.commandapi.CommandAPICommand;
+import dev.jorel.commandapi.CommandPermission;
+import dev.jorel.commandapi.arguments.GreedyStringArgument;
+import org.bukkit.Bukkit;
+
+class Registration {
+    {
+        // #region registrationExample
+        // Create our command
+        new CommandAPICommand("broadcastmsg")
+            .withArguments(new GreedyStringArgument("message")) // The arguments
+            .withAliases("broadcast", "broadcastmessage")       // Command aliases
+            .withPermission(CommandPermission.OP)               // Required permissions
+            .executes((sender, args) -> {
+                String message = (String) args.get("message");
+                Bukkit.getServer().broadcastMessage(message);
+            })
+            .register();
+        // #endregion registrationExample
+    }
+}
diff --git a/reference-code/src/main/java/createcommands/Unregistration.java b/reference-code/src/main/java/createcommands/Unregistration.java
@@ -0,0 +1,123 @@
+package createcommands;
+
+import dev.jorel.commandapi.CommandAPI;
+import dev.jorel.commandapi.CommandAPIBukkit;
+import dev.jorel.commandapi.CommandAPICommand;
+import dev.jorel.commandapi.arguments.MultiLiteralArgument;
+import org.bukkit.plugin.java.JavaPlugin;
+import org.bukkit.scheduler.BukkitRunnable;
+
+class Unregistration {
+    {
+        new JavaPlugin() {
+            // #region unregisterBukkitExample
+            @Override
+            public void onLoad() {
+                CommandAPIBukkit.unregister("version", true, true);
+            }
+            // #endregion unregisterBukkitExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterVanillaExample
+            @Override
+            public void onEnable() {
+                CommandAPI.unregister("gamemode");
+            }
+            // #endregion unregisterVanillaExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterVanillaAndReplaceExample
+            @Override
+            public void onEnable() {
+                CommandAPI.unregister("gamemode");
+
+                // Register our new /gamemode, with survival, creative, adventure and spectator
+                new CommandAPICommand("gamemode")
+                    .withArguments(new MultiLiteralArgument("gamemodes", "survival", "creative", "adventure", "spectator"))
+                    .executes((sender, args) -> {
+                        // Implementation of our /gamemode command
+                    })
+                    .register();
+            }
+            // #endregion unregisterVanillaAndReplaceExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterPluginExample
+            @Override
+            public void onEnable() {
+                CommandAPIBukkit.unregister("luckperms:luckperms", false, true);
+            }
+            // #endregion unregisterPluginExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterCommandAPIExample
+            @Override
+            public void onEnable() {
+                CommandAPI.unregister("break");
+            }
+            // #endregion unregisterCommandAPIExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterBukkitHelpExample
+            @Override
+            public void onEnable() {
+                new BukkitRunnable() {
+                    @Override
+                    public void run() {
+                        CommandAPIBukkit.unregister("help", false, true);
+                    }
+                }.runTaskLater(this, 0);
+            }
+            // #endregion unregisterBukkitHelpExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterVanillaNamespaceOnlyExample
+            @Override
+            public void onEnable() {
+                new BukkitRunnable() {
+                    @Override
+                    public void run() {
+                        CommandAPI.unregister("minecraft:gamemode");
+                    }
+                }.runTaskLater(this, 0);
+            }
+            // #endregion unregisterVanillaNamespaceOnlyExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterDelayedVanillaBadExample
+            // NOT RECOMMENDED
+            @Override
+            public void onEnable() {
+                new BukkitRunnable() {
+                    @Override
+                    public void run() {
+                        CommandAPI.unregister("gamemode");
+                    }
+                }.runTaskLater(this, 0);
+            }
+            // #endregion unregisterDelayedVanillaBadExample
+        };
+
+        new JavaPlugin() {
+            // #region unregisterDelayedVanillaGoodExample
+            // NOT RECOMMENDED
+            @Override
+            public void onEnable() {
+                new BukkitRunnable() {
+                    @Override
+                    public void run() {
+                        CommandAPI.unregister("gamemode", true);
+                    }
+                }.runTaskLater(this, 0);
+            }
+            // #endregion unregisterDelayedVanillaGoodExample
+        };
+    }
+}
diff --git a/reference-code/src/main/kotlin/createcommands/Registration.kt b/reference-code/src/main/kotlin/createcommands/Registration.kt
@@ -0,0 +1,22 @@
+package createcommands
+
+import dev.jorel.commandapi.CommandAPICommand
+import dev.jorel.commandapi.CommandPermission
+import dev.jorel.commandapi.arguments.GreedyStringArgument
+import dev.jorel.commandapi.executors.CommandExecutor
+import org.bukkit.Bukkit
+
+fun registrationExample() {
+    // #region registrationExample
+    // Create our command
+    CommandAPICommand("broadcastmsg")
+        .withArguments(GreedyStringArgument("message")) // The arguments
+        .withAliases("broadcast", "broadcastmessage")   // Command aliases
+        .withPermission(CommandPermission.OP)           // Required permissions
+        .executes(CommandExecutor { sender, args ->
+            val message = args["message"] as String
+            Bukkit.getServer().broadcastMessage(message)
+        })
+        .register()
+    // #endregion registrationExample
+}
diff --git a/reference-code/src/main/kotlin/createcommands/Unregistration.kt b/reference-code/src/main/kotlin/createcommands/Unregistration.kt

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +title: Types
 +order: 5
 +---