gpg::MultiplayerParticipant

#include <multiplayer_participant.h>

Datenstruktur mit Daten zu einem Teilnehmer in einem Mehrspieler-Spiel.

Zusammenfassung

Konstruktoren und Zerstörer
MultiplayerParticipant()
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
Erstellt ein MultiplayerParticipant aus einem shared_ptr zu einem MultiplayerParticipantImpl.
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
Erstellt eine Kopie einer vorhandenen MultiplayerParticipant.
MultiplayerParticipant(MultiplayerParticipant && move_from)
Verschiebt ein vorhandenes MultiplayerParticipant.
~MultiplayerParticipant()

Öffentliche Funktionen
AvatarUrl(ImageResolution resolution) const
const std::string &
Gibt die URL zurück, unter der sich das Bild des Avatars von MultiplayerParticipant befindet.
DisplayName() const
const std::string &
Der Anzeigename für dieses MultiplayerParticipant.
HasMatchResult() const
bool
Gibt an, ob dieser Teilnehmer ein Ergebnis für dieses Spiel hat.
HasPlayer() const
bool
Gibt an, ob ein Player mit diesem MultiplayerParticipant verknüpft ist.
Id() const
const std::string &
Die Id dieses MultiplayerParticipant.
IsConnectedToRoom() const
bool
Gibt an, ob dieser Teilnehmer mit einem RealTimeRoom verbunden ist.
MatchRank() const
uint32_t
Der Rang für diese MultiplayerParticipant innerhalb der Übereinstimmung.
MatchResult() const
Das Ergebnis der Übereinstimmung für diese MultiplayerParticipant.
Player() const
Der mit MultiplayerParticipant verknüpfte Player.
Status() const
Der Status dieses MultiplayerParticipant in Bezug auf die Übereinstimmung.
Valid() const
bool
Gibt „true“ zurück, wenn MultiplayerParticipant mit Daten gefüllt ist.
operator=(const MultiplayerParticipant & copy_from)
Weist diesem/dieser MultiplayerParticipant durch Kopieren aus einem anderen zu.
operator=(MultiplayerParticipant && move_from)
Weist diesem MultiplayerParticipant zu, indem eine andere in die Datei verschoben wird.

Öffentliche Funktionen

AvatarUrl

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

Gibt die URL zurück, unter der sich das Bild des Avatars von MultiplayerParticipant befindet.

Der Parameter ImageResolution gibt die Auflösung des zurückgegebenen Bildes an. Geben Sie entweder ICON oder HI_RES als Auflösung an. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

DisplayName

const std::string & DisplayName() const

Der Anzeigename für dieses MultiplayerParticipant.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

HasMatchResult

bool HasMatchResult() const

Gibt an, ob dieser Teilnehmer ein Ergebnis für dieses Spiel hat.

Bei „false“ geben MatchResult und MatchRank keine gültigen Daten zurück. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

HasPlayer

bool HasPlayer() const

Gibt an, ob ein Player mit diesem MultiplayerParticipant verknüpft ist.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

ID

const std::string & Id() const

Die Id dieses MultiplayerParticipant.

Id-Elemente sind nur im Umfang einer einzelnen Übereinstimmung gültig und unterscheiden sich von denen von Player::Id(). Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

IsConnectedToRoom

bool IsConnectedToRoom() const

Gibt an, ob dieser Teilnehmer mit einem RealTimeRoom verbunden ist.

Immer falsch, wenn dies ein Teilnehmer aus einem TurnBasedMatch ist.

MatchRank

uint32_t MatchRank() const

Der Rang für diese MultiplayerParticipant innerhalb der Übereinstimmung.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann. Wenn HasMatchResult() nicht „true“ zurückgibt, gibt diese Funktion 0 zurück.

MatchResult

gpg::MatchResult MatchResult() const

Das Ergebnis der Übereinstimmung für diese MultiplayerParticipant.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann. Wenn HasMatchResult() nicht „true“ zurückgibt, gibt diese Funktion MatchResult::None zurück.

MultiplayerParticipant

 MultiplayerParticipant()

MultiplayerParticipant

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

Erstellt ein MultiplayerParticipant aus einem shared_ptr zu einem MultiplayerParticipantImpl.

Vorgesehen für die interne Verwendung durch die API.

MultiplayerParticipant

 MultiplayerParticipant(
  const MultiplayerParticipant & copy_from
)

Erstellt eine Kopie einer vorhandenen MultiplayerParticipant.

MultiplayerParticipant

 MultiplayerParticipant(
  MultiplayerParticipant && move_from
)

Verschiebt ein vorhandenes MultiplayerParticipant.

Spieler

gpg::Player Player() const

Der mit MultiplayerParticipant verknüpfte Player.

Valid und HasPlayer müssen beide „true“ zurückgeben, damit diese Funktion verwendet werden kann.

Status

ParticipantStatus Status() const

Der Status dieses MultiplayerParticipant in Bezug auf die Übereinstimmung.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

Gültig

bool Valid() const

Gibt „true“ zurück, wenn MultiplayerParticipant mit Daten gefüllt ist.

Muss „true“ sein, damit die Getter-Funktionen (DisplayName, AvatarUrl, Id usw.) in diesem MultiplayerParticipant verwendet werden können.

operator=

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

Weist diesem/dieser MultiplayerParticipant durch Kopieren aus einem anderen zu.

operator=

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

Weist diesem MultiplayerParticipant zu, indem eine andere in die Datei verschoben wird.

~Mehrspielerteilnehmer

 ~MultiplayerParticipant()