gpg::
#include <turn_based_match.h>
TurnBasedMatch の現在の状態に関するデータを含むデータ構造。
概要
コンストラクタとデストラクタ |
|
|---|---|
TurnBasedMatch()
|
|
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
既存の
TurnBasedMatch のコピーを作成します。 |
|
TurnBasedMatch(TurnBasedMatch && move_from)
既存の
TurnBasedMatch を移動します。 |
パブリック関数 |
|
|---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
マッチに使用可能な自動マッチング スロットの数を返します。
|
CreatingParticipant() const
|
この試合を作成した参加者を返します。
|
CreationTime() const
|
std::chrono::milliseconds
この
TurnBasedMatch was created の時刻（Unix エポックからの経過時間（ミリ秒単位））を返します。 |
Data() const
|
const std::vector< uint8_t > &
HasData() が true の場合、一致データを返します。 |
Description() const
|
const std::string &
マッチの状態に関するサーバー生成の概要を返します。
|
HasData() const
|
bool
このオブジェクトに、前のターンで設定されたデータがある場合は true。
|
HasPreviousMatchData() const
|
bool
これが再戦の最初のターンの場合に true。この関数を使用できるようにするには、前の Valid のデータが true を返す必要があります。
|
HasRematchId() const
|
bool
この試合が再試合になった場合は true を返します。
|
Id() const
|
const std::string &
この
TurnBasedMatch を一意に識別する ID を返します。 |
LastUpdateTime() const
|
この
TurnBasedMatch が最後に更新された時刻（Unix エポックからの経過ミリ秒数）を返します。 |
LastUpdatingParticipant() const
|
この試合を最後に更新した参加者を返します。
|
Number() const
|
uint32_t
再マッチングによってこの試合の前に行われた試合の数を示す数値。
|
ParticipantResults() const
|
const gpg::ParticipantResults &
一致の結果を返します。
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
この試合のすべての参加者のベクトル。
|
PendingParticipant() const
|
この試合の更新の順番にある参加者を返します。
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
HasPreviousMatchData() が true の場合、前回の試合のデータ。
|
RematchId() const
|
const std::string &
この試合の再戦である試合の ID（利用可能な場合）を返します。
|
Status() const
|
ローカル参加者の試合のステータスを返します。
|
SuggestedNextParticipant() const
|
参加済み、招待可能、自動マッチングの参加者のセットから有効な参加者を選択するヘルパー関数。
|
Valid() const
|
bool
この
TurnBasedMatch にデータが入力されている場合は true を返します。 |
Variant() const
|
uint32_t
ゲーム固有のバリアント ID を返します。ゲームで使用して、さまざまなゲームモードを識別できます。
|
Version() const
|
uint32_t
厳密に増分する ID。マッチが変更されるたびに更新されます。
|
operator=(const TurnBasedMatch & copy_from)
|
別の
TurnBasedMatch からコピーして、この TurnBasedMatch を割り当てます。 |
operator=(TurnBasedMatch && move_from)
|
別の
TurnBasedMatch を移動して、この TurnBasedMatch を割り当てます。 |
パブリック関数
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
マッチに使用可能な自動マッチング スロットの数を返します。
この数値は、マッチが作成された自動マッチング スロットの数から、自動マッチングですでに追加されている参加者の数を差し引いたものです。この関数を使用できるようにするには、Valid が true を返す必要があります。
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
この試合を作成した参加者を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
CreationTime
std::chrono::milliseconds CreationTime() const
この TurnBasedMatch was created の時刻（Unix エポックからの経過時間（ミリ秒単位））を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
データ
const std::vector< uint8_t > & Data() const
説明
const std::string & Description() const
マッチの状態に関するサーバー生成の概要を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
HasData
bool HasData() const
このオブジェクトに、前のターンで設定されたデータがある場合は true。
この関数を使用できるようにするには、Valid が true を返す必要があります。
HasPreviousMatchData
bool HasPreviousMatchData() const
これが再戦の最初のターンの場合に true。この関数を使用できるようにするには、前の Valid のデータが true を返す必要があります。
HasRematchId
bool HasRematchId() const
この試合が再試合になった場合は true を返します。
ID
const std::string & Id() const
この TurnBasedMatch を一意に識別する ID を返します。
TurnBasedMultiplayerManager::FetchMatch とともに使用すると、後でこの一致を取得できます。この関数を使用できるようにするには、Valid が true を返す必要があります。
LastUpdateTime
Timestamp LastUpdateTime() const
この TurnBasedMatch が最後に更新された時刻（Unix エポックからの経過ミリ秒数）を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
この試合を最後に更新した参加者を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
数値
uint32_t Number() const
再マッチングによってこの試合の前に行われた試合の数を示す数値。
最初の一致で 1 に設定され、再一致するたびに 1 ずつ増加します。
ParticipantResults
const gpg::ParticipantResults & ParticipantResults() const
一致の結果を返します。
結果は、TurnBasedMultiplayerManager::TakeMyTurn、TurnBasedMultiplayerManager::FinishDuringMyTurn、その他の関連関数で設定できます。常に ParticipantResults().WithResult(...) を使用して、既存の ParticipantResults オブジェクトと整合する新しい ParticipantResults オブジェクトを作成します。この関数を使用できるようにするには、Valid が true を返す必要があります。
参加者
const std::vector< MultiplayerParticipant > & Participants() const
この試合のすべての参加者のベクトル。
この関数を使用できるようにするには、Valid が true を返す必要があります。
PendingParticipant
MultiplayerParticipant PendingParticipant() const
この試合の更新の順番にある参加者を返します。
この関数を使用できるようにするには、Valid が true を返す必要があります。
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
HasPreviousMatchData() が true の場合、前回の試合のデータ。
Valid が true を返した場合にのみ呼び出せます。
RematchId
const std::string & RematchId() const
この試合の再戦である試合の ID（利用可能な場合）を返します。
ステータス
MatchStatus Status() const
ローカル参加者の試合のステータスを返します。
ステータスによって、一致に対して実行できるアクションが決まります。この関数を使用できるようにするには、Valid が true を返す必要があります。
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
参加済み、招待可能、自動マッチングの参加者のセットから有効な参加者を選択するヘルパー関数。
この関数を常に次の参加者の選択に使用すると、すべての参加者が順番にプレイし、必要に応じて繰り返します。この関数は、Status() が MatchStatus::MY_TURN の場合にのみ呼び出す必要があります。この関数の結果を有意に使用できるのは、この場合のみです。正しく呼び出されていない場合、この関数は無効な参加者（MultiplayerParticipant::Valid() == false）を返します。
TurnBasedMatch
TurnBasedMatch()
TurnBasedMatch
TurnBasedMatch( std::shared_ptr< const TurnBasedMatchImpl > impl )
shared_ptr から TurnBasedMatchImpl への TurnBasedMatch を作成します。
API による内部使用を想定しています。
有効
bool Valid() const
この TurnBasedMatch にデータが入力されている場合は true を返します。
TurnBasedMatch オブジェクト（Id、CreationTime など）のゲッター関数を使用できるようにするには、true を返す必要があります。
バリアント
uint32_t Variant() const
ゲーム固有のバリアント ID を返します。ゲームで使用して、さまざまなゲームモードを識別できます。
この関数を使用できるようにするには、Valid が true を返す必要があります。
バージョン
uint32_t Version() const
厳密に増分する ID。マッチが変更されるたびに更新されます。
operator=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
別の TurnBasedMatch からコピーして、この TurnBasedMatch を割り当てます。
operator=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
別の TurnBasedMatch を移動して、この TurnBasedMatch を割り当てます。