Package dev.boze.api.addon

Class AddonCommand

java.lang.Object
dev.boze.api.addon.AddonCommand
public abstract class AddonCommand extends Object
Base class for addon commands. All addon commands should extend this class.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AddonCommand(String name, String description)
    Creates a new addon command.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static <T> com.mojang.brigadier.builder.RequiredArgumentBuilder<net.minecraft.command.CommandSource,T>
    argument(String name, com.mojang.brigadier.arguments.ArgumentType<T> type)
    Helper method to create an argument for the command builder.
    abstract void
    build(com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.command.CommandSource> builder)
    Implement this method to build the command.
    String
    getDescription()
    Gets the command description.
    String
    getName()
    Gets the command name.
    protected static com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.command.CommandSource>
    literal(String name)
    Helper method to create a literal for the command builder.
    void
    register(com.mojang.brigadier.CommandDispatcher<net.minecraft.command.CommandSource> dispatcher)
    Registers this command to the dispatcher.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AddonCommand

      public AddonCommand(String name, String description)
      Creates a new addon command.
      Parameters:
      name - The name of the command
      description - A short description of what the command does

  • Method Details

    • argument

      protected static <T> com.mojang.brigadier.builder.RequiredArgumentBuilder<net.minecraft.command.CommandSource,T> argument(String name, com.mojang.brigadier.arguments.ArgumentType<T> type)
      Helper method to create an argument for the command builder.
      Parameters:
      name - The name of the argument
      type - The type of the argument
      Returns:
      A new argument builder

    • literal

      protected static com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.command.CommandSource> literal(String name)
      Helper method to create a literal for the command builder.
      Parameters:
      name - The name of the literal
      Returns:
      A new literal builder

    • register

      public void register(com.mojang.brigadier.CommandDispatcher<net.minecraft.command.CommandSource> dispatcher)
      Registers this command to the dispatcher.
      Parameters:
      dispatcher - The dispatcher to register to

    • build

      public abstract void build(com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.command.CommandSource> builder)
      Implement this method to build the command.
      Parameters:
      builder - The command builder

    • getName

      public String getName()
      Gets the command name.
      Returns:
      The command name

    • getDescription

      public String getDescription()
      Gets the command description.
      Returns:
      The command description