Class ProtectionPolicy

src/redempt/redlib/protection/ProtectionPolicy.java:26–460

Represents a set of rules in the form of ProtectionTypes protecting a set of blocks, which can have bypasses @author Redempt

 * @author Redempt
 */
public class ProtectionPolicy implements Listener {

    protected static Set<ProtectionPolicy> globalPolicies = new HashSet<>();
    protected static RegionMap<ProtectionPolicy> regionMap = new RegionMap<>();

    static {
        ProtectionRegistrations.registerProtections();
    }

    /**
     * Registers a custom event to be protected using a specific ProtectionType
     *
     * @param clazz     The event class of an event which implements {@link Cancellable}
     * @param type      The ProtectionType to protect against this event
     * @param getPlayer A function to get the player associated with the event - can return null
     * @param getBlocks A vararg of functions to get blocks associated with the event
     * @param <T>       The event type
     */
    public static <T extends Event & Cancellable> void registerProtection(Class<T> clazz, ProtectionType type, Function<T, Player> getPlayer, Function<T, Block>... getBlocks) {
        ProtectionListener.protect(clazz, type, getPlayer, getBlocks);
    }

    /**
     * Registers a custom event that cannot be cancelled using {@link Cancellable#setCancelled(boolean)} using a specific ProtectionType
     *
     * @param clazz     The event class
     * @param type      The ProtectionType to protect against this event
     * @param getPlayer A function to get the player associated with the event - can return null
     * @param cancel    A consumer to cancel the event
     * @param getBlocks A vararg of functions to get the blocks associated with this event
     * @param <T>       The event type
     */
    public static <T extends Event> void registerProtectionNonCancellable(Class<T> clazz, ProtectionType type, Function<T, Player> getPlayer, Consumer<T> cancel, Function<T, Block>... getBlocks) {
        ProtectionListener.protectNonCancellable(clazz, type, getPlayer, cancel, getBlocks);
    }

    /**
     * Registers a custom event that modifies multiple blocks to be protected using a specific ProtectionType
     *
     * @param clazz     The event class
     * @param type      The ProtectionType to protect against this event
     * @param getPlayer A function to get the player associated with the event - can return null
     * @param cancel    A function to cancel the modification of a specific block in the event
     * @param getBlocks A vararg of functions to get the blocks associated with the event
     * @param <T>       The event type
     */
    public static <T extends Event> void registerProtectionMultiBlock(Class<T> clazz, ProtectionType type, Function<T, Player> getPlayer, BiConsumer<T, Block> cancel, Function<T, List<Block>> getBlocks) {
        ProtectionListener.protectMultiBlock(clazz, type, getPlayer, cancel, getBlocks);
    }

    /**
     * Registers a custom event to be protected using a specific ProtectionType, where there is a block acting and blocks being acted upon
     *
     * @param clazz            The event class
     * @param type             The ProtectionType to protect against this event
     * @param getPlayer        A function to get the player associated with the event - can be null
     * @param getActingBlock   A function to get the block acting upon the other blocks, i.e. a piston pushing blocks or a water source spawning new water blocks
     * @param getSubjectBlocks A function to get the list of blocks being acted upon, i.e. the blocks being pushed by a piston or the water block being spawned