Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:commands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:commands [2023/11/18 10:51] – [Add Requirements] solidblocktutorial:commands [2024/02/23 14:22] (current) – Documenting and first draft allen1210
Line 4: Line 4:
  
 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 general command structure of Brigadier. 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 general command structure of Brigadier.
- 
-Note: All code written here was written for 1.19.2. For old versions, some versions and mappings may differ. 
  
 ===== What is Brigadier? ===== ===== What is Brigadier? =====
Line 26: Line 24:
 }; };
 </code> </code>
- 
-In vanilla Minecraft, they are usually used as method references, such as static methods named ''register'' under classes named ''XXXCommand''. 
  
 The integer can be considered the result of the command. Typically negative values mean a command has failed and will do nothing. A result of ''0'' means the command has passed. Positive values mean the command was successful and did something. The integer can be considered the result of the command. Typically negative values mean a command has failed and will do nothing. A result of ''0'' means the command has passed. Positive values mean the command was successful and did something.
Line 100: Line 96:
         .executes(context -> {         .executes(context -> {
       // For versions below 1.19, replace "Text.literal" with "new LiteralText".       // For versions below 1.19, replace "Text.literal" with "new LiteralText".
-      context.getSource().sendFeedback(Text.literal("Called /foo with no arguments"), false); +      // For versions below 1.20, remode "() ->" directly.
-      // For versions since 1.20, please use the following, which is intended to avoid creating Text objects if no feedback is needed.+
       context.getSource().sendFeedback(() -> Text.literal("Called /foo with no arguments"), false);       context.getSource().sendFeedback(() -> Text.literal("Called /foo with no arguments"), false);
  
Line 112: Line 107:
 **Please ensure you import the correct static method.** The method ''literal'' is ''CommandManager.literal''. You can also alternatively explicitly write ''CommandManager.literal'' instead of using static imports. ''CommandManager.literal("foo")'' tells brigadier this command has one node, a **literal** called ''foo''. **Please ensure you import the correct static method.** The method ''literal'' is ''CommandManager.literal''. You can also alternatively explicitly write ''CommandManager.literal'' instead of using static imports. ''CommandManager.literal("foo")'' tells brigadier this command has one node, a **literal** called ''foo''.
  
-In the ''sendFeedback'' method, the first parameter is the text to be sent, which is a ''Text'' in versions below 1.20, or a ''Supplier<Text>'' since 1.20. The second parameter determines whether to broadcast the feedback to other operators. If the command is to //query// something without actually affecting the world, such as query the current time or some player's score, it should be ''false''. If the command actually //does// something, such as changing the time or modifying someone's score, it should be ''true''. If game rule ''sendCommandFeedback'' is false, you will not accept any feedback.+In the ''sendFeedback'' method, the first parameter is the text to be sent, which is a ''Text'' in versions below 1.20, or a ''Supplier<Text>'' in 1.20 and above (this is used to avoid instantiating ''Text'' objects when not needed, so please do not use ''Suppliers.ofInstance'' or smiliar methods). The second parameter determines whether to broadcast the feedback to other operators. If the command is to //query// something without actually affecting the world, such as query the current time or some player's score, it should be ''false''. If the command actually //does// something, such as changing the time or modifying someone's score, it should be ''true''. If game rule ''sendCommandFeedback'' is false, you will not accept any feedback. If the sender is modifed through ''/execute as ...'', the feedback is sent to the original sender.
  
 If the command fails, instead of calling ''sendFeedback'', you may directly throw a ''CommandSyntaxException'' or ''<yarn class_2164>''. See [[command_exceptions]] for details. If the command fails, instead of calling ''sendFeedback'', you may directly throw a ''CommandSyntaxException'' or ''<yarn class_2164>''. See [[command_exceptions]] for details.
Line 217: Line 212:
 </code> </code>
  
-Now you can type one or two integers. If you give one integer, that integer will be self-multiplied. If you provide two integers, they will be multipled. You may find it unnecessary to specify similar executions twice. Therefore, we can create a method that will be used in both executions.+Now you can type one or two integers. If you give one integer, that square of integer will be calculated. If you provide two integers, their product will be calculated. You may find it unnecessary to specify similar executions twice. Therefore, we can create a method that will be used in both executions.
  
 <code java> <code java>
Line 245: Line 240:
 </code> </code>
  
-In order to have a sub command, one needs to append the next node to the existing node. This creates the command ''foo <bar>'' as shown below.+In order to have a sub command, one needs to append the next node to the existing node.  
 + 
 +This creates the command ''foo <bar>'' as shown below.
  
 <code java [enable_line_numbers="true"]> <code java [enable_line_numbers="true"]>
Line 261: Line 258:
 </code> </code>
  
-Similar to arguments, sub command nodes can also be set optional. In the following cases, both ''/foo'' and ''/foo bar'' will be valid.+Similar to arguments, sub command nodes can also be set optional. In the following case, both ''/foo'' and ''/foo bar'' will be valid.
 <code java [enable_line_numbers="true"]> <code java [enable_line_numbers="true"]>
 dispatcher.register(literal("foo") dispatcher.register(literal("foo")
Line 291: Line 288:
 ===== Why does my code not compile ===== ===== Why does my code not compile =====
  
-There are two immediate possibilities for why this could occur.+There are several 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''. Brigadier will handle the checked exceptions and forward the proper error message in game for you. +  * **Catch or throw a CommandSyntaxException:** ''CommandSyntaxException'' is not a ''RuntimeException''. If you throw it, where it is throwed should be in methods that throws ''CommandSyntaxException'' in method signatures, or be caught. Brigadier will handle the checked exceptions and forward the proper error message in game for you. 
-* **Issues with generics:** You may have an issue with generics once in a while. If you are registering server command (which is most of the case), make sure you are using ''CommandManager.literal(...)'' or ''CommandManager.argument(...)'' instead ''LiteralArgumentBuilder.literal'' or ''RequiredArgumentBuilder.argument'' in your static imports.+  * **Issues with generics:** You may have an issue with generics once in a while. If you are registering server command (which is most of the case), make sure you are using ''CommandManager.literal(...)'' or ''CommandManager.argument(...)'' instead of ''LiteralArgumentBuilder.literal'' or ''RequiredArgumentBuilder.argument'' in your static imports. 
 +  * **Check ''sendFeedback'' method:** You may have forgotten to provide a boolean as the second argument. Also remember that, since 1.20, the first parameter is ''Supplier<Text>'' instead of ''Text''. 
 +  * **''Command'' should return an integer:** When registering commands, the ''executes'' method accepts a ''Command'' object, which is usually a lambda. The lambda should return an integer, instead of other types.
  
 ===== Can I register client side commands? ===== ===== Can I register client side commands? =====
Line 309: Line 308:
 </code> </code>
  
-If you need to open a screen in the client command execusion, instead of calling ''client.setScreen(...)'', you should call ''client.execute(() -> client.setScreen(...))''. The variable ''client'' can be obtained with ''context.getSource().getClient()''.+If you need to open a screen in the client command execution, instead of directly calling ''client.setScreen(...)'', you should call ''%%client.execute(() -> client.setScreen(...))%%''. The variable ''client'' can be obtained with ''context.getSource().getClient()''.
  
 ===== Can I register commands in runtime? ===== ===== Can I register commands in runtime? =====
Line 321: Line 320:
 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 ''sendCommandTree(ServerPlayerEntity)''. If you don't send the updated command tree, the client may think a command still exists, even though the server will fail execution. 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 ''sendCommandTree(ServerPlayerEntity)''. If you don't send the updated command tree, the client may think a command still exists, even though the server will fail execution.
  
 +===== Can I execute command without typing in game? =====
 +Yes! You can. Before trying the next code, take note it works on Fabric 0.91.6+1.20.2 and it was not tested in other versions.
 +
 +Here is the code example
 +
 +<code java>
 +    private void vanillaCommandByPlayer(World world, BlockPos pos, String command) {
 +        PlayerEntity player = world.getClosestPlayer(pos.getX(), pos.getY(), pos.getZ(), 5, false);
 +        if (player != null) {
 +            CommandManager commandManager = Objects.requireNonNull(player.getServer()).getCommandManager();
 +            ServerCommandSource commandSource = player.getServer().getCommandSource();
 +            commandManager.executeWithPrefix(commandSource, command);
 +        }
 +    }
 +</code>
 +
 +First, you need a CommandManager<ServerCommandSource>.
 +Second, you need the ServerCommandSource.
 +Then, u can call some CommandManager public methods like commandeManader.execute. (.execute need ParseResults<ServerCommandSource>)
 +But commandeManader.executeWithPrefix allow you to use String. You can also put the slash (/).
 +
 +So... have fun!
tutorial/commands.1700304665.txt.gz · Last modified: 2023/11/18 10:51 by solidblock