Skip to content

Class endstone::BanList

template <typename T>

ClassList > endstone > BanList

Represents a ban list, containing bans. More...

  • #include <endstone/ban/ban_list.h>

Public Functions

Type Name
virtual T & addBan (std::string target, std::optional< std::string > reason, std::optional< BanEntry::Date > expires, std::optional< std::string > source) = 0
Adds a ban to this list. If a previous ban exists, this will update the previous entry.
virtual T & addBan (std::string target, std::optional< std::string > reason, std::chrono::seconds duration, std::optional< std::string > source) = 0
Adds a ban to this list. If a previous ban exists, this will update the previous entry.
virtual const T * getBanEntry (std::string target) const = 0
Gets a BanEntry by target.
virtual T * getBanEntry (std::string target) = 0
Gets a BanEntry by target.
virtual std::vector< const T * > getEntries () const = 0
Gets a vector containing pointers to every BanEntry in this list.
virtual std::vector< T * > getEntries () = 0
Gets a vector containing pointers to every BanEntry in this list.
virtual bool isBanned (std::string target) const = 0
Checks if a BanEntry exists for the target, indicating an active ban status.
virtual void removeBan (std::string target) = 0
Removes the specified target from this list, therefore indicating a "not banned" status.
virtual ~BanList () = default

Detailed Description

Template parameters:

  • T The ban target

Public Functions Documentation

function addBan [½]

Adds a ban to this list. If a previous ban exists, this will update the previous entry. 

virtual T & endstone::BanList::addBan (
    std::string target,
    std::optional< std::string > reason,
    std::optional< BanEntry::Date > expires,
    std::optional< std::string > source
) = 0

Parameters:

  • target The target of the ban.
  • reason The reason for the ban, std::nullopt indicates implementation default.
  • expires The date for the ban's expiration (unban), or std::nullopt to imply forever.
  • source The source of the ban, std::nullopt indicates implementation default.

Returns:

T& The entry for the newly created ban, or the entry for the (updated) previous ban.

function addBan [2/2]

Adds a ban to this list. If a previous ban exists, this will update the previous entry. 

virtual T & endstone::BanList::addBan (
    std::string target,
    std::optional< std::string > reason,
    std::chrono::seconds duration,
    std::optional< std::string > source
) = 0

Parameters:

  • target The target of the ban.
  • reason The reason for the ban, std::nullopt indicates implementation default.
  • duration The duration of the ban
  • source The source of the ban, std::nullopt indicates implementation default.

Returns:

T& The entry for the newly created ban, or the entry for the (updated) previous ban.

function getBanEntry [½]

Gets a BanEntry by target. 

virtual const T * endstone::BanList::getBanEntry (
    std::string target
) const = 0

Parameters:

  • target The entry parameter to search for.

Returns:

T* The corresponding entry, or nullptr if none found.

function getBanEntry [2/2]

Gets a BanEntry by target. 

virtual T * endstone::BanList::getBanEntry (
    std::string target
) = 0

Parameters:

  • target The entry parameter to search for.

Returns:

T* The corresponding entry, or nullptr if none found.

function getEntries [½]

Gets a vector containing pointers to every BanEntry in this list. 

virtual std::vector< const T * > endstone::BanList::getEntries () const = 0

Returns:

A vector containing pointers to every entry tracked by this list.

function getEntries [2/2]

Gets a vector containing pointers to every BanEntry in this list. 

virtual std::vector< T * > endstone::BanList::getEntries () = 0

Returns:

A vector containing pointers to every entry tracked by this list.

function isBanned

Checks if a BanEntry exists for the target, indicating an active ban status. 

virtual bool endstone::BanList::isBanned (
    std::string target
) const = 0

Parameters:

  • target The target to find.

Returns:

true If a BanEntry exists for the target, indicating an active ban status.

Returns:

false Otherwise.

function removeBan

Removes the specified target from this list, therefore indicating a "not banned" status. 

virtual void endstone::BanList::removeBan (
    std::string target
) = 0

Parameters:

  • target The target to remove from this list.

function ~BanList

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

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