CommandAPI 9.6.0
An API for the command UI introduced in Minecraft 1.13
dev.jorel.commandapi.executors.PlayerCommandExecutor Interface Reference

A normal command executor for a Player. More...

+ Inheritance diagram for dev.jorel.commandapi.executors.PlayerCommandExecutor:

Public Member Functions

void run (Player sender, CommandArguments args) throws WrapperCommandSyntaxException
 The code to run when this command is performed. More...
 
default void run (ExecutionInfo< Player, BukkitPlayer > info) throws WrapperCommandSyntaxException
 The code to run when this command is performed. More...
 
default ExecutorType getType ()
 Returns the type of the sender of the current executor. More...
 
default int executeWith (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
 Executes the command executor with the provided command sender and the provided arguments. More...
 
void run (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
 Executes the command. More...
 

Detailed Description

A normal command executor for a Player.

Member Function Documentation

◆ executeWith()

default int dev.jorel.commandapi.executors.NormalExecutor< CommandSender, WrapperType >.executeWith ( ExecutionInfo< CommandSender, WrapperType >  info) throws WrapperCommandSyntaxException
inherited

Executes the command executor with the provided command sender and the provided arguments.

Parameters
infoThe ExecutionInfo for this command
Returns
1 if the command succeeds, 0 if the command fails
Exceptions
WrapperCommandSyntaxExceptionif an error occurs during the execution of this command

◆ getType()

default ExecutorType dev.jorel.commandapi.executors.PlayerCommandExecutor.getType ( )

Returns the type of the sender of the current executor.

Returns
the type of the sender of the current executor

◆ run() [1/3]

void dev.jorel.commandapi.executors.NormalExecutor< CommandSender, WrapperType >.run ( ExecutionInfo< CommandSender, WrapperType >  info) throws WrapperCommandSyntaxException
inherited

Executes the command.

Parameters
infoThe ExecutionInfo for this command
Exceptions
WrapperCommandSyntaxExceptionif an error occurs during the execution of this command

◆ run() [2/3]

default void dev.jorel.commandapi.executors.PlayerCommandExecutor.run ( ExecutionInfo< Player, BukkitPlayer info) throws WrapperCommandSyntaxException

The code to run when this command is performed.

Parameters
infoThe ExecutionInfo for this command

◆ run() [3/3]

void dev.jorel.commandapi.executors.PlayerCommandExecutor.run ( Player  sender,
CommandArguments  args 
) throws WrapperCommandSyntaxException

The code to run when this command is performed.

Parameters
senderThe sender of this command (a player, the console etc.)
argsThe arguments given to this command.