DungeonsXL/api/src/main/java/de/erethon/dungeonsxl/api/event/player/GamePlayerFinishEvent.java

/*
 * Copyright (C) 2014-2023 Daniel Saukel
 *
 * This library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser 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 GNULesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package de.erethon.dungeonsxl.api.event.player;

import de.erethon.dungeonsxl.api.player.GamePlayer;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;

/**
 * Fired when a player finishs a game.
 * <p>
 * Do not confuse this with {@link de.erethon.dungeonsxl.api.event.group.GroupFinishDungeonEvent}. GamePlayerFinishEvent is fired when a player triggers an end
 * sign, while GroupFinishDungeonEvent is triggered when all group members have triggered the ready sign and the game actually ends.
 *
 * @author Daniel Saukel
 */
public class GamePlayerFinishEvent extends GamePlayerEvent implements Cancellable {

    private static final HandlerList handlers = new HandlerList();
    private boolean cancelled;

    private boolean hasToWait;

    public GamePlayerFinishEvent(GamePlayer gamePlayer, boolean hasToWait) {
        super(gamePlayer);
        this.hasToWait = hasToWait;
    }

    /**
     * Returns false if the other group members have all already triggered the end sign, true if not.
     *
     * @return false if the other group members have all already triggered the end sign, true if not
     */
    public boolean getHasToWait() {
        return hasToWait;
    }

    @Override
    public HandlerList getHandlers() {
        return handlers;
    }

    public static HandlerList getHandlerList() {
        return handlers;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancelled) {
        this.cancelled = cancelled;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "{player=" + globalPlayer + "; hasToWait=" + hasToWait + "}";
    }

}