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.player.PlotPlayer;
022import com.plotsquared.core.plot.Plot;
023
024import java.util.UUID;
025
026/**
027 *
028 */
029public class PlayerPlotHelperEvent extends PlotEvent {
030
031    private final PlotPlayer<?> initiator;
032    private final boolean added;
033    private final UUID player;
034
035    /**
036     * PlayerPlotHelperEvent: Called when a plot helper is added/removed
037     *
038     * @param initiator Player that initiated the event
039     * @param plot      Plot in which the event occurred
040     * @param player    Player that was added/removed from the helper list
041     * @param added     {@code true} if the player was added, {@code false} if the player was removed
042     */
043    public PlayerPlotHelperEvent(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added) {
044        super(plot);
045        this.initiator = initiator;
046        this.added = added;
047        this.player = player;
048    }
049
050    /**
051     * If a player was added
052     *
053     * @return boolean
054     */
055    public boolean wasAdded() {
056        return this.added;
057    }
058
059    /**
060     * The UUID added/removed
061     *
062     * @return UUID
063     */
064    public UUID getPlayer() {
065        return this.player;
066    }
067
068    /**
069     * The player initiating the action
070     *
071     * @return PlotPlayer
072     */
073    public PlotPlayer<?> getInitiator() {
074        return this.initiator;
075    }
076
077}