Package com.griefdefender.api.event

Interface RemoveClaimEvent

All Superinterfaces:
net.kyori.event.Cancellable, ClaimEvent, Event
All Known Subinterfaces:
RemoveClaimEvent.Abandon, RemoveClaimEvent.Delete, RemoveClaimEvent.Expire
public interface RemoveClaimEvent extends ClaimEvent, net.kyori.event.Cancellable
An event that is fired after a Claim has been removed.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RemoveClaimEvent.Abandon
    Fired when a claim is abandoned.
    static interface 
    RemoveClaimEvent.Delete
    Fired when a claim is deleted.
    static interface 
    RemoveClaimEvent.Expire
    Fired when a claim has expired.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRestoring()
    Whether this claim will restore on removal.
    void
    shouldRestore(boolean restore)
    Whether this claim should restore back to original state on removal.
    Note: This setting will be ignored if auto-restore functionality is disabled.
    If nature restore is enabled, this will restore claim back to world gen state.
    If schematic restore is enabled, this will restore claim back to claim creation ClaimSchematic.

    Methods inherited from interface net.kyori.event.Cancellable

    cancelled, cancelled

    Methods inherited from interface com.griefdefender.api.event.ClaimEvent

    getClaim, getClaims, getMessage, getSource, getSourceUser, setMessage

    Methods inherited from interface com.griefdefender.api.event.Event

    getCause

  • Method Details

    • isRestoring

      boolean isRestoring()
      Whether this claim will restore on removal.
      Returns:
      Whether this claim will restore on removal.

    • shouldRestore

      void shouldRestore(boolean restore)
      Whether this claim should restore back to original state on removal.
      Note: This setting will be ignored if auto-restore functionality is disabled.
      If nature restore is enabled, this will restore claim back to world gen state.
      If schematic restore is enabled, this will restore claim back to claim creation ClaimSchematic.
      Parameters:
      shouldRestore - Whether this claim should restore back to original state