Minestom/src/main/java/net/minestom/server/event/trait/CancellableEvent.java
2021-06-09 07:11:01 +02:00

26 lines
689 B
Java

package net.minestom.server.event.trait;
import net.minestom.server.event.Event;
import net.minestom.server.event.EventDispatcher;
/**
* Represents an {@link Event} which can be cancelled.
* Called using {@link EventDispatcher#callCancellable(CancellableEvent, Runnable)}.
*/
public interface CancellableEvent extends Event {
/**
* Gets if the {@link Event} should be cancelled or not.
*
* @return true if the event should be cancelled
*/
boolean isCancelled();
/**
* Marks the {@link Event} as cancelled or not.
*
* @param cancel true if the event should be cancelled, false otherwise
*/
void setCancelled(boolean cancel);
}