Class endstone::Server¶

ClassList > endstone > Server

Represents a server implementation.

#include <endstone/server.h>

Public Static Attributes¶

Type	Name
const std::string	BroadcastChannelAdmin = = "endstone.broadcast.admin" Used for all administrative messages, such as an operator using a command.
const std::string	BroadcastChannelUser = = "endstone.broadcast.user" Used for all announcement messages, such as informing users that a player has joined.

Public Functions¶

Type	Name
	Server () = default
	Server (const Server &) = delete
virtual void	broadcast (const std::string & message, const std::string & permission) const = 0 Broadcasts the specified message to every user with the given permission name.
virtual void	broadcastMessage (const std::string & message) const = 0 Broadcasts the specified message to every user with permission endstone.broadcast.user.
void	broadcastMessage (const fmt::format_string< Args... > format, Args &&... args) const
virtual bool	dispatchCommand (CommandSender & sender, std::string command) const = 0 Dispatches a command on this server, and executes it if found.
virtual CommandSender &	getCommandSender () const = 0 Gets a CommandSender for this server.
virtual Level *	getLevel (std::string name) const = 0 Gets the level with the given name.
virtual std::vector< Level * >	getLevels () const = 0 Gets a list of all levels on this server.
virtual Logger &	getLogger () const = 0 Returns the primary logger associated with this server instance.
virtual int	getMaxPlayers () const = 0 Get the maximum amount of players which can login to this server.
virtual std::string	getMinecraftVersion () const = 0 Gets the Minecraft version that this server is running.
virtual std::string	getName () const = 0 Gets the name of this server implementation.
virtual std::vector< Player * >	getOnlinePlayers () const = 0 Gets a list of all currently online players.
virtual Player *	getPlayer (endstone::UUID id) const = 0 Gets the player with the given UUID .
virtual Player *	getPlayer (std::string name) const = 0 Gets the player with the exact given name, case insensitive.
virtual PluginCommand *	getPluginCommand (std::string name) const = 0 Gets a PluginCommand with the given name or alias.
virtual PluginManager &	getPluginManager () const = 0 Gets the plugin manager for interfacing with plugins.
virtual Scheduler &	getScheduler () const = 0 Gets the scheduler for managing scheduled events.
virtual std::string	getVersion () const = 0 Gets the version string of this server implementation.
virtual bool	isPrimaryThread () const = 0 Checks the current thread against the expected primary server thread.
Server &	operator= (const Server &) = delete
virtual void	setMaxPlayers (int max_players) = 0 Set the maximum amount of players allowed to be logged in at once.
virtual	~Server () = default

Public Static Attributes Documentation¶

variable BroadcastChannelAdmin¶

const std::string endstone::Server::BroadcastChannelAdmin;

variable BroadcastChannelUser¶

const std::string endstone::Server::BroadcastChannelUser;

Public Functions Documentation¶

function Server [½]¶

endstone::Server::Server () = default

function Server [2/2]¶

endstone::Server::Server (
    const Server &
) = delete

function broadcast¶

Broadcasts the specified message to every user with the given permission name.

virtual void endstone::Server::broadcast (
    const std::string & message,
    const std::string & permission
) const = 0

Parameters:

message message to broadcast
permission the required permission Permissibles must have to receive the broadcast

function broadcastMessage [½]¶

Broadcasts the specified message to every user with permission endstone.broadcast.user.

virtual void endstone::Server::broadcastMessage (
    const std::string & message
) const = 0

Parameters:

message the message

function broadcastMessage [2/2]¶

template<typename... Args>
inline void endstone::Server::broadcastMessage (
    const fmt::format_string< Args... > format,
    Args &&... args
) const

function dispatchCommand¶

Dispatches a command on this server, and executes it if found.

virtual bool endstone::Server::dispatchCommand (
    CommandSender & sender,
    std::string command
) const = 0

Parameters:

sender the apparent sender of the command
command the command + arguments.

Returns:

true if execution is successful, false otherwise

function getCommandSender¶

Gets a CommandSender for this server.

virtual CommandSender & endstone::Server::getCommandSender () const = 0

Returns:

a console command sender

function getLevel¶

Gets the level with the given name.

virtual Level * endstone::Server::getLevel (
    std::string name
) const = 0

Parameters:

name the name of the level to retrieve

Returns:

a level with the given name, or nullptr if none exists

function getLevels¶

Gets a list of all levels on this server.

virtual std::vector< Level * > endstone::Server::getLevels () const = 0

Returns:

a list of levels

function getLogger¶

Returns the primary logger associated with this server instance.

virtual Logger & endstone::Server::getLogger () const = 0

Returns:

Logger associated with this server

function getMaxPlayers¶

Get the maximum amount of players which can login to this server.

virtual int endstone::Server::getMaxPlayers () const = 0

Returns:

the amount of players this server allows

function getMinecraftVersion¶

Gets the Minecraft version that this server is running.

virtual std::string endstone::Server::getMinecraftVersion () const = 0

Returns:

version of Minecraft

function getName¶

Gets the name of this server implementation.

virtual std::string endstone::Server::getName () const = 0

Returns:

name of this server implementation

function getOnlinePlayers¶

Gets a list of all currently online players.

virtual std::vector< Player * > endstone::Server::getOnlinePlayers () const = 0

Returns:

a list of currently online players.

function getPlayer [½]¶

Gets the player with the given UUID .

virtual Player * endstone::Server::getPlayer (
    endstone::UUID id
) const = 0

Parameters:

id UUID of the player to retrieve

Returns:

a player object if one was found, null otherwise

function getPlayer [2/2]¶

Gets the player with the exact given name, case insensitive.

virtual Player * endstone::Server::getPlayer (
    std::string name
) const = 0

Parameters:

name Exact name of the player to retrieve

Returns:

a player object if one was found, null otherwise

function getPluginCommand¶

Gets a PluginCommand with the given name or alias.

virtual PluginCommand * endstone::Server::getPluginCommand (
    std::string name
) const = 0

Parameters:

name the name of the command to retrieve

Returns:

a plugin command if found, null otherwise

function getPluginManager¶

Gets the plugin manager for interfacing with plugins.

virtual PluginManager & endstone::Server::getPluginManager () const = 0

Returns:

a plugin manager for this Server instance

function getScheduler¶

Gets the scheduler for managing scheduled events.

virtual Scheduler & endstone::Server::getScheduler () const = 0

Returns:

a scheduling service for this server

function getVersion¶

Gets the version string of this server implementation.

virtual std::string endstone::Server::getVersion () const = 0

Returns:

version of this server implementation

function isPrimaryThread¶

Checks the current thread against the expected primary server thread.

virtual bool endstone::Server::isPrimaryThread () const = 0

Returns:

true if the current thread matches the expected primary thread, false otherwise

function operator=¶

Server & endstone::Server::operator= (
    const Server &
) = delete

function setMaxPlayers¶

Set the maximum amount of players allowed to be logged in at once.

virtual void endstone::Server::setMaxPlayers (
    int max_players
) = 0

Parameters:

maxPlayers The maximum amount of concurrent players

function ~Server¶

virtual endstone::Server::~Server () = default

The documentation for this class was generated from the following file include/endstone/server.h