tutorial:commands
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:commands [2019/11/16 17:01] – Line numbers i509vcb | tutorial:commands [2020/06/14 05:17] – Move old categories below FAQ to be migrated i509vcb | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Creating Commands ====== | ====== Creating Commands ====== | ||
- | Creating commands can allow a mod developer to add functionality that a player | + | Creating commands can allow a mod developer to add functionality that can used through a command. |
- | This tutorial will teach you how to register commands, and the command structure of Brigadier | + | This tutorial will teach you how to register commands, and the general |
- | ===== Registering Commands ===== | + | Note: All code written here was written for 1.14.4. Some mappings may have changed in yarn, but all code should still be applicable. |
- | If you just want to see how to register commands you've come to the right place here. | + | ===== What is Brigadier? ===== |
- | Registering commands | + | Brigadier |
- | The '' | + | The source code for brigadier can be found here: https:// |
- | The dedicated flag if set to true will tell Fabric to only register the command on a '' | + | ===== What is a command? ===== |
- | Below are a few examples | + | Brigadier requires you specify the '' |
+ | A '' | ||
+ | The single method in '' | ||
+ | |||
+ | A command can be implemented in several ways as shown below: | ||
+ | |||
+ | **__As a lambda__** | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | CommandRegistry.INSTANCE.register(false, | + | Command< |
- | + | | |
- | CommandRegistry.INSTANCE.register(false, | + | }; |
- | | + | |
- | TutorialHelpCommand.register(dispatcher); | + | |
- | }); | + | |
- | + | ||
- | CommandRegistry.INSTANCE.register(true, | + | |
- | dispatcher.register(LiteralArgumentBuilder.literal(" | + | |
- | }); | + | |
</ | </ | ||
- | ==== A very basic command ==== | + | **__As an anonymous class__** |
+ | <code java [enable_line_numbers=" | ||
+ | Command< | ||
+ | @Override | ||
+ | public int run(CommandContext< | ||
+ | return 0; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
- | Wait isn't this the exact same command from the Brigadier tutorial? Well yes it is but it is here to help explain the structure of a command. | + | **__Implemented as a class__** |
+ | <code java [enable_line_numbers=" | ||
+ | final class XYZCommand implements Command< | ||
+ | @Override | ||
+ | public int run(CommandContext< | ||
+ | return 0; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | **__As a method reference__** | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | // The root of the command. This must be a literal argument. | + | void registerCommand() { |
- | dispatcher.register(CommandManager.literal(" | + | |
- | // Then add an argument named bar that is an integer | + | dispatcher.register(CommandManager.literal(" |
- | | + | .executes(this:: |
- | // The command | + | } |
- | | + | |
- | | + | private int execute(CommandContext< |
- | // Return a result. -1 is failure, 0 is a pass and 1 is success. | + | return |
- | | + | } |
- | })) | + | |
- | // The command " | + | |
- | .executes(ctx -> { | + | |
- | | + | |
- | | + | |
- | }) | + | |
- | ); | + | |
</ | </ | ||
- | The main process registers the command " | ||
- | Since the root node must be literal, The sender must enter the exact same sequence of letters to execute the command, so " | ||
- | ===== Brigadier Explained ===== | + | The '' |
- | Brigadier starts with the '' | + | The integer can be considered |
- | The trunk of the tree is the CommandDispatcher. | + | |
- | The register(LiteralArgumentBuilder) methods specify | + | |
- | The executes blocks can be seen at the leaves of the tree where it ends and also supplies the outcome | + | |
- | The execute blocks specify the command | + | ===== A basic command |
- | ==== CommandContexts ==== | + | Below is a command that contains no arguments: |
- | When a command is ran, Brigadier provides a CommandContext to the command that is ran. | + | <code java [enable_line_numbers=" |
- | The CommandContext contains all arguments and other objects such as the inputted String and the '' | + | dispatcher.register(CommandManager.literal(" |
+ | System.out.println(" | ||
- | ==== Arguments ==== | + | return 1; |
+ | })); | ||
+ | </ | ||
- | The arguments in Brigadier both parse and error check any inputted arguments. | + | '' |
- | Minecraft creates some special arguments for it's own use such as the '' | + | To execute this command, one must type '' |
- | You could do the long method of typing '' | + | ==== A sub command ==== |
- | This also works for getting arguments, which shortens | + | |
- | This also works for Minecraft' | + | To add a sub command, you register |
- | And your imports would look something like this: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | import static com.mojang.brigadier.arguments.StringArgumentType.getString; | + | dispatcher.register(CommandManager.literal(" |
- | import static com.mojang.brigadier.arguments.StringArgumentType.word; | + | |
- | import static net.minecraft.server.command.CommandManager.literal; // literal(" | + | |
- | import static net.minecraft.server.command.CommandManager.argument; | + | |
- | import static net.minecraft.server.command.CommandManager.*; | + | |
</ | </ | ||
- | Brigadier's default arguments are located | + | In order to have a sub command, one needs to append the next node to the existing node. This is done use the '' |
- | Minecraft' | + | This creates the command '' |
- | ==== Suggestions ==== | + | <code java [enable_line_numbers=" |
+ | dispatcher.register(CommandManager.literal(" | ||
+ | .then(CommandManager.literal(" | ||
+ | ); | ||
+ | </ | ||
- | Suggestions can be provided | + | It is advised to indent your code as you add nodes to the command. Usually the indentation corresponds |
- | < | + | |
- | SUMMONABLE_ENTITIES | + | **So let's try running the command** |
- | AVAILIBLE_SOUNDS | + | |
- | ALL_RECIPES | + | Most likely if you typed ''/ |
- | ASK_SERVER | + | |
+ | < | ||
+ | dispatcher.register(CommandManager.literal(" | ||
+ | .then(CommandManager.literal(" | ||
+ | .executes(context -> { | ||
+ | System.out.println(" | ||
+ | |||
+ | return 1; | ||
+ | }) | ||
+ | ) | ||
+ | ); | ||
</ | </ | ||
- | Loot tables specify their own SuggestionProvider inside LootCommand for example. | + | ===== Registering the commands ===== |
+ | |||
+ | Registering commands is done by registering a callback using the '' | ||
+ | |||
+ | The event should be registered in your mod's initializer. The callback has two parameters. The '' | ||
- | The example below is a dynamically changing SuggestionProvider that lists several words for a StringArgumentType to demonstrate how it works: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | public | + | public |
- | | + | @Override |
+ | public void onInitialize() { | ||
+ | | ||
+ | ... | ||
+ | }); | ||
+ | } | ||
} | } | ||
- | + | </code> | |
- | private static CompletableFuture<Suggestions> getSuggestionsBuilder(SuggestionsBuilder builder, List<String> list) { | + | |
- | | + | Inside your lambda, method reference or whatever you have chosen, you will register your commands. |
- | + | ||
- | if(list.isEmpty()) { // If the list is empty then return no suggestions | + | <code java [enable_line_numbers=" |
- | | + | public class ExampleCommandMod implements ModInitializer |
+ | | ||
+ | public void onInitialize() { | ||
+ | CommandRegistrationCallback.EVENT.register((dispatcher, | ||
+ | | ||
+ | | ||
+ | return 1; | ||
+ | })); | ||
+ | }); | ||
} | } | ||
- | | + | } |
- | | + | </ |
- | | + | |
- | | + | If desired, you can make sure a command is only registered on a dedicated server by checking the '' |
- | } | + | |
+ | |||
+ | <code java [enable_line_numbers=" | ||
+ | public class ExampleCommandMod implements ModInitializer { | ||
+ | @Override | ||
+ | | ||
+ | | ||
+ | | ||
+ | TestDedicatedCommand.register(dispatcher); | ||
+ | } | ||
+ | }); | ||
} | } | ||
- | return builder.buildFuture(); | ||
} | } | ||
</ | </ | ||
- | The SuggestionProvider is a FunctionalInterface that returns a CompletableFuture containing a list of suggestions. These suggestions are given to client as a command is typed and can be changed while server is running. The SuggestionProvider provides a CommandContext and a SuggestionBuilder to determine all the suggestions. The CommandSource can also be taken into account during the suggestion creation process as it is available through the CommandContext. | + | And vice versa |
- | Though remember these are suggestions. The inputted command may not contain an argument you suggested so you still have to parse check inside the command to see if the argument is what you want if it's a String for example and parsers may still throw exceptions | + | <code java [enable_line_numbers=" |
+ | public class ExampleCommandMod implements ModInitializer { | ||
+ | @Override | ||
+ | public void onInitialize() { | ||
+ | CommandRegistrationCallback.EVENT.register((dispatcher, | ||
+ | | ||
+ | TestIntegratedCommand.register(dispatcher); | ||
+ | } | ||
+ | }); | ||
+ | } | ||
+ | } | ||
+ | </ | ||
- | To use the suggestion you would append it right after the argument you want to recommend arguments for. This can be any argument and the normal client side exception popups will still work. Note this cannot be applied to literals. | + | ===== Arguments ===== |
+ | Arguments in Brigadier both parse and error check any inputted arguments. | ||
+ | Minecraft creates some special argument types for it's own use such as the '' | ||
+ | |||
+ | **TODO:** Go into more detail on how to use arguments | ||
+ | |||
+ | ===== Static Imports ===== | ||
+ | You could type out '' | ||
+ | This also works for Minecraft' | ||
+ | |||
+ | And your imports would look something like this: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | argument(argumentName, word()) | + | // getString(ctx, " |
- | .suggests(CompletionProviders.suggestedStrings()) | + | import static com.mojang.brigadier.arguments.StringArgumentType.getString; |
- | .then(/*Rest of the command*/)); | + | // word() |
+ | import static com.mojang.brigadier.arguments.StringArgumentType.word; | ||
+ | // literal(" | ||
+ | import static net.minecraft.server.command.CommandManager.literal; | ||
+ | // argument(" | ||
+ | import static net.minecraft.server.command.CommandManager.argument; | ||
+ | // Import everything | ||
+ | import static net.minecraft.server.command.CommandManager.*; | ||
</ | </ | ||
- | ==== Requires | + | Note: Please be sure you use the '' |
+ | |||
+ | Brigadier' | ||
+ | |||
+ | Minecraft' | ||
+ | CommandManager is in '' | ||
+ | |||
+ | ====== Advanced concepts ====== | ||
+ | |||
+ | Below are links to the articles about more complex concepts used in brigadier. | ||
+ | |||
+ | ^ Page ^ Description | ||
+ | | [[tutorials: | ||
+ | | [[tutorials: | ||
+ | | [[tutorials: | ||
+ | | [[tutorials: | ||
+ | | [[tutorials: | ||
+ | | [[tutorials: | ||
+ | |||
+ | **TODO:** Sections are being moved to sub categories and will be added to their respective articles as they are migrated. | ||
+ | |||
+ | ====== FAQ ====== | ||
+ | |||
+ | ===== Why does my command not compile ===== | ||
+ | |||
+ | There are two immediate possibilities for why this could occur. | ||
+ | |||
+ | ==== Catch or throw a CommandSyntaxException ==== | ||
+ | |||
+ | The solution to this issue is to make the run or suggest methods throw a CommandSyntaxException. Don't worry, brigadier will handle the exceptions and output the proper error message. | ||
+ | |||
+ | ==== Issues with generics ==== | ||
+ | |||
+ | You may have an issue with generic types once in a while. Verify you are using '' | ||
+ | |||
+ | ===== Can I register client side commands? ===== | ||
+ | |||
+ | Fabric doesn' | ||
+ | |||
+ | ===== Dark Arts ===== | ||
+ | |||
+ | A few things we don't recommend, but are possible. | ||
+ | |||
+ | ==== Can I register commands in runtime? ==== | ||
+ | |||
+ | You can do this but it is not recommended. You would get the '' | ||
+ | |||
+ | After that you need to send the command tree to every player again using '' | ||
+ | |||
+ | ==== Can I unregister commands in runtime? ==== | ||
+ | |||
+ | You can also do this, however it is much less stable than registering commands and could cause unwanted side effects. To keep things simple, you need to use reflection on brigadier and remove the nodes. After this, you need to send the command tree to every player again using '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ====== Sorry for the mess ====== | ||
+ | |||
+ | **__Currently this article is being migrated, so things may be a mess. Below is are the parts of the article that are yet to be migrated to the new format.__** | ||
+ | |||
+ | ===== Requirements ===== | ||
Lets say you have a command you only want operators to be able to execute. This is where the '' | Lets say you have a command you only want operators to be able to execute. This is where the '' | ||
Line 154: | Line 283: | ||
This command will only execute if the Source of the command is a level 4 operator at minimum. If the predicate returns false, then the command will not execute. Also this has the side effect of not showing this command in tab completion to anyone who is not a level 4 operator. | This command will only execute if the Source of the command is a level 4 operator at minimum. If the predicate returns false, then the command will not execute. Also this has the side effect of not showing this command in tab completion to anyone who is not a level 4 operator. | ||
- | ==== Exceptions ==== | + | Nothing prevents someone from specifying calls to permissions implementations within the '' |
- | Brigadier supports command exceptions which can be used to end a command such as if an argument didn't parse properly or the command failed to execute. | + | ===== Exceptions ===== |
- | All the exceptions from Brigadier are based on the CommandSyntaxException. The two main types of exceptions Brigadier provides are Dynamic and Simple exception types, of which you must '' | + | Brigadier supports command exceptions which can be used to end a command such as if an argument didn't parse properly or the command failed to execute, as well as including richer details of the failure. |
+ | |||
+ | All the exceptions from Brigadier are based on the CommandSyntaxException. The two main types of exceptions Brigadier provides are Dynamic and Simple exception types, of which you must '' | ||
Below is a coin flip command to show an example of exceptions in use. | Below is a coin flip command to show an example of exceptions in use. | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
dispatcher.register(CommandManager.literal(" | dispatcher.register(CommandManager.literal(" | ||
- | .executes(ctx -> { | + | |
- | Random random = new Random(); | + | Random random = new Random(); |
- | if(random.nextBoolean()) { // If heads succeed. | + | |
- | ctx.getSource().sendMessage(new TranslateableText(" | + | ctx.getSource().sendMessage(new TranslateableText(" |
- | return Command.SINGLE_SUCCESS; | + | return Command.SINGLE_SUCCESS; |
- | } | + | } |
- | throw new SimpleCommandExceptionType(new TranslateableText(" | + | |
- | })); | + | |
+ | })); | ||
</ | </ | ||
- | Though you are not just limited to a single type of exception as Brigadier also supplies Dynamic exceptions. | + | Though you are not just limited to a single type of exception as Brigadier also supplies Dynamic exceptions |
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
DynamicCommandExceptionType used_name = new DynamicCommandExceptionType(name -> { | DynamicCommandExceptionType used_name = new DynamicCommandExceptionType(name -> { | ||
- | return new LiteralText(" | + | |
}); | }); | ||
</ | </ | ||
Line 185: | Line 317: | ||
You should remember that the Dynamic exceptions takes an object as an argument so you may have to cast the argument for your use. | You should remember that the Dynamic exceptions takes an object as an argument so you may have to cast the argument for your use. | ||
- | ==== Redirects (Aliases) ==== | + | ===== Redirects (Aliases) |
Redirects are Brigadier' | Redirects are Brigadier' | ||
Line 193: | Line 325: | ||
LiteralCommandNode node = registerMain(dispatcher); | LiteralCommandNode node = registerMain(dispatcher); | ||
dispatcher.register(literal(" | dispatcher.register(literal(" | ||
- | .redirect(node)); | + | |
dispatcher.register(literal(" | dispatcher.register(literal(" | ||
- | .redirect(node)); | + | |
} | } | ||
public static LiteralCommandNode registerMain(CommandDispatcher< | public static LiteralCommandNode registerMain(CommandDispatcher< | ||
return dispatcher.register(literal(" | return dispatcher.register(literal(" | ||
- | .then(argument(" | + | |
- | | + | .then(argument(" |
- | .executes(ctx -> { | + | .executes(ctx -> { |
- | | + | return execute(ctx.getSource(), |
- | })))); | + | })))); |
} | } | ||
</ | </ | ||
- | The redirect | + | The redirect |
- | + | ||
- | Redirects do not work in shortened aliases such as ''/ | + | |
- | ==== Redirects (Chainable Commands) ==== | + | ===== Redirects (Chainable Commands) |
Commands such as ''/ | Commands such as ''/ | ||
Line 221: | Line 351: | ||
.then(literal(" | .then(literal(" | ||
.then(literal(" | .then(literal(" | ||
- | .redirect(root)) // Return to root for chaining | + | .redirect(root, this:: |
.then(literal(" | .then(literal(" | ||
- | .redirect(root))) // Return to root for chaining | + | .redirect(root, this:: |
.then(literal(" | .then(literal(" | ||
.executes(ctx -> { | .executes(ctx -> { | ||
Line 230: | Line 360: | ||
}))); | }))); | ||
</ | </ | ||
- | The redirect can also modify the CommandSource. | + | The redirect can also modify the CommandSource |
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | .redirect(rootNode, | + | .redirect(rootNode, |
- | return ((ServerCommandSource) | + | return ((ServerCommandSource) |
}) | }) | ||
</ | </ | ||
- | ===== ServerCommandSource ===== | + | ===== What can the ServerCommandSource |
- | What if you wanted | + | A server command source provides some additional implementation specific context when a command |
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | ServerCommandSource source = ctx.getSource(); | + | final ServerCommandSource source = ctx.getSource(); |
// Get the source. This will always work. | // Get the source. This will always work. | ||
- | Entity sender = source.getEntity(); | + | final Entity sender = source.getEntity(); |
// Unchecked, may be null if the sender was the console. | // Unchecked, may be null if the sender was the console. | ||
- | Entity sender2 = source.getEntityOrThrow(); | + | final Entity sender2 = source.getEntityOrThrow(); |
// Will end the command if the source of the command was not an Entity. | // Will end the command if the source of the command was not an Entity. | ||
// The result of this could contain a player. Also will send feedback telling the sender of the command that they must be an entity. | // The result of this could contain a player. Also will send feedback telling the sender of the command that they must be an entity. | ||
Line 255: | Line 385: | ||
// The entity options in ServerCommandSource could return a CommandBlock entity, any living entity or a player. | // The entity options in ServerCommandSource could return a CommandBlock entity, any living entity or a player. | ||
- | ServerPlayerEntity player = source.getPlayer(); | + | final ServerPlayerEntity player = source.getPlayer(); |
// Will end the command if the source of the command was not explicitly a Player. Also will send feedback telling the sender of the command that they must be a player. | // Will end the command if the source of the command was not explicitly a Player. Also will send feedback telling the sender of the command that they must be a player. | ||
- | </ | ||
- | The ServerCommandSource also provides other information about the sender of the command. | ||
- | |||
- | <code java [enable_line_numbers=" | ||
source.getPosition(); | source.getPosition(); | ||
// Get's the sender' | // Get's the sender' | ||
Line 281: | Line 407: | ||
</ | </ | ||
- | ===== Some actual | + | ===== Some example commands |
- | + | ||
- | Just a few to show: | + | |
=== Broadcast a message === | === Broadcast a message === | ||
Line 290: | Line 414: | ||
public static void register(CommandDispatcher< | public static void register(CommandDispatcher< | ||
dispatcher.register(literal(" | dispatcher.register(literal(" | ||
- | .requires(source -> source.hasPermissionLevel(2)) // Must be a game master to use the command. Command will not show up in tab completion or execute to non op' | + | |
- | | + | .then(argument(" |
- | .then(argument(" | + | .then(argument(" |
- | | + | .executes(ctx -> broadcast(ctx.getSource(), |
} | } | ||
public static int broadcast(ServerCommandSource source, Formatting formatting, String message) { | public static int broadcast(ServerCommandSource source, Formatting formatting, String message) { | ||
- | Text text = new LiteralText(message).formatting(formatting); | + | |
source.getMinecraftServer().getPlayerManager().broadcastChatMessage(text, | source.getMinecraftServer().getPlayerManager().broadcastChatMessage(text, | ||
Line 304: | Line 428: | ||
</ | </ | ||
- | === / | + | ==== / |
First the basic code where we register " | First the basic code where we register " | ||
Line 319: | Line 443: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
public static int giveDiamond(CommandContext< | public static int giveDiamond(CommandContext< | ||
- | ServerCommandSource source = ctx.getSource(); | + | |
- | PlayerEntity self = source.getPlayer(); | + | |
</ | </ | ||
Line 328: | Line 452: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
if(!player.inventory.insertStack(new ItemStack(Items.DIAMOND))){ | if(!player.inventory.insertStack(new ItemStack(Items.DIAMOND))){ | ||
- | throw new SimpleCommandExceptionType(new | + | throw new SimpleCommandExceptionType(new |
- | } | + | } |
return 1; | return 1; | ||
} | } | ||
</ | </ | ||
- | === Antioch === | + | ==== Antioch |
...lobbest thou thy Holy Hand Grenade of Antioch towards thy foe. | ...lobbest thou thy Holy Hand Grenade of Antioch towards thy foe. | ||
who being naughty in My sight, shall snuff it. | who being naughty in My sight, shall snuff it. | ||
Line 346: | Line 471: | ||
dispatcher.register(literal(" | dispatcher.register(literal(" | ||
.then(required(" | .then(required(" | ||
- | | + | |
- | .executes(ctx -> antioch(ctx.getSource(), | + | .executes(ctx -> antioch(ctx.getSource(), |
} | } | ||
</ | </ | ||
Line 354: | Line 479: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | public static int antioch(ServerCommandSource source, BlockPos blockPos) throws CommandSyntaxException { | + | public static int antioch(ServerCommandSource source, BlockPos blockPos) throws CommandSyntaxException { |
- | + | if(blockPos == null) { | |
- | if(blockPos==null) { | + | // For the case of no inputted argument we calculate the cursor position of the player or throw an error if the nearest position is too far or is outside of the world. |
- | | + | // This class is used as an example and actually doesn' |
+ | blockPos = LocationUtil.calculateCursorOrThrow(source, | ||
} | } | ||
- | + | ||
- | TntEntity tnt = new TntEntity(source.getWorld(), | + | |
+ | tnt.setFuse(3); | ||
| | ||
source.getMinecraftServer().getPlayerManager().broadcastChatMessage(new LiteralText(" | source.getMinecraftServer().getPlayerManager().broadcastChatMessage(new LiteralText(" | ||
Line 369: | Line 496: | ||
</ | </ | ||
- | === Finding Biomes via Command | + | ==== More examples coming soon ==== |
- | This example shows examples of redirects, exceptions, suggestions and a tiny bit of text. Note this command when used works but can take a bit of time to work similarly to ''/ | + | ===== Custom |
- | <code java [enable_line_numbers=" | + | |
- | public class CommandLocateBiome { | + | |
- | // First make method to register | + | |
- | public static void register(CommandDispatcher< | + | |
- | LiteralCommandNode< | + | |
- | .then(argument(" | + | |
- | .then(argument(" | + | |
- | .executes(ctx -> execute(ctx.getSource(), | + | |
- | .executes(ctx -> execute(ctx.getSource(), | + | |
- | // Register redirect | + | |
- | dispatcher.register(literal(" | + | |
- | .redirect(basenode)); | + | |
- | } | + | |
- | // Beginning of the method | + | |
- | private static int execute(ServerCommandSource source, Identifier biomeId, int range) throws CommandSyntaxException { | + | |
- | Biome biome = Registry.BIOME.get(biomeId); | + | |
- | + | ||
- | if(biome == null) { // Since the argument is an Identifier we need to check if the identifier actually exists in the registry | + | |
- | throw new SimpleCommandExceptionType(new TranslatableText(" | + | |
- | } | + | |
- | + | ||
- | List< | + | |
- | bio.add(biome); | + | |
- | + | ||
- | ServerWorld world = source.getWorld(); | + | |
- | + | ||
- | BiomeSource bsource = world.getChunkManager().getChunkGenerator().getBiomeSource(); | + | |
- | + | ||
- | BlockPos loc = new BlockPos(source.getPosition()); | + | |
- | // Now here is the heaviest part of the method. | + | |
- | BlockPos pos = bsource.locateBiome(loc.getX(), | + | |
- | + | ||
- | // Since this method can return null if it failed to find a biome | + | |
- | if(pos == null) { | + | |
- | throw new SimpleCommandExceptionType(new TranslatableText(" | + | |
- | } | + | |
- | + | ||
- | int distance = MathHelper.floor(getDistance(loc.getX(), | + | |
- | // Popup text that can suggest commands. This is the exact same system that /locate uses. | + | |
- | Text teleportButtonPopup = Texts.bracketed(new TranslatableText(" | + | |
- | style_1x.setColor(Formatting.GREEN).setClickEvent(new ClickEvent(ClickEvent.Action.SUGGEST_COMMAND, | + | |
- | }); | + | |
- | + | ||
- | source.sendFeedback(new TranslatableText(" | + | |
- | + | ||
- | return 1; | + | |
- | } | + | |
- | // Just a normal old 2d distance method. | + | |
- | private static float getDistance(int int_1, int int_2, int int_3, int int_4) { | + | |
- | int int_5 = int_3 - int_1; | + | |
- | int int_6 = int_4 - int_2; | + | |
- | + | ||
- | return MathHelper.sqrt((float) (int_5 * int_5 + int_6 * int_6)); | + | |
- | } | + | |
- | + | ||
- | + | ||
- | + | ||
- | public static class BiomeCompletionProvider { | + | |
- | // This provides suggestions of what biomes can be selected. Since this uses the registry, mods that add new biomes will work without modification. | + | |
- | public static final SuggestionProvider< | + | |
- | Registry.BIOME.getIds().stream().forEach(identifier -> builder.suggest(identifier.toString(), | + | |
- | return builder.buildFuture(); | + | |
- | }); | + | |
- | + | ||
- | } | + | |
- | </ | + | |
- | + | ||
- | ===== Custom | + | |
Brigadier has support for custom argument types and this section goes into showing how to create a simple argument type. | Brigadier has support for custom argument types and this section goes into showing how to create a simple argument type. | ||
Line 445: | Line 504: | ||
Warning: Custom arguments require client mod installation to be registered correctly! If you are making a server plugin, consider using existing argument type and a custom suggestions provider instead. | Warning: Custom arguments require client mod installation to be registered correctly! If you are making a server plugin, consider using existing argument type and a custom suggestions provider instead. | ||
- | For this example we will create a UUIDArgumentType. | + | For this example we will create a UuidArgumentType. |
First create a class which extends '' | First create a class which extends '' | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | public class UUIDArgumentType | + | public class UuidArgumentType |
</ | </ | ||
Line 496: | Line 555: | ||
</ | </ | ||
- | The ArgumentType is done, however your client will refuse the parse the argument and throw an error. To fix this we need to register an ArgumentSerializer. | + | The ArgumentType is done, however your client will refuse the parse the argument and throw an error. This is because the server will tell the client what argument type the command node is. And the client will not parse any argument types it does not know how to parse. To fix this we need to register an ArgumentSerializer. |
- | Within your ModInitializer | + | Within your ModInitializer. For more complex argument types, you may need to create your own ArgumentSerializer. |
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | ArgumentTypes.register(" | + | ArgumentTypes.register(" |
// The argument should be what will create the ArgumentType. | // The argument should be what will create the ArgumentType. | ||
</ | </ | ||
Line 506: | Line 565: | ||
And here is the whole ArgumentType: | And here is the whole ArgumentType: | ||
- | <file java UUIDArgumentType.java [enable_line_numbers=" | + | <file java UuidArgumentType.java [enable_line_numbers=" |
import com.mojang.brigadier.StringReader; | import com.mojang.brigadier.StringReader; | ||
Line 523: | Line 582: | ||
* Represents an ArgumentType that will return a UUID. | * Represents an ArgumentType that will return a UUID. | ||
*/ | */ | ||
- | public class UUIDArgumentType | + | public class UuidArgumentType |
- | // This method exists for convince and you could just initialize the class. | + | public static |
- | public static | + | return new UuidArgumentType(); |
- | return new UUIDArgumentType(); | + | |
} | } | ||
- | // This is also for convince and you could always just grab the argument from the CommandContext. | ||
public static <S> UUID getUuid(String name, CommandContext< | public static <S> UUID getUuid(String name, CommandContext< | ||
// Note that you should assume the CommandSource wrapped inside of the CommandContext will always be a generic type. | // Note that you should assume the CommandSource wrapped inside of the CommandContext will always be a generic type. | ||
- | // If you access the ServerCommandSource make sure you verify the source is an instanceof ServerCommandSource | + | // If you need to access the ServerCommandSource make sure you verify the source is a server command source |
return context.getArgument(name, | return context.getArgument(name, | ||
} | } | ||
Line 569: | Line 626: | ||
@Override | @Override | ||
- | public Collection< | + | public Collection< |
return EXAMPLES; | return EXAMPLES; | ||
} | } | ||
} | } | ||
</ | </ | ||
- | ===== FAQ ===== | ||
- | |||
- | === What else can I send feedback to the CommandSource? | ||
- | |||
- | You can choose between Brigadier' | ||
- | |||
- | === Why does my IDE complain saying that a method executed by my command needs to catch or throw a CommandSyntaxException === | ||
- | |||
- | The solution to this is just to make the methods throw a CommandSyntaxException down the whole chain as the executes block handles the exceptions. | ||
- | |||
- | === Can I register commands in run time? === | ||
- | |||
- | You can do this but it is not reccomended. You would get the instance of the CommandManager and add anything you wish to the CommandDispatcher within it. | ||
- | |||
- | After that you will need to send the command tree to every player again using '' | ||
- | |||
- | === Can I unregister commands in run time? === | ||
- | |||
- | You can also do this but it is very unstable and could cause unwanted side effects. Lets just say it involves a bunch of Reflection. | ||
- | |||
- | Once again you will need to send the command tree to every player again using '' | ||
- | |||
- | === Can I register client side commands? === | ||
- | |||
- | Well Fabric currently doesn' | ||
- | https:// | ||
- | |||
- | If you only want the command to only be visible on the integrated server like ''/ | ||
- | |||
- | <code java> | ||
- | dispatcher.register(literal(" | ||
- | // The permission level 4 on integrated server is the equivalent of having cheats enabled. | ||
- | .requires(source -> source.getMinecraftServer().isSinglePlayer() && source.hasPermissionLevel(4))); | ||
- | </ | ||
- | |||
- | === I want to access X from my mod when a command is ran === | ||
- | |||
- | This is going to require a way to statically access your mod with a '' | ||
- | |||
- | <code java> | ||
- | private static Type instance; | ||
- | |||
- | static { // Static option on class initalize for seperate API class for example | ||
- | | ||
- | } | ||
- | |||
- | public void onInitalize() { // If within your mod initalizer | ||
- | | ||
- | } | ||
- | |||
- | public static Type getInstance() { | ||
- | return instance; | ||
- | } | ||
- | </ |
tutorial/commands.txt · Last modified: 2024/02/23 14:22 by allen1210