LapisCoreCancellableEvent (LapisCore 1.12.4 API)

java.lang.Object
- org.bukkit.event.Event
- - net.lapismc.lapiscore.events.LapisCoreEvent
  - - net.lapismc.lapiscore.events.LapisCoreCancellableEvent

All Implemented Interfaces:: org.bukkit.event.Cancellable

public class LapisCoreCancellableEvent
extends LapisCoreEvent
implements org.bukkit.event.Cancellable

An utility class to make cancellable events

Nested Class Summary
- Nested classes/interfaces inherited from class org.bukkit.event.Event
  org.bukkit.event.Event.Result

Field Summary
- Fields inherited from class net.lapismc.lapiscore.events.LapisCoreEvent
  handlers

Constructor Summary

Constructors
Constructor Description

LapisCoreCancellableEvent()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getReason()`	Get the reason from `setCancelled(boolean, String)`
`boolean`	`isCancelled()`	Check if the event is cancelled
`void`	`setCancelled(boolean cancel)`	Deprecated.
`void`	`setCancelled(boolean cancel, java.lang.String reason)`	Cancel the event with a reason

Methods inherited from class net.lapismc.lapiscore.events.LapisCoreEvent
getHandlerList, getHandlers

Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LapisCoreCancellableEvent
```
public LapisCoreCancellableEvent()
```
- Method Detail
  - isCancelled
```
public boolean isCancelled()
```
    Check if the event is cancelled
    
    Specified by:
    
    isCancelled in interface org.bukkit.event.Cancellable
    
    Returns:
    
    Returns true if the event has been cancelled by an event listener
  - setCancelled
```
@Deprecated
public void setCancelled(boolean cancel)
```
    Deprecated.
    
    Please use setCancelled(boolean, String) to provide a reason for why you are cancelling the event
    
    Specified by:
    
    setCancelled in interface org.bukkit.event.Cancellable
    
    Parameters:
    
    cancel - The boolean value for the cancelled state of the event
  - setCancelled
```
public void setCancelled(boolean cancel,
                         java.lang.String reason)
```
    Cancel the event with a reason
    
    Parameters:
    
    cancel - True if the event should be cancelled
    
    reason - The reason to be sent to the player as to why the event was cancelled, Not all plugins implement this
  - getReason
```
public java.lang.String getReason()
```
    Get the reason from setCancelled(boolean, String)
    
    Returns:
    
    Returns the String reason as to why the event was cancelled, This will probably be null if the event is not cancelled