Enum Class ClaimingAction

java.lang.Object
java.lang.Enum<ClaimingAction>
xaero.pac.common.claims.action.api.ClaimingAction
All Implemented Interfaces:
Serializable, Comparable<ClaimingAction>, Constable

public enum ClaimingAction extends Enum<ClaimingAction>
All possible types of claiming actions
  • Enum Constant Details

    • CLAIM

      public static final ClaimingAction CLAIM
      Claiming a chunk
    • UNCLAIM

      public static final ClaimingAction UNCLAIM
      Unclaiming a chunk
    • FORCELOAD

      public static final ClaimingAction FORCELOAD
      Marking a claim for forceloading
    • UNFORCELOAD

      public static final ClaimingAction UNFORCELOAD
      Unmarking a claim for forceloading
    • UNCLAIM_UNANCHORED

      public static final ClaimingAction UNCLAIM_UNANCHORED
      Unclaiming a chunk if it's not anchored
    • ANCHOR

      public static final ClaimingAction ANCHOR
      Adding a claiming anchor
    • UNANCHOR

      public static final ClaimingAction UNANCHOR
      Removing a claiming anchor
  • Method Details

    • values

      public static ClaimingAction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ClaimingAction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getSuccessType

      public ClaimResult.Type getSuccessType()
      Gets the result type that is used when this type of action succeeds.
      Returns:
      the success result type, not null
    • isUninterruptible

      public boolean isUninterruptible()
      Gets whether this claiming action is uninterruptible with the interrupt command.
      Returns:
      true if it's uninterruptible, otherwise false
    • getAlwaysChecksAnchors

      public boolean getAlwaysChecksAnchors()
      Gets whether this action always checks anchor ranges, even when used forcefully.
      Returns:
      true if this action always checks anchor ranges, otherwise false
    • canAffectArea

      public boolean canAffectArea()
      Gets whether this action can be used to affect an area larger than 1 chunk.
      Returns:
      true if this action can be used to affect an area, otherwise false