Class endstone::Player¶

ClassList > endstone > Player

Represents a player.

#include <endstone/player.h>

Inherits the following classes: endstone::Actor

Public Functions¶

Type	Name
	Player () = default
	Player (const Player &) = delete
	Player (Player &&) = delete
virtual Player *	asPlayer () override const Gets a CommandSender asPlayer .
virtual const SocketAddress &	getAddress () const = 0 Gets the socket address of this player.
virtual bool	getAllowFlight () const = 0 Determines if the Player is allowed to fly via jump key double-tap.
virtual endstone::UUID	getDeviceId () const = 0 Gets the player's current device id.
virtual std::string	getDeviceOS () const = 0 Gets the player's current device's operation system (OS).
virtual int	getExpLevel () const = 0 Gets the players current experience level.
virtual float	getExpProgress () const = 0 Gets the players current experience progress towards the next level.
virtual float	getFlySpeed () const = 0 Gets the current allowed speed that a client can fly.
virtual GameMode	getGameMode () const = 0 Gets this player's current GameMode.
virtual PlayerInventory &	getInventory () const = 0 Get the player's inventory.
virtual std::string	getLocale () const = 0 Gets the player's current locale.
virtual std::chrono::milliseconds	getPing () const = 0 Gets the player's average ping.
virtual const Skin &	getSkin () const = 0 Gets the player's skin.
virtual int	getTotalExp () const = 0 Gets the players total experience points.
virtual endstone::UUID	getUniqueId () const = 0 Returns the UUID of this player.
virtual float	getWalkSpeed () const = 0 Gets the current allowed speed that a client can walk.
virtual void	giveExp (int amount) = 0 Gives the player the amount of experience specified.
virtual void	giveExpLevels (int amount) = 0 Gives the player the amount of experience levels specified.
virtual bool	isFlying () const = 0 Checks to see if this player is currently flying or not.
virtual void	kick (std::string message) const = 0 Kicks player with custom kick message.
Player &	operator= (const Player &) = delete
Player &	operator= (Player &&) = delete
virtual bool	performCommand (std::string command) const = 0 Makes the player perform the given command.
virtual void	sendPopup (std::string message) const = 0 Sends this player a popup message.
virtual void	sendTip (std::string message) const = 0 Sends this player a tip message.
virtual void	setAllowFlight (bool flight) = 0 Sets if the Player is allowed to fly via jump key double-tap.
virtual void	setExpLevel (int level) = 0 Sets the players current experience level.
virtual void	setExpProgress (float progress) = 0 Sets the players current experience progress towards the next level.
virtual void	setFlySpeed (float value) const = 0
virtual void	setFlying (bool value) = 0 Makes this player start or stop flying.
virtual void	setGameMode (GameMode mode) = 0 Sets this player's current GameMode.
virtual void	setWalkSpeed (float value) const = 0
virtual void	updateCommands () const = 0 Send the list of commands to the client.
	~Player () override

Public Functions inherited from endstone::Actor¶

See endstone::Actor

Type	Name
	Actor () = default
	Actor (const Actor &) = delete
	Actor (Actor &&) = delete
virtual Dimension &	getDimension () const = 0
virtual Level &	getLevel () const = 0
virtual Location	getLocation () const = 0
virtual std::uint64_t	getRuntimeId () const = 0
virtual Vector< float >	getVelocity () const = 0
virtual bool	isInLava () const = 0
virtual bool	isInWater () const = 0
virtual bool	isOnGround () const = 0
Actor &	operator= (const Actor &) = delete
Actor &	operator= (Actor &&) = delete
	~Actor () override

Public Functions inherited from endstone::CommandSender¶

See endstone::CommandSender

Type	Name
	CommandSender () = default
virtual CommandSender *	asCommandSender () override const Casts a Permissible asCommandSender .
virtual CommandSender *	asConsole () const Gets a CommandSender as Console.
virtual Player *	asPlayer () const Gets a CommandSender asPlayer .
virtual std::string	getName () const = 0 Gets the name of this command sender.
virtual Server &	getServer () const = 0 Returns the server instance that this command is running on.
virtual void	sendErrorMessage (const std::string & message) const = 0 Sends this sender a error message.
virtual void	sendErrorMessage (const Translatable & message) const = 0 Sends this sender a translatable error message.
void	sendErrorMessage (const fmt::format_string< Args... > format, Args &&... args) const
virtual void	sendMessage (const std::string & message) const = 0 Sends this sender a message.
virtual void	sendMessage (const Translatable & message) const = 0 Sends this sender a translatable message.
void	sendMessage (const fmt::format_string< Args... > format, Args &&... args) const
	~CommandSender () override

Public Functions inherited from endstone::Permissible¶

See endstone::Permissible

Type	Name
virtual PermissionAttachment *	addAttachment (Plugin & plugin, const std::string & name, bool value) = 0
virtual PermissionAttachment *	addAttachment (Plugin & plugin) = 0
virtual CommandSender *	asCommandSender () const = 0
virtual std::unordered_set< PermissionAttachmentInfo * >	getEffectivePermissions () const = 0
virtual bool	hasPermission (std::string name) const = 0
virtual bool	hasPermission (const Permission & perm) const = 0
virtual bool	isOp () const = 0 Checks if this object is a server operator.
virtual bool	isPermissionSet (std::string name) const = 0
virtual bool	isPermissionSet (const Permission & perm) const = 0
virtual void	recalculatePermissions () = 0
virtual bool	removeAttachment (PermissionAttachment & attachment) = 0
virtual void	setOp (bool value) = 0 Sets the operator status of this object.
virtual	~Permissible () = default

Public Functions Documentation¶

function Player [⅓]¶

endstone::Player::Player () = default

function Player [⅔]¶

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

function Player [3/3]¶

endstone::Player::Player (
    Player &&
) = delete

function asPlayer¶

Gets a CommandSender asPlayer .

inline virtual Player * endstone::Player::asPlayer () override const

Returns:

Player, nullptr if not a Player

Implements endstone::CommandSender::asPlayer

function getAddress¶

Gets the socket address of this player.

virtual const SocketAddress & endstone::Player::getAddress () const = 0

Returns:

the player's socket address

function getAllowFlight¶

Determines if the Player is allowed to fly via jump key double-tap.

virtual bool endstone::Player::getAllowFlight () const = 0

Returns:

True if the player is allowed to fly.

function getDeviceId¶

Gets the player's current device id.

virtual endstone::UUID endstone::Player::getDeviceId () const = 0

Returns:

the player's device id

function getDeviceOS¶

Gets the player's current device's operation system (OS).

virtual std::string endstone::Player::getDeviceOS () const = 0

Returns:

the player's device OS

function getExpLevel¶

Gets the players current experience level.

virtual int endstone::Player::getExpLevel () const = 0

Returns:

Current experience level

function getExpProgress¶

Gets the players current experience progress towards the next level.

virtual float endstone::Player::getExpProgress () const = 0

This is a percentage value. 0.0 is "no progress" and 1.0 is "next level".

Returns:

Current experience points

function getFlySpeed¶

Gets the current allowed speed that a client can fly.

virtual float endstone::Player::getFlySpeed () const = 0

Returns:

The current allowed speed, default is 0.05.

function getGameMode¶

Gets this player's current GameMode.

virtual GameMode endstone::Player::getGameMode () const = 0

Returns:

Current game mode

function getInventory¶

Get the player's inventory.

virtual PlayerInventory & endstone::Player::getInventory () const = 0

Returns:

The inventory of the player, this also contains the armor slots.

function getLocale¶

Gets the player's current locale.

virtual std::string endstone::Player::getLocale () const = 0

Returns:

the player's locale

function getPing¶

Gets the player's average ping.

virtual std::chrono::milliseconds endstone::Player::getPing () const = 0

Returns:

player ping

function getSkin¶

Gets the player's skin.

virtual const Skin & endstone::Player::getSkin () const = 0

Returns:

the player's skin

function getTotalExp¶

Gets the players total experience points.

virtual int endstone::Player::getTotalExp () const = 0

This refers to the total amount of experience the player has collected over time and is not currently displayed to the client.

Returns:

Current total experience points

function getUniqueId¶

Returns the UUID of this player.

virtual endstone::UUID endstone::Player::getUniqueId () const = 0

Returns:

Player UUID

function getWalkSpeed¶

Gets the current allowed speed that a client can walk.

virtual float endstone::Player::getWalkSpeed () const = 0

Returns:

The current allowed speed, default is 0.10.

function giveExp¶

Gives the player the amount of experience specified.

virtual void endstone::Player::giveExp (
    int amount
) = 0

Parameters:

amount Exp amount to give

function giveExpLevels¶

Gives the player the amount of experience levels specified.

virtual void endstone::Player::giveExpLevels (
    int amount
) = 0

Parameters:

amount amount of experience levels to give or take

function isFlying¶

Checks to see if this player is currently flying or not.

virtual bool endstone::Player::isFlying () const = 0

Returns:

True if the player is flying, else false.

function kick¶

Kicks player with custom kick message.

virtual void endstone::Player::kick (
    std::string message
) const = 0

Parameters:

message kick message

function operator=¶

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

function operator=¶

Player & endstone::Player::operator= (
    Player &&
) = delete

function performCommand¶

Makes the player perform the given command.

virtual bool endstone::Player::performCommand (
    std::string command
) const = 0

Parameters:

command Command to perform

Returns:

true if the command was successful, otherwise false

function sendPopup¶

Sends this player a popup message.

virtual void endstone::Player::sendPopup (
    std::string message
) const = 0

Parameters:

message Message to be displayed

function sendTip¶

Sends this player a tip message.

virtual void endstone::Player::sendTip (
    std::string message
) const = 0

Parameters:

message Message to be displayed

function setAllowFlight¶

Sets if the Player is allowed to fly via jump key double-tap.

virtual void endstone::Player::setAllowFlight (
    bool flight
) = 0

Parameters:

flight If flight should be allowed.

function setExpLevel¶

Sets the players current experience level.

virtual void endstone::Player::setExpLevel (
    int level
) = 0

Parameters:

level New experience level

function setExpProgress¶

Sets the players current experience progress towards the next level.

virtual void endstone::Player::setExpProgress (
    float progress
) = 0

This is a percentage value. 0.0 is "no progress" and 1.0 is "next level".

Parameters:

progress New experience progress

function setFlySpeed¶

virtual void endstone::Player::setFlySpeed (
    float value
) const = 0

Sets the speed at which a client will fly.

Parameters:

value The new speed.

function setFlying¶

Makes this player start or stop flying.

virtual void endstone::Player::setFlying (
    bool value
) = 0

Parameters:

value True to fly.

function setGameMode¶

Sets this player's current GameMode.

virtual void endstone::Player::setGameMode (
    GameMode mode
) = 0

Parameters:

mode New game mode

function setWalkSpeed¶

virtual void endstone::Player::setWalkSpeed (
    float value
) const = 0

Sets the speed at which a client will walk.

Parameters:

value The new speed.

function updateCommands¶

Send the list of commands to the client.

virtual void endstone::Player::updateCommands () const = 0

Generally useful to ensure the client has a complete list of commands after permission changes are done.

function ~Player¶

endstone::Player::~Player () override

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