Package net.lucypoulton.squirtgun.command.node

Class HelpNode

java.lang.Object

net.lucypoulton.squirtgun.command.node.HelpNode

All Implemented Interfaces:

CommandNode<PermissionHolder>

public class HelpNode
extends Object
implements CommandNode<PermissionHolder>

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

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.

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

next, withExtraCondition

Constructor Details

HelpNode

public HelpNode(CommandNode<?> parentNode)

Method Details

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

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

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>