Package net.neoforged.neoforge.event

Class CommandEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.event.CommandEvent
All Implemented Interfaces:
net.neoforged.bus.api.ICancellableEvent
public class CommandEvent extends net.neoforged.bus.api.Event implements net.neoforged.bus.api.ICancellableEvent
CommandEvent is fired after a command is parsed, but before it is executed. This event is fired during the invocation of Commands.performCommand(ParseResults, String).

This event is cancellable, and does not

invalid reference 
have a result
. If the event is cancelled, the command will not be executed.

This event is fired on the main Forge event bus, only on the logical server.

  • Field Details

    • parse

      private com.mojang.brigadier.ParseResults<CommandSourceStack> parse

    • exception

      @Nullable private @Nullable Throwable exception

  • Constructor Details

    • CommandEvent

      public CommandEvent(com.mojang.brigadier.ParseResults<CommandSourceStack> parse)

  • Method Details

    • getParseResults

      public com.mojang.brigadier.ParseResults<CommandSourceStack> getParseResults()
      Returns the parsed command results.
      Returns:
      the parsed command results

    • setParseResults

      public void setParseResults(com.mojang.brigadier.ParseResults<CommandSourceStack> parse)

    • getException

      @Nullable public @Nullable Throwable getException()
      Returns an exception to be thrown when performing the command, starts null.
      Returns:
      an exception to be thrown when performing the command, starts null

    • setException

      public void setException(@Nullable @Nullable Throwable exception)