Class CommandServiceGrpc.CommandServiceBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<CommandServiceGrpc.CommandServiceBlockingV2Stub>
io.grpc.stub.AbstractBlockingStub<CommandServiceGrpc.CommandServiceBlockingV2Stub>
com.soulfiremc.grpc.generated.CommandServiceGrpc.CommandServiceBlockingV2Stub
Enclosing class:
CommandServiceGrpc
public static final class CommandServiceGrpc.CommandServiceBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<CommandServiceGrpc.CommandServiceBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service CommandService. 
Service for executing server commands and retrieving tab-completion suggestions.
Commands are executed using the Brigadier command framework and support various
operations including bot control, pathfinding, inventory management, and administration.
All operations require appropriate permissions based on the specified command scope.

  • Method Details

    • build

      protected CommandServiceGrpc.CommandServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<CommandServiceGrpc.CommandServiceBlockingV2Stub>

    • executeCommand

      public CommandResponse executeCommand(CommandRequest request) throws io.grpc.StatusException
      Executes a command string within the specified scope.
The command is parsed and executed using the Brigadier command dispatcher.
Permission requirements depend on the scope:
- Global scope: Requires GLOBAL_COMMAND_EXECUTION permission
- Instance scope: Requires INSTANCE_COMMAND_EXECUTION for the instance
- Bot scope: Requires INSTANCE_COMMAND_EXECUTION for the parent instance
Returns:
- CommandResponse with the command's exit code
Errors:
- INVALID_ARGUMENT: If the scope is not set
- PERMISSION_DENIED: If the user lacks required permissions
- INTERNAL: If an unexpected error occurs during execution
      Throws:
      io.grpc.StatusException

    • tabCompleteCommand

      public CommandCompletionResponse tabCompleteCommand(CommandCompletionRequest request) throws io.grpc.StatusException
      Retrieves tab-completion suggestions for a partial command.
Uses Brigadier's completion system to generate context-aware suggestions
based on the command structure and current cursor position.
Permission requirements depend on the scope (same as ExecuteCommand).
Returns:
- CommandCompletionResponse with a list of possible completions
Errors:
- INVALID_ARGUMENT: If the scope is not set
- PERMISSION_DENIED: If the user lacks required permissions
- INTERNAL: If an unexpected error occurs during completion
      Throws:
      io.grpc.StatusException