Stargate/src/main/java/net/knarcraft/stargate/event/StargateActivateEvent.java

package net.knarcraft.stargate.event;

import net.knarcraft.stargate.Portal;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;

import java.util.List;

/**
 * This event should be called whenever a player activates a stargate
 * <p>Activation of a stargate happens when a player right-clicks the sign of a stargate.</p>
 */
@SuppressWarnings("unused")
public class StargateActivateEvent extends StargatePlayerEvent {

    private static final HandlerList handlers = new HandlerList();
    private List<String> destinations;
    private String destination;

    /**
     * Instantiates a new stargate activate event
     *
     * @param portal       <p>The activated portal</p>
     * @param player       <p>The player activating the portal</p>
     * @param destinations <p>The destinations available to the player using the portal</p>
     * @param destination  <p>The chosen destination to activate</p>
     */
    public StargateActivateEvent(Portal portal, Player player, List<String> destinations, String destination) {
        super("StargatActivateEvent", portal, player);

        this.destinations = destinations;
        this.destination = destination;
    }

    /**
     * Gets a handler-list containing all event handlers
     *
     * @return <p>A handler-list with all event handlers</p>
     */
    public static HandlerList getHandlerList() {
        return handlers;
    }

    /**
     * Gets the destinations available for the portal
     *
     * @return <p>The destinations available for the portal</p>
     */
    public List<String> getDestinations() {
        return destinations;
    }

    /**
     * Sets the destinations available to the player using the portal
     *
     * @param destinations <p>The new list of available destinations</p>
     */
    public void setDestinations(List<String> destinations) {
        this.destinations = destinations;
    }

    /**
     * Gets the chosen destination to activate
     *
     * @return <p>The chosen destination to activate</p>
     */
    public String getDestination() {
        return destination;
    }

    /**
     * Sets (changes) the chosen destination to activate
     *
     * @param destination <p>The new destination to activate</p>
     */
    public void setDestination(String destination) {
        this.destination = destination;
    }

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

}