gpg::Score

#include <score.h>

Single data structure which allows you to access data about a player's score.

Summary

Constructors and Destructors
Score()
Score(std::shared_ptr< const ScoreImpl > impl)
Explicit constructor.
Score(const Score & copy_from)
Copy constructor for copying an existing score into a new one.
Score(Score && move_from)
Constructor for moving an existing score into a new one.
~Score()

Public functions
Metadata() const
const std::string &
Returns score-related developer-specified metadata, if any was set for this score.
Rank() const
uint64_t
Returns rank of the player's score compared to those of other players.
Valid() const
bool
Returns true when the returned score is populated with data and is accompanied by a successful response status; false for an unpopulated user-created score or for a populated one accompanied by an unsuccessful response status.
Value() const
uint64_t
Returns the player's score.
operator=(const Score & copy_from)
Score &
Assignment operator for assigning this score's value from another score.
operator=(Score && move_from)
Score &
Assignment operator for assigning this score's value from another score.

Public functions

Metadata

const std::string & Metadata() const

Returns score-related developer-specified metadata, if any was set for this score.

Rank

uint64_t Rank() const

Returns rank of the player's score compared to those of other players.

Score

 Score()

Score

 Score(
  std::shared_ptr< const ScoreImpl > impl
)

Explicit constructor.

Score

 Score(
  const Score & copy_from
)

Copy constructor for copying an existing score into a new one.

Score

 Score(
  Score && move_from
)

Constructor for moving an existing score into a new one.

r-value-reference version.

Valid

bool Valid() const

Returns true when the returned score is populated with data and is accompanied by a successful response status; false for an unpopulated user-created score or for a populated one accompanied by an unsuccessful response status.

It must be true for the getter functions on this object to be usable.

Value

uint64_t Value() const

Returns the player's score.

operator=

Score & operator=(
  const Score & copy_from
)

Assignment operator for assigning this score's value from another score.

operator=

Score & operator=(
  Score && move_from
)

Assignment operator for assigning this score's value from another score.

r-value-reference version.

~Score

 ~Score()