io.github.alshain01.flags.api.area
Interface Siegeable

All Superinterfaces:
Area, java.lang.Comparable<Area>

public interface Siegeable
extends Area

Defines areas that can be placed under siege by the area plugin


Nested Class Summary
 
Nested classes/interfaces inherited from interface io.github.alshain01.flags.api.area.Area
Area.AreaRelationship
 
Method Summary
 boolean canSiege(org.bukkit.entity.Player player)
          Checks if the area can be under siege by a specific player.
 boolean isUnderSiege()
          Checks if the area is under siege.
 
Methods inherited from interface io.github.alshain01.flags.api.area.Area
compareNameTo, compareTo, getAbsoluteMessage, getAbsoluteMessage, getAbsolutePermissionTrust, getAbsolutePlayerTrust, getAbsoluteRawMessage, getAbsoluteState, getAreaPlugin, getId, getMessage, getMessage, getName, getPermissionTrust, getPlayerTrust, getRawMessage, getRelationship, getState, getWorld, hasBundlePermission, hasFlagPermission, hasTrust, isArea, removeTrust, removeTrust, setMessage, setState, setTrust, setTrust
 

Method Detail

isUnderSiege

boolean isUnderSiege()
Checks if the area is under siege. Returns false if Area.isArea() would be false.

Returns:
true if the area is under siege

canSiege

boolean canSiege(@Nonnull
                 org.bukkit.entity.Player player)
Checks if the area can be under siege by a specific player. Returns false if Area.isArea() would be false.

Returns:
true if the area can be under siege by the player