net.lapismc.afkplus.playerdata.Permission 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.playerdata;


import net.lapismc.lapiscore.permissions.LapisPermission;

/**
 * This class is used to store the LapisPermissions that this plugin can access
 */
public enum Permission {

    AFKSelf(new AFKSelf()), AFKOthers(new AFKOthers()), FakeAFK(new FakeAFK()), TimeToAFK(new TimeToAFK()),
    TimeToWarning(new TimeToWarning()), TimeToAction(new TimeToAction()), CanUpdate(new Update());

    private final LapisPermission permission;

    Permission(LapisPermission permission) {
        this.permission = permission;
    }

    /**
     * Get the permission class for this enum item
     *
     * @return A LapisPermission class for this permission item
     */
    public LapisPermission getPermission() {
        return this.permission;
    }

    private static class AFKSelf extends LapisPermission {
        //Allows a player to set their own AFK status
        AFKSelf() {
            super("AFKSelf", 1);
        }
    }

    private static class AFKOthers extends LapisPermission {
        //Allows a player to set the AFK status of other players
        AFKOthers() {
            super("AFKOthers", 0);
        }
    }

    private static class FakeAFK extends LapisPermission {
        //Allows a player to enable a fake AFK state in an attempt to avoid user interactions
        //Suggested in issue #27 AFK+ Mod-Relief suggestion
        public FakeAFK() {
            super("FakeAFK", 0);
        }
    }

    private static class TimeToAFK extends LapisPermission {
        //The time in seconds of inactivity required to set a player AFK
        //setting this to -1 disables automatic AFK setting
        TimeToAFK() {
            super("TimeToAFK", 30);
        }
    }

    private static class TimeToWarning extends LapisPermission {
        //The time in seconds that a player must be AFK before being warned of action
        //Set to -1 to disable
        TimeToWarning() {
            super("TimeToWarning", 90);
        }
    }

    private static class TimeToAction extends LapisPermission {
        //The time in seconds that a player must be AFK before being acted upon
        //Action disabled if set to -1
        TimeToAction() {
            super("TimeToAction", 120);
        }
    }

    private static class Update extends LapisPermission {
        //Allows a player to update the plugin using /afkplus update
        Update() {
            super("CanUpdate", 0);
        }
    }
}