gpg::MultiplayerParticipant

#include <multiplayer_participant.h>

マルチプレーヤー マッチの参加者に関するデータを含むデータ構造。

概要

コンストラクタとデストラクタ

MultiplayerParticipant()
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
shared_ptr から MultiplayerParticipantImpl への MultiplayerParticipant を作成します。
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
既存の MultiplayerParticipant のコピーを作成します。
MultiplayerParticipant(MultiplayerParticipant && move_from)
既存の MultiplayerParticipant を移動します。
~MultiplayerParticipant()

パブリック関数

AvatarUrl(ImageResolution resolution) const
const std::string &
この MultiplayerParticipant のアバター画像が存在する URL を返します。
DisplayName() const
const std::string &
この MultiplayerParticipant の表示名。
HasMatchResult() const
bool
この参加者がこの試合の結果を持っているかどうか。
HasPlayer() const
bool
この MultiplayerParticipantプレーヤーが関連付けられているかどうか。
Id() const
const std::string &
この MultiplayerParticipantId
IsConnectedToRoom() const
bool
この参加者が RealTimeRoom に接続されているかどうか。
MatchRank() const
uint32_t
一致内のこの MultiplayerParticipant のランク。
MatchResult() const
この MultiplayerParticipant の一致結果。
Player() const
この MultiplayerParticipant に関連付けられているプレーヤー
Status() const
一致に関するこの MultiplayerParticipant のステータス。
Valid() const
bool
この MultiplayerParticipant にデータが入力されている場合は true を返します。
operator=(const MultiplayerParticipant & copy_from)
別の MultiplayerParticipant からコピーして、この MultiplayerParticipant を割り当てます。
operator=(MultiplayerParticipant && move_from)
別の MultiplayerParticipant を移動して、この MultiplayerParticipant を割り当てます。

パブリック関数

AvatarUrl

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

この MultiplayerParticipant のアバター画像が存在する URL を返します。

ImageResolution パラメータは、返される画像の解像度を指定します。解像度には ICON または HI_RES を指定します。この関数を使用できるようにするには、Valid が true を返す必要があります。

DisplayName

const std::string & DisplayName() const 

この MultiplayerParticipant の表示名。

この関数を使用できるようにするには、Valid が true を返す必要があります。

HasMatchResult

bool HasMatchResult() const 

この参加者がこの試合の結果を持っているかどうか。

false の場合、MatchResultMatchRank は有効なデータを返しません。この関数を使用できるようにするには、Valid が true を返す必要があります。

HasPlayer

bool HasPlayer() const 

この MultiplayerParticipantプレーヤーが関連付けられているかどうか。

この関数を使用できるようにするには、Valid が true を返す必要があります。

ID

const std::string & Id() const 

この MultiplayerParticipantId

Id は 1 つのマッチのスコープ内でのみ有効で、Player::Id() とは異なります。この関数を使用できるようにするには、Valid が true を返す必要があります。

IsConnectedToRoom

bool IsConnectedToRoom() const 

この参加者が RealTimeRoom に接続されているかどうか。

TurnBasedMatch の参加者の場合は常に false です。

MatchRank

uint32_t MatchRank() const 

一致内のこの MultiplayerParticipant のランク。

この関数を使用できるようにするには、Valid が true を返す必要があります。HasMatchResult() が true を返さない場合、この関数は 0 を返します。

MatchResult

gpg::MatchResult MatchResult() const 

この MultiplayerParticipant の一致結果。

この関数を使用できるようにするには、Valid が true を返す必要があります。HasMatchResult() が true を返さない場合、この関数は MatchResult::None を返します。

MultiplayerParticipant

 MultiplayerParticipant()

MultiplayerParticipant

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

shared_ptr から MultiplayerParticipantImpl への MultiplayerParticipant を作成します。

API による内部使用を想定しています。

MultiplayerParticipant

 MultiplayerParticipant(
  const MultiplayerParticipant & copy_from
)

既存の MultiplayerParticipant のコピーを作成します。

MultiplayerParticipant

 MultiplayerParticipant(
  MultiplayerParticipant && move_from
)

既存の MultiplayerParticipant を移動します。

選手

gpg::Player Player() const 

この MultiplayerParticipant に関連付けられているプレーヤー

この関数を使用できるようにするには、ValidHasPlayer の両方が true を返す必要があります。

ステータス

ParticipantStatus Status() const 

マッチに関するこの MultiplayerParticipant のステータス。

この関数を使用できるようにするには、Valid が true を返す必要があります。

有効

bool Valid() const 

この MultiplayerParticipant にデータが入力されている場合は true を返します。

この MultiplayerParticipant のゲッター関数(DisplayNameAvatarUrlId など)を使用できるようにするには、true にする必要があります。

operator=

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

別の MultiplayerParticipant からコピーして、この MultiplayerParticipant を割り当てます。

operator=

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

別の MultiplayerParticipant を移動して、この MultiplayerParticipant を割り当てます。

~MultiplayerParticipant

 ~MultiplayerParticipant()