net.lapismc.afkplus.api.AFKActionEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of AFKPlus Show documentation

AFK for professional servers

The newest version!

/*
 * Copyright 2021 Benjamin Martin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.lapismc.afkplus.api;

import net.lapismc.afkplus.playerdata.AFKPlusPlayer;

/**
 * A cancellable event to notify plugins when a player is acted upon
 * Cancelling this event is silent and will simply stop it from happening
 * If the player is still not active it is likely that the event will be fired in 1 seconds time
 * The action command can be changed
 */
public class AFKActionEvent extends AFKCommandEvent {

    private final AFKPlusPlayer player;

    /**
     * @param player  The player that the event is effecting
     * @param command The command that will be run with this event
     */
    public AFKActionEvent(AFKPlusPlayer player, String command) {
        super(command);
        this.player = player;
    }

    /**
     * Get the player that is being acted upon
     *
     * @return Returns the {@link AFKPlusPlayer} for the events target
     */
    public AFKPlusPlayer getPlayer() {
        return player;
    }


}