com.plotsquared.core.command.CommandCaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of PlotSquared-Core Show documentation

PlotSquared, a land and world management plugin for Minecraft.

There is a newer version: 6.11.2

/*
 *       _____  _       _    _____                                _
 *      |  __ \| |     | |  / ____|                              | |
 *      | |__) | | ___ | |_| (___   __ _ _   _  __ _ _ __ ___  __| |
 *      |  ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
 *      | |    | | (_) | |_ ____) | (_| | |_| | (_| | | |  __/ (_| |
 *      |_|    |_|\___/ \__|_____/ \__, |\__,_|\__,_|_|  \___|\__,_|
 *                                    | |
 *                                    |_|
 *            PlotSquared plot management system for Minecraft
 *               Copyright (C) 2014 - 2022 IntellectualSites
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU 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
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see .
 */
package com.plotsquared.core.command;

import com.plotsquared.core.configuration.caption.Caption;
import net.kyori.adventure.text.minimessage.Template;
import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * Any entity that is able to execute commands, receive messages & and have
 * permission nodes
 */
public interface CommandCaller {

    /**
     * Send a message to the command caller
     *
     * @param caption      Caption to send
     * @param replacements Variable replacements
     */
    void sendMessage(@NonNull Caption caption, @NonNull Template... replacements);

    /**
     * Check the player's permissions. Will be cached if permission caching is enabled.
     *
     * @param permission the name of the permission
     * @return if permission is had
     */
    boolean hasPermission(@NonNull String permission);

    /**
     * Get the type of the caller
     *
     * @return Caller type
     */
    RequiredType getSuperCaller();

}