Files
MinecraftForge/src/main/java/net/minecraftforge/event/CommandEvent.java
T

65 lines
1.8 KiB
Java
Raw Normal View History

/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.event;
import com.mojang.brigadier.ParseResults;
2021-07-17 00:08:49 -05:00
import net.minecraft.commands.CommandSourceStack;
import net.minecraft.commands.Commands;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.eventbus.api.Cancelable;
import net.minecraftforge.eventbus.api.Event;
2022-07-28 00:20:31 -05:00
import net.minecraftforge.fml.LogicalSide;
import org.jetbrains.annotations.Nullable;
/**
* CommandEvent is fired after a command is parsed, but before it is executed.
2022-07-28 00:20:31 -05:00
* This event is fired during the invocation of {@link Commands#performCommand(ParseResults, String)}.
* <p>
* This event is {@linkplain Cancelable cancellable}, and does not {@linkplain HasResult have a result}.
* If the event is cancelled, the command will not be executed.
* <p>
* This event is fired on the {@linkplain MinecraftForge#EVENT_BUS main Forge event bus},
* only on the {@linkplain LogicalSide#SERVER logical server}.
**/
@Cancelable
public class CommandEvent extends Event
{
2021-07-17 00:08:49 -05:00
private ParseResults<CommandSourceStack> parse;
2022-07-28 00:20:31 -05:00
@Nullable
private Throwable exception;
2021-07-17 00:08:49 -05:00
public CommandEvent(ParseResults<CommandSourceStack> parse)
{
this.parse = parse;
}
2022-07-28 00:20:31 -05:00
/**
* {@return the parsed command results}
*/
public ParseResults<CommandSourceStack> getParseResults()
{
return this.parse;
}
public void setParseResults(ParseResults<CommandSourceStack> parse)
{
this.parse = parse;
}
/**
* {@return an exception to be thrown when performing the command, starts null}
*/
@Nullable
public Throwable getException()
{
return this.exception;
}
public void setException(@Nullable Throwable exception)
{
this.exception = exception;
}
}