Skip to content

Class endstone::PlayerBanEntry

ClassList > endstone > PlayerBanEntry

Inherits the following classes: endstone::BanEntry

Public Types inherited from endstone::BanEntry

See endstone::BanEntry

Type Name
typedef std::chrono::system_clock::time_point Date

Public Static Attributes inherited from endstone::BanEntry

See endstone::BanEntry

Type Name
const std::string DateFormat = = "%FT%T%Ez"

Public Functions

Type Name
PlayerBanEntry (std::string name, std::optional< UUID > uuid=std::nullopt, std::optional< std::string > xuid=std::nullopt)
std::string getName () const
Gets the banned player's name.
std::optional< UUID > getUniqueId () const
Gets the banned player's unique id.
std::optional< std::string > getXuid () const
Gets the banned player's xbox user id (xuid).

Public Functions inherited from endstone::BanEntry

See endstone::BanEntry

Type Name
Date getCreated () const
Gets the date this ban entry was created.
std::optional< Date > getExpiration () const
Gets the date this ban expires on, or std::nullopt for no defined end date.
std::string getReason () const
Gets the reason for this ban.
std::string getSource () const
Gets the source of this ban.
void setCreated (Date created)
Sets the date this ban entry was created.
void setExpiration (std::optional< Date > expiration)
Sets the date this ban expires on. std::nullopt values are considered "infinite" bans.
void setReason (std::string reason)
Sets the reason for this ban.
void setSource (std::string source)
Sets the source of this ban.

Public Functions Documentation

function PlayerBanEntry

inline explicit endstone::PlayerBanEntry::PlayerBanEntry (
    std::string name,
    std::optional< UUID > uuid=std::nullopt,
    std::optional< std::string > xuid=std::nullopt
) 

function getName

Gets the banned player's name.

inline std::string endstone::PlayerBanEntry::getName () const

Returns:

the player name


function getUniqueId

Gets the banned player's unique id.

inline std::optional< UUID > endstone::PlayerBanEntry::getUniqueId () const

Returns:

the player's unique id, or std::nullopt if not available


function getXuid

Gets the banned player's xbox user id (xuid).

inline std::optional< std::string > endstone::PlayerBanEntry::getXuid () const

Returns:

the player's xbox user id (xuid), or std::nullopt if not available



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