gpg:: TurnBasedMatch
#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() の場合、前の一致のデータ。
|
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 を割り当てます。 |
operator=(TurnBasedMatch && move_from)
|
もう 1 つこれを移動して、この
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
オブジェクトを作成します。この関数を使用するには、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() の場合、前の一致のデータ。
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
を割り当てます。
operator=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
もう 1 つこれを移動して、この TurnBasedMatch
を割り当てます。