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
021import com.plotsquared.core.plot.Plot;
022import com.plotsquared.core.plot.PlotId;
023
024/**
025 * Called when a plot is cleared
026 */
027public class PlotDoneEvent extends PlotEvent implements CancellablePlotEvent {
028
029    private Result eventResult;
030
031    /**
032     * PlotDoneEvent: Called when a plot is being set as done
033     *
034     * @param plot The plot being set as done
035     */
036    public PlotDoneEvent(Plot plot) {
037        super(plot);
038    }
039
040    /**
041     * Get the PlotId.
042     *
043     * @return PlotId
044     */
045    public PlotId getPlotId() {
046        return getPlot().getId();
047    }
048
049    /**
050     * Get the world name.
051     *
052     * @return String
053     */
054    public String getWorld() {
055        return getPlot().getWorldName();
056    }
057
058    @Override
059    public Result getEventResult() {
060        return eventResult;
061    }
062
063    @Override
064    public void setEventResult(Result e) {
065        this.eventResult = e;
066    }
067
068}