Skip to content

Class endstone::SimplePie

ClassList > endstone > SimplePie

A bStats pie chart with a single value.

  • #include <endstone/metrics/simple_pie.h>

Inherits the following classes: endstone::CustomChart

Public Types

Type Name
typedef std::function< std::optional< std::string >()> Callback

Public Functions

Type Name
SimplePie (std::string chart_id, Callback get_value)
virtual std::optional< JsonObject > getChartData () override
Gets the data for this chart.

Public Functions inherited from endstone::CustomChart

See endstone::CustomChart

Type Name
CustomChart (std::string chart_id)
Creates a chart with the given bStats chart id.
CustomChart (const CustomChart &) = delete
CustomChart (CustomChart &&) = delete
virtual std::optional< JsonObject > getChartData () = 0
Gets the data for this chart.
const std::string & getChartId () noexcept const
Gets the id of this chart.
CustomChart & operator= (const CustomChart &) = delete
CustomChart & operator= (CustomChart &&) = delete
virtual ~CustomChart () = default

Public Types Documentation

typedef Callback

using endstone::SimplePie::Callback =  std::function<std::optional<std::string>()>;

Public Functions Documentation

function SimplePie

inline endstone::SimplePie::SimplePie (
    std::string chart_id,
    Callback get_value
) 

function getChartData

Gets the data for this chart.

inline virtual std::optional< JsonObject > endstone::SimplePie::getChartData () override

This is called on the primary server thread. Returning no value omits the chart from the submission.

Returns:

the chart data, or no value to skip this chart

Implements endstone::CustomChart::getChartData



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