gpg:: MultiplayerParticipant
#include <multiplayer_participant.h>
マルチプレーヤー型ゲームの参加者に関するデータを含むデータ構造。
概要
コンストラクタとデストラクタ |
|
---|---|
MultiplayerParticipant()
|
|
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
|
|
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
Player がこの
MultiplayerParticipant に関連付けられているかどうか。 |
Id() const
|
const std::string &
この
MultiplayerParticipant の Id 。 |
IsConnectedToRoom() const
|
bool
この参加者が
RealTimeRoom に接続されているかどうか |
MatchRank() const
|
uint32_t
一致内のこの
MultiplayerParticipant のランク。 |
MatchResult() const
|
この
MultiplayerParticipant の一致の結果。 |
Player() const
|
この
MultiplayerParticipant に関連付けられている Player。 |
Status() const
|
一致に関するこの
MultiplayerParticipant のステータス。 |
Valid() const
|
bool
この
MultiplayerParticipant にデータが入力されている場合、true を返します。 |
operator=(const MultiplayerParticipant & copy_from)
|
別のものからコピーすることで、この
MultiplayerParticipant を割り当てます。 |
operator=(MultiplayerParticipant && move_from)
|
もう 1 つこれを移動して、この
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 の場合、MatchResult と MatchRank は有効なデータを返しません。この関数を使用するには、Valid が true を返す必要があります。
HasPlayer
bool HasPlayer() const
Player がこの MultiplayerParticipant
に関連付けられているかどうか。
この関数を使用するには、Valid が true を返す必要があります。
ID
const std::string & Id() const
この MultiplayerParticipant
の Id
。
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
を移動します。
ステータス
ParticipantStatus Status() const
一致に関するこの MultiplayerParticipant
のステータス。
この関数を使用するには、Valid が true を返す必要があります。
有効
bool Valid() const
この MultiplayerParticipant
にデータが入力されている場合、true を返します。
この MultiplayerParticipant
のゲッター関数(DisplayName
、AvatarUrl
、Id
など)を使用できるようにするには、true である必要があります。
operator=
MultiplayerParticipant & operator=( const MultiplayerParticipant & copy_from )
別のものからコピーすることで、この MultiplayerParticipant
を割り当てます。
operator=
MultiplayerParticipant & operator=( MultiplayerParticipant && move_from )
もう 1 つこれを移動して、この MultiplayerParticipant
を割り当てます。
マルチプレーヤー型ゲームの参加者
~MultiplayerParticipant()