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
Next revisionBoth sides next revision
tutorial:commands [2019/11/16 02:14] – Simple Custom ArgumentType using UUIDArgumentType i509vcbtutorial:commands [2019/11/16 17:01] – Line numbers i509vcb
Line 439: Line 439:
 </code> </code>
  
-===== Custom Arguments (Coming Soon) =====+===== Custom Arguments =====
  
-Brigadier has support for custom argument types and this section goes into showing how to create a simple argument type. For this example we will create a UUIDArgumentType+Brigadier has support for custom argument types and this section goes into showing how to create a simple argument type.  
 + 
 +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.
  
 First create a class which extends ''ArgumentType''. Note that ArgumentType is a generic, so the generic will define what type the ArgumentType will return First create a class which extends ''ArgumentType''. Note that ArgumentType is a generic, so the generic will define what type the ArgumentType will return
  
-<code java>+<code java [enable_line_numbers="true"]>
 public class UUIDArgumentType implements ArgumentType<UUID> { public class UUIDArgumentType implements ArgumentType<UUID> {
 </code> </code>
Line 459: Line 463:
 Next you will store the current position of the cursor, this is so you can substring out only the specific argument. This will always be at the beginning of where your argument appears on the command line. Next you will store the current position of the cursor, this is so you can substring out only the specific argument. This will always be at the beginning of where your argument appears on the command line.
  
-<code java>+<code java [enable_line_numbers="true"]>
 int argBeginning = reader.getCursor(); // The starting position of the cursor is at the beginning of the argument. int argBeginning = reader.getCursor(); // The starting position of the cursor is at the beginning of the argument.
 if (!reader.canRead()) { if (!reader.canRead()) {
Line 468: Line 472:
 Now we grab the entire argument. Depending on your argument type, you may have a different criteria or be similar to some arguments where detecting a ''{'' on the command line will require it to be closed. For a UUID we will just figure out what cursor position the argument ends at. Now we grab the entire argument. Depending on your argument type, you may have a different criteria or be similar to some arguments where detecting a ''{'' on the command line will require it to be closed. For a UUID we will just figure out what cursor position the argument ends at.
  
-<code java>+<code java [enable_line_numbers="true"]>
 while (reader.canRead() && reader.peek() != ' ') { // peek provides the character at the current cursor position. while (reader.canRead() && reader.peek() != ' ') { // peek provides the character at the current cursor position.
     reader.skip(); // Tells the StringReader to move it's cursor to the next position.     reader.skip(); // Tells the StringReader to move it's cursor to the next position.
Line 476: Line 480:
 Then we will ask the StringReader what the current position of the cursor is an substring our argument out of the command line. Then we will ask the StringReader what the current position of the cursor is an substring our argument out of the command line.
  
-<code java>String uuidString = reader.getString().substring(argBeginning, reader.getCursor());</code>+<code java [enable_line_numbers="true"]>String uuidString = reader.getString().substring(argBeginning, reader.getCursor());</code>
  
 Now finally we check if our argument is correct and parse the specific argument to our liking, and throwing an exception if the parsing fails. Now finally we check if our argument is correct and parse the specific argument to our liking, and throwing an exception if the parsing fails.
  
-<code java>+<code java [enable_line_numbers="true"]>
 try { try {
     UUID uuid = UUID.fromString(uuidString); // Now our actual logic.     UUID uuid = UUID.fromString(uuidString); // Now our actual logic.
Line 495: Line 499:
 Within your ModInitializer (Not only client or server) you will add this so the client can recognize the argument when the command tree is sent. For more complex argument types, you may need to create your own ArgumentSerializer. Within your ModInitializer (Not only client or server) you will add this so the client can recognize the argument when the command tree is sent. For more complex argument types, you may need to create your own ArgumentSerializer.
  
-<code java>+<code java [enable_line_numbers="true"]>
 ArgumentTypes.register("mymod:uuid", UUIDArgumentType.class, new ConstantArgumentSerializer(UUIDArgumentType::uuid));  ArgumentTypes.register("mymod:uuid", UUIDArgumentType.class, new ConstantArgumentSerializer(UUIDArgumentType::uuid)); 
 // The argument should be what will create the ArgumentType. // The argument should be what will create the ArgumentType.
Line 502: Line 506:
 And here is the whole ArgumentType: And here is the whole ArgumentType:
  
-<file java UUIDArgumentType.java>+<file java UUIDArgumentType.java [enable_line_numbers="true"]>
  
 import com.mojang.brigadier.StringReader; import com.mojang.brigadier.StringReader;
tutorial/commands.txt · Last modified: 2024/02/23 14:22 by allen1210