Package me.lucyy.squirtgun.command.node

Class HelpNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>

  • All Implemented Interfaces:
    CommandNode<T>
    public class HelpNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>
extends java.lang.Object
implements CommandNode<T>
    A command node that shows a help screen for another node that shows its description, usage, and argument information.
    Since:
    2.0.0

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpNode​(CommandNode<?> parentNode)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @Nullable net.kyori.adventure.text.Component execute​(CommandContext<T> context)
      Execute this node.
      @NotNull java.util.List<CommandArgument<?>> getArguments()
      Gets this command's arguments.
      java.lang.String getDescription()
      Gets this node's description for use in help commands.
      @NotNull java.lang.String getName()
      Gets this node's name, which will be used as a literal if needed.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HelpNode

        public HelpNode​(CommandNode<?> parentNode)

    • Method Detail

      • execute

        @Nullable
public @Nullable net.kyori.adventure.text.Component execute​(CommandContext<T> context)
        Description copied from interface: CommandNode
        Execute this node. This will only be executed if there are no further nodes in the chain.
        Specified by:
        execute in interface CommandNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>
        Parameters:
        context - the context that this command was executed in
        Returns:
        a component to optionally

      • getName

        @NotNull
public @NotNull java.lang.String getName()
        Description copied from interface: CommandNode
        Gets this node's name, which will be used as a literal if needed.
        Specified by:
        getName in interface CommandNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: CommandNode
        Gets this node's description for use in help commands. This should be a simple, one-line sentence.
        Specified by:
        getDescription in interface CommandNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>

      • getArguments

        @NotNull
public @NotNull java.util.List<CommandArgument<?>> getArguments()
        Description copied from interface: CommandNode
        Gets this command's arguments. By default, returns an empty list.
        Specified by:
        getArguments in interface CommandNode<T extends me.lucyy.squirtgun.platform.audience.PermissionHolder>