gpg::ParticipantResults

#include <participant_results.h>

A data structure containing data about the per-participant results for a TurnBasedMatch.

Summary

Constructors and Destructors
ParticipantResults()
ParticipantResults(std::shared_ptr< const ParticipantResultsImpl > impl)
Constructs a ParticipantResults object from a shared_ptr to a ParticipantResultsImpl.
ParticipantResults(const ParticipantResults & copy_from)
Creates a copy of an existing ParticipantResults object.
ParticipantResults(ParticipantResults && move_from)
Moves an existing ParticipantResults object.

Public functions
HasResultsForParticipant(const std::string & participant_id) const
bool
Returns true if this ParticipantResults object has a result for the given MultiplayerParticipant.
MatchResultForParticipant(const std::string & participant_id) const
Returns the MatchResult for the specified participant within a TurnBasedMatch.
PlaceForParticipant(const std::string & participant_id) const
uint32_t
Returns the placing of the specified participant within a TurnBasedMatch.
Valid() const
bool
Returns true if this ParticipantResults object is populated with data.
WithResult(const std::string & participant_id, uint32_t placing, MatchResult result) const
Creates a new ParticipantResults that contains all existing results and the additional result data passed into this function.
operator=(const ParticipantResults & copy_from)
Assigns this ParticipantResults object from another one.
operator=(ParticipantResults && move_from)
Assigns this ParticipantResults object by moving another one into it.

Public functions

HasResultsForParticipant

bool HasResultsForParticipant(
  const std::string & participant_id
) const

Returns true if this ParticipantResults object has a result for the given MultiplayerParticipant.

Valid must return true for this function to be usable.

MatchResultForParticipant

MatchResult MatchResultForParticipant(
  const std::string & participant_id
) const

Returns the MatchResult for the specified participant within a TurnBasedMatch.

Note that not all participants may have a MatchResult; if HasResultsForParticipant does not return true, this function will return MatchResult::NONE. Valid must return true for this function to be usable.

ParticipantResults

 ParticipantResults()

ParticipantResults

 ParticipantResults(
  std::shared_ptr< const ParticipantResultsImpl > impl
)

Constructs a ParticipantResults object from a shared_ptr to a ParticipantResultsImpl.

Intended for internal use by the API.

ParticipantResults

 ParticipantResults(
  const ParticipantResults & copy_from
)

Creates a copy of an existing ParticipantResults object.

ParticipantResults

 ParticipantResults(
  ParticipantResults && move_from
)

Moves an existing ParticipantResults object.

PlaceForParticipant

uint32_t PlaceForParticipant(
  const std::string & participant_id
) const

Returns the placing of the specified participant within a TurnBasedMatch.

Note that not all participants may have results; if HasResultsForParticipant does not return true, this function will return 0 for a player who is not yet ranked. Valid must return true for this function to be usable.

Valid

bool Valid() const

Returns true if this ParticipantResults object is populated with data.

Must be true in order for the getter functions (PlaceForParticipant, MatchResultForParticipant, etc...) on this ParticipantResults object to be usable.

WithResult

ParticipantResults WithResult(
  const std::string & participant_id,
  uint32_t placing,
  MatchResult result
) const

Creates a new ParticipantResults that contains all existing results and the additional result data passed into this function.

Note that a result can only be set once per participant. Attempting to set more than one result will log an error and leave the ParticipantResults unmodified. Valid must return true for this function to be usable.

Details
Parameters
participant_id
The MultiplayerParticipant for which to add a result.
placing
The placing for the participant within the match.
result
The MatchResult for the participant within the match.

operator=

ParticipantResults & operator=(
  const ParticipantResults & copy_from
)

Assigns this ParticipantResults object from another one.

operator=

ParticipantResults & operator=(
  ParticipantResults && move_from
)

Assigns this ParticipantResults object by moving another one into it.