CommandAPI 9.6.0
An API for the command UI introduced in Minecraft 1.13
dev.jorel.commandapi.executors.ResultingExecutor< CommandSender, WrapperType > Interface Template Reference

The interface for resulting command executors. More...

+ Inheritance diagram for dev.jorel.commandapi.executors.ResultingExecutor< CommandSender, WrapperType >:

Public Member Functions

default int executeWith (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
 Executes the command executor with the provided command sender and the provided arguments. More...
 
int run (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
 Executes the command. More...
 
default ExecutorType getType ()
 Returns the type of the sender of the current executor. More...
 

Detailed Description

The interface for resulting command executors.

Parameters
<CommandSender>The CommandSender for this executor
<WrapperType>The AbstractCommandSender that wraps the CommandSender

Member Function Documentation

◆ executeWith()

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

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

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

Implements dev.jorel.commandapi.executors.TypedExecutor< CommandSender, WrapperType >.

◆ getType()

default ExecutorType dev.jorel.commandapi.executors.TypedExecutor< CommandSender, WrapperType >.getType ( )
inherited

Returns the type of the sender of the current executor.

Returns
the type of the sender of the current executor

◆ run()

int dev.jorel.commandapi.executors.ResultingExecutor< CommandSender, WrapperType >.run ( ExecutionInfo< CommandSender, WrapperType >  info) throws WrapperCommandSyntaxException

Executes the command.

Parameters
infoThe ExecutionInfo for this command
Returns
the value returned by this command
Exceptions
WrapperCommandSyntaxExceptionif an error occurs during the execution of this command