001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.events;
020
021
022import org.checkerframework.checker.nullness.qual.Nullable;
023
024/**
025 * PlotSquared event with {@link Result} to cancel, force, or allow.
026 */
027public interface CancellablePlotEvent {
028
029    /**
030     * The currently set {@link Result} for this event (as set by potential previous event listeners).
031     *
032     * @return the current result.
033     */
034    @Nullable Result getEventResult();
035
036    /**
037     * Set the {@link Result} for this event.
038     *
039     * @param eventResult the new result.
040     */
041    void setEventResult(@Nullable Result eventResult);
042
043    /**
044     * @deprecated No usage and not null-safe
045     */
046    @Deprecated(since = "7.3.2")
047    default int getEventResultRaw() {
048        return getEventResult() != null ? getEventResult().getValue() : -1;
049    }
050
051}