Package net.lucypoulton.squirtgun.command.node.subcommand

Class SubcommandHelpNode

java.lang.Object

net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode

All Implemented Interfaces:

CommandNode<PermissionHolder>

public class SubcommandHelpNode
extends Object
implements CommandNode<PermissionHolder>

A help node for a subcommand. One optional argument is exposed, which determines a specific child node to show help for. If specified, a new HelpNode will be created for it and the output shown, otherwise a general overview of the command and its subnodes will be shown.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
SubcommandHelpNode(SubcommandNode parentNode)

Method Summary

Modifier and Type	Method	Description
@Nullable net.kyori.adventure.text.Component	execute(CommandContext context)	Execute this node.
@NotNull List<CommandArgument<?>>	getArguments()	Gets this command's arguments.
@NotNull Condition<PermissionHolder,? extends PermissionHolder>	getCondition()	Gets the condition needed to execute this node or any children.
String	getDescription()	Gets this node's description for use in help commands.
@NotNull String	getName()	Gets this node's name, which will be used as a literal if needed.
@Nullable CommandNode<?>	next(CommandContext context)	Returns the node following this node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lucypoulton.squirtgun.command.node.CommandNode

withExtraCondition

Constructor Details

SubcommandHelpNode

public SubcommandHelpNode(SubcommandNode parentNode)

Method Details

getArguments

@NotNull
public @NotNull 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<PermissionHolder>

getName

@NotNull
public @NotNull 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<PermissionHolder>

getDescription

public 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<PermissionHolder>

getCondition

@NotNull
public @NotNull Condition<PermissionHolder,? extends PermissionHolder> getCondition()

Description copied from interface: CommandNode

Gets the condition needed to execute this node or any children. If not needed, use PermissionHolder as T and return Condition.alwaysTrue()

Specified by:

getCondition in interface CommandNode<PermissionHolder>

Returns:

the condition

next

@Nullable
public @Nullable CommandNode<?> next(CommandContext context)

Description copied from interface: CommandNode

Returns the node following this node.

Specified by:

next in interface CommandNode<PermissionHolder>

Returns:

the next node in the chain, or if this is the end of the chain, null

execute

@Nullable
public @Nullable net.kyori.adventure.text.Component execute(CommandContext 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<PermissionHolder>

Parameters:

context - the context that this command was executed in

Returns:

a component to optionally