PlayerArgumentNode

java.lang.Object

me.efekos.simpler.commands.node.CommandNode

me.efekos.simpler.commands.node.ArgumentNode

me.efekos.simpler.commands.node.impl.PlayerArgumentNode

public class PlayerArgumentNode extends ArgumentNode

An example of custom ArgumentNodes. Can have the name of any player online as a value.

Constructor Summary

Constructors

Constructor

Description

PlayerArgumentNode(CommandNode... children)

Creates a new node.
Method Summary

Modifier and Type

Method

Description

boolean

isCorrect(String given)

Checks for a given argument and ensures that the argument is correct.

List<String>

suggest(org.bukkit.command.CommandSender sender, List<String> args)

Provides a list that can be added to the final list of tab completion.

Methods inherited from class me.efekos.simpler.commands.node.CommandNode
addChild, addChild, getChildren, getConsoleExecutive, getDescription, getExecutive, getParent, getPermission, setConsoleExecutive, setDescription, setExecutive, setParent, setPermission

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PlayerArgumentNode
  
  public PlayerArgumentNode(CommandNode... children)
  
  Creates a new node.
  
  Parameters:
  
  children - Any child nodes if you would like to add to this node. You can use CommandNode.addChild(CommandNode) for later.
Method Details
- isCorrect
  
  public boolean isCorrect(String given)
  
  Checks for a given argument and ensures that the argument is correct.
  
  Specified by:
  
  isCorrect in class ArgumentNode
  
  Parameters:
  
  given - Argument that was given for this node.
  
  Returns:
  
  Whether the argument is correct or not.
- suggest
  
  public List<String> suggest(org.bukkit.command.CommandSender sender, List<String> args)
  
  Provides a list that can be added to the final list of tab completion.
  
  Specified by:
  
  suggest in class CommandNode
  
  Parameters:
  
  sender - Sender that needs a tab completion. Probably a Player since console doesn't need a tab completion.
  
  args - List of the other arguments given by the sender.
  
  Returns:
  
  A list for tab completion.