com.plotsquared.core.events.CancellablePlotEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plotsquared-core Show documentation

PlotSquared, a land and world management plugin for Minecraft.

There is a newer version: 7.4.1

/*
 * PlotSquared, a land and world management plugin for Minecraft.
 * Copyright (C) IntellectualSites 
 * Copyright (C) IntellectualSites team and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.plotsquared.core.events;


import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * PlotSquared event with {@link Result} to cancel, force, or allow.
 */
public interface CancellablePlotEvent {

    /**
     * The currently set {@link Result} for this event (as set by potential previous event listeners).
     *
     * @return the current result.
     */
    @Nullable Result getEventResult();

    /**
     * Set the {@link Result} for this event.
     *
     * @param eventResult the new result.
     */
    void setEventResult(@Nullable Result eventResult);

    /**
     * @deprecated No usage and not null-safe
     */
    @Deprecated(since = "7.3.2")
    default int getEventResultRaw() {
        return getEventResult() != null ? getEventResult().getValue() : -1;
    }

}