File command_sender.h

File List > command > command_sender.h

Go to the documentation of this file

// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
//
// 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.

#pragma once

#include <string>

#include <fmt/format.h>

#include "endstone/permissions/permissible.h"
#include "endstone/translatable.h"

namespace endstone {

class Server;
class Player;

class CommandSender : public Permissible {
public:
    CommandSender() = default;
    ~CommandSender() override = default;

    // Permissible
    [[nodiscard]] CommandSender *asCommandSender() const override
    {
        return const_cast<CommandSender *>(this);
    }

    [[nodiscard]] virtual CommandSender *asConsole() const
    {
        return nullptr;
    }

    [[nodiscard]] virtual Player *asPlayer() const
    {
        return nullptr;
    }

    virtual void sendMessage(const std::string &message) const = 0;

    virtual void sendMessage(const Translatable &message) const = 0;

    template <typename... Args>
    void sendMessage(const fmt::format_string<Args...> format, Args &&...args) const
    {
        sendMessage(fmt::format(format, std::forward<Args>(args)...));
    }

    virtual void sendErrorMessage(const std::string &message) const = 0;

    virtual void sendErrorMessage(const Translatable &message) const = 0;

    template <typename... Args>
    void sendErrorMessage(const fmt::format_string<Args...> format, Args &&...args) const
    {
        sendErrorMessage(fmt::format(format, std::forward<Args>(args)...));
    }

    [[nodiscard]] virtual Server &getServer() const = 0;

    [[nodiscard]] virtual std::string getName() const = 0;
};
}  // namespace endstone