gpg::MultiplayerParticipant

#include <multiplayer_participant.h>

A data structure containing data about a participant in a multiplayer match.

Summary

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

Public functions
AvatarUrl(ImageResolution resolution) const	const std::string & Returns the URL where the image of this MultiplayerParticipant's avatar resides.
DisplayName() const	const std::string & The display name for this MultiplayerParticipant.
HasMatchResult() const	bool Whether this participant has a result for this match.
HasPlayer() const	bool Whether a Player is associated with this MultiplayerParticipant.
Id() const	const std::string & The Id of this MultiplayerParticipant.
IsConnectedToRoom() const	bool Whether this participant is connected to a RealTimeRoom.
MatchRank() const	uint32_t The rank for this MultiplayerParticipant within its match.
MatchResult() const	gpg::MatchResult The result of the match for this MultiplayerParticipant.
Player() const	gpg::Player The Player associated with this MultiplayerParticipant.
Status() const	ParticipantStatus The status of this MultiplayerParticipant with respect to the match.
Valid() const	bool Returns true if this MultiplayerParticipant is populated with data.
operator=(const MultiplayerParticipant & copy_from)	MultiplayerParticipant & Assigns this MultiplayerParticipant by copying from another one.
operator=(MultiplayerParticipant && move_from)	MultiplayerParticipant & Assigns this MultiplayerParticipant by moving another one into it.

Public functions

AvatarUrl

const std::string & AvatarUrl(
  ImageResolution resolution
) const 

Returns the URL where the image of this MultiplayerParticipant's avatar resides.

The ImageResolution parameter specifies the resolution of the returned image. Specify either ICON or HI_RES for the resolution. Valid must return true for this function to be usable.

DisplayName

const std::string & DisplayName() const 

The display name for this MultiplayerParticipant.

Valid must return true for this function to be usable.

HasMatchResult

bool HasMatchResult() const 

Whether this participant has a result for this match.

If false, MatchResult and MatchRank do not return valid data. Valid must return true for this function to be usable.

HasPlayer

bool HasPlayer() const 

Whether a Player is associated with this MultiplayerParticipant.

Valid must return true for this function to be usable.

Id

const std::string & Id() const 

The Id of this MultiplayerParticipant.

Id's are only valid in the scope of a single match, and are different from Player::Id()'s. Valid must return true for this function to be usable.

IsConnectedToRoom

bool IsConnectedToRoom() const 

Whether this participant is connected to a RealTimeRoom.

Always false if this is a participant from a TurnBasedMatch.

MatchRank

uint32_t MatchRank() const 

The rank for this MultiplayerParticipant within its match.

Valid must return true for this function to be usable. If HasMatchResult() does not return true, this function returns 0.

MatchResult

gpg::MatchResult MatchResult() const 

The result of the match for this MultiplayerParticipant.

Valid must return true for this function to be usable. If HasMatchResult() does not return true, this function returns MatchResult::None.

MultiplayerParticipant

 MultiplayerParticipant()

MultiplayerParticipant

 MultiplayerParticipant(
  std::shared_ptr< const MultiplayerParticipantImpl > impl
)

Constructs a MultiplayerParticipant from a shared_ptr to a MultiplayerParticipantImpl.

Intended for internal use by the API.

MultiplayerParticipant

 MultiplayerParticipant(
  const MultiplayerParticipant & copy_from
)

Creates a copy of an existing MultiplayerParticipant.

MultiplayerParticipant

 MultiplayerParticipant(
  MultiplayerParticipant && move_from
)

Moves an existing MultiplayerParticipant.

Player

gpg::Player Player() const 

The Player associated with this MultiplayerParticipant.

Valid and HasPlayer must both return true for this function to be usable.

Status

ParticipantStatus Status() const 

The status of this MultiplayerParticipant with respect to the match.

Valid must return true for this function to be usable.

Valid

bool Valid() const 

Returns true if this MultiplayerParticipant is populated with data.

Must be true in order for the getter functions (DisplayName, AvatarUrl, Id, etc.) on this MultiplayerParticipant to be usable.

operator=

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

Assigns this MultiplayerParticipant by copying from another one.

operator=

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

Assigns this MultiplayerParticipant by moving another one into it.

~MultiplayerParticipant

 ~MultiplayerParticipant()