File server.h

File List > endstone > server.h

Go to the documentation of this file

// Copyright (c) 2023, 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 <chrono>
#include <memory>
#include <string>
#include <string_view>
#include <vector>

#include "endstone/block/block_data.h"
#include "endstone/boss/boss_bar.h"
#include "endstone/lang/language.h"
#include "endstone/level/level.h"
#include "endstone/logger.h"
#include "endstone/player.h"
#include "endstone/scoreboard/scoreboard.h"
#include "endstone/util/result.h"
#include "endstone/util/uuid.h"

namespace endstone {

class ConsoleCommandSender;
class Scheduler;
class PluginCommand;
class PluginManager;

class Server {
public:
    Server() = default;
    Server(const Server &) = delete;
    Server &operator=(const Server &) = delete;

    virtual ~Server() = default;

    [[nodiscard]] virtual std::string getName() const = 0;

    [[nodiscard]] virtual std::string getVersion() const = 0;

    [[nodiscard]] virtual std::string getMinecraftVersion() const = 0;

    [[nodiscard]] virtual Logger &getLogger() const = 0;

    [[nodiscard]] virtual Language &getLanguage() const = 0;

    [[nodiscard]] virtual PluginManager &getPluginManager() const = 0;

    [[nodiscard]] virtual PluginCommand *getPluginCommand(std::string name) const = 0;

    [[nodiscard]] virtual ConsoleCommandSender &getCommandSender() const = 0;

    [[nodiscard]] virtual bool dispatchCommand(CommandSender &sender, std::string command_line) const = 0;

    [[nodiscard]] virtual Scheduler &getScheduler() const = 0;

    [[nodiscard]] virtual Level *getLevel() const = 0;

    [[nodiscard]] virtual std::vector<Player *> getOnlinePlayers() const = 0;

    [[nodiscard]] virtual int getMaxPlayers() const = 0;

    virtual Result<void> setMaxPlayers(int max_players) = 0;

    [[nodiscard]] virtual Player *getPlayer(endstone::UUID id) const = 0;

    [[nodiscard]] virtual bool getOnlineMode() const = 0;

    [[nodiscard]] virtual Player *getPlayer(std::string name) const = 0;

    virtual void shutdown() = 0;

    virtual void reload() = 0;

    virtual void reloadData() = 0;

    virtual void broadcast(const Message &message, const std::string &permission) const = 0;

    virtual void broadcastMessage(const Message &message) const = 0;

    template <typename... Args>
    void broadcastMessage(const fmt::format_string<Args...> format, Args &&...args) const
    {
        try {
            broadcastMessage(fmt::format(format, std::forward<Args>(args)...));
        }
        catch (std::exception &e) {
            getLogger().log(Logger::Error, e.what());
        }
    }

    [[nodiscard]] virtual bool isPrimaryThread() const = 0;

    [[nodiscard]] virtual Scoreboard *getScoreboard() const = 0;

    [[nodiscard]] virtual std::shared_ptr<Scoreboard> createScoreboard() = 0;

    virtual float getCurrentMillisecondsPerTick() = 0;

    virtual float getAverageMillisecondsPerTick() = 0;

    virtual float getCurrentTicksPerSecond() = 0;
    virtual float getAverageTicksPerSecond() = 0;

    virtual float getCurrentTickUsage() = 0;

    virtual float getAverageTickUsage() = 0;

    [[nodiscard]] virtual std::unique_ptr<BossBar> createBossBar(std::string title, BarColor color,
                                                                 BarStyle style) const = 0;

    [[nodiscard]] virtual std::unique_ptr<BossBar> createBossBar(std::string title, BarColor color, BarStyle style,
                                                                 std::vector<BarFlag> flags) const = 0;

    [[nodiscard]] virtual Result<std::shared_ptr<BlockData>> createBlockData(std::string type) const = 0;

    [[nodiscard]] virtual Result<std::shared_ptr<BlockData>> createBlockData(std::string type,
                                                                             BlockStates block_states) const = 0;

    [[nodiscard]] virtual std::chrono::system_clock::time_point getStartTime() = 0;

    inline static const std::string BroadcastChannelAdmin = "endstone.broadcast.admin";

    inline static const std::string BroadcastChannelUser = "endstone.broadcast.user";
};

}  // namespace endstone