Interface IClaimingModeAPI


public interface IClaimingModeAPI
A claiming mode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Checks whether this claiming mode can be used when impersonating another player.
    Gets the String ID of the claiming mode.
    boolean
    Checks whether this is a global claiming mode that is exactly the same for every player.
  • Method Details

    • getId

      @Nonnull String getId()
      Gets the String ID of the claiming mode.
      Returns:
      the String ID, not null
    • isGlobal

      boolean isGlobal()
      Checks whether this is a global claiming mode that is exactly the same for every player.

      For example, player and party modes are not global because they depend on the player while server mode is global.

      Returns:
      true if this is a global claiming mode, otherwise false
    • canBeImpersonated

      boolean canBeImpersonated()
      Checks whether this claiming mode can be used when impersonating another player.

      The use of the claiming mode won't be prevented but the impersonation will be ignored if this method returns false.

      Returns:
      true if this claiming mode can be impersonated, otherwise false