Class endstone::Objective¶

ClassList > endstone > Objective

Represents an objective on a scoreboard that can show scores specific to entries.

#include <endstone/scoreboard/objective.h>

Public Functions¶

Type	Name
virtual const Criteria *	getCriteria () const = 0 Gets the criteria this objective tracks.
virtual std::optional< std::string >	getDisplayName () const = 0 Gets the name displayed to players for this objective.
virtual std::optional< DisplaySlot >	getDisplaySlot () const = 0 Gets the display slot this objective is displayed at.
virtual std::optional< std::string >	getName () const = 0 Gets the name of this Objective .
virtual std::optional< RenderType >	getRenderType () const = 0
virtual std::unique_ptr< Score >	getScore (ScoreEntry entry) const = 0 Gets an entry's Score for this objective.
virtual Scoreboard &	getScoreboard () const = 0 Gets the scoreboard to which this objective is attached.
virtual std::optional< ObjectiveSortOrder >	getSortOrder () const = 0 Gets the sort order for this objective.
virtual bool	isModifiable () const = 0 Gets if the objective's scores can be modified directly by a plugin.
virtual bool	operator!= (const Objective & other) const = 0
virtual bool	operator== (const Objective & other) const = 0
virtual void	setDisplay (std::optional< DisplaySlot > slot) = 0 Sets the display slot for this objective. This will remove it from any other display slot.
virtual void	setDisplay (std::optional< DisplaySlot > slot, ObjectiveSortOrder order) = 0 Sets the display slot and sort order for this objective. This will remove it from any other display slot.
virtual void	setDisplayName (std::string display_name) = 0 Sets the name displayed to players for this objective.
virtual void	setRenderType (RenderType render_type) = 0 Sets manner in which this objective will be rendered.
virtual void	unregister () const = 0 Unregisters this objective from the associated Scoreboard .
virtual	~Objective () = default

Public Functions Documentation¶

function getCriteria¶

Gets the criteria this objective tracks.

virtual const Criteria * endstone::Objective::getCriteria () const = 0

Returns:

this objective's criteria, or nullptr if this objective has been unregistered.

function getDisplayName¶

Gets the name displayed to players for this objective.

virtual std::optional< std::string > endstone::Objective::getDisplayName () const = 0

Returns:

this objective's display name

function getDisplaySlot¶

Gets the display slot this objective is displayed at.

virtual std::optional< DisplaySlot > endstone::Objective::getDisplaySlot () const = 0

Returns:

the display slot for this objective

function getName¶

Gets the name of this Objective .

virtual std::optional< std::string > endstone::Objective::getName () const = 0

Returns:

this objective's name

function getRenderType¶

virtual std::optional< RenderType > endstone::Objective::getRenderType () const = 0

Gets manner in which this objective will be rendered.

Returns:

the render type

function getScore¶

Gets an entry's Score for this objective.

virtual std::unique_ptr< Score > endstone::Objective::getScore (
    ScoreEntry entry
) const = 0

Parameters:

entry Entry for the Score

Returns:

Score tracking the Objective and entry specified

function getScoreboard¶

Gets the scoreboard to which this objective is attached.

virtual Scoreboard & endstone::Objective::getScoreboard () const = 0

Returns:

Owning scoreboard

function getSortOrder¶

Gets the sort order for this objective.

virtual std::optional< ObjectiveSortOrder > endstone::Objective::getSortOrder () const = 0

Returns:

The sort order for this objective.

function isModifiable¶

Gets if the objective's scores can be modified directly by a plugin.

virtual bool endstone::Objective::isModifiable () const = 0

Returns:

true if scores are modifiable

function operator!=¶

virtual bool endstone::Objective::operator!= (
    const Objective & other
) const = 0

function operator==¶

virtual bool endstone::Objective::operator== (
    const Objective & other
) const = 0

function setDisplay [½]¶

Sets the display slot for this objective. This will remove it from any other display slot.

virtual void endstone::Objective::setDisplay (
    std::optional< DisplaySlot > slot
) = 0

Parameters:

slot The display slot where this objective should be displayed.

function setDisplay [2/2]¶

Sets the display slot and sort order for this objective. This will remove it from any other display slot.

virtual void endstone::Objective::setDisplay (
    std::optional< DisplaySlot > slot,
    ObjectiveSortOrder order
) = 0

Parameters:

slot The display slot where this objective should be displayed.
order The sort order for this objective in the display slot.

function setDisplayName¶

Sets the name displayed to players for this objective.

virtual void endstone::Objective::setDisplayName (
    std::string display_name
) = 0

Parameters:

displayName Display name to set

function setRenderType¶

Sets manner in which this objective will be rendered.

virtual void endstone::Objective::setRenderType (
    RenderType render_type
) = 0

Parameters:

render_type new render type

function unregister¶

virtual void endstone::Objective::unregister () const = 0

function ~Objective¶

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

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