gpg::TurnBasedMatch

#include <turn_based_match.h>

TurnBasedMatch の現在の状態に関するデータを含むデータ構造体。

概要

コンストラクタとデストラクタ
TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
shared_ptr から TurnBasedMatchImpl への TurnBasedMatch を作成します。
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
一致の結果を返します。
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)
この 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

HasData() が true の場合、一致データを返します。

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

説明

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 による内部使用を対象としています。

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

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

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

既存の TurnBasedMatch を移動します。

有効

bool Valid() const

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

TurnBasedMatch オブジェクトのゲッター関数（Id、CreationTime など）を使用できるようにするには、true を返す必要があります。

バリアント

uint32_t Variant() const

ゲームでさまざまなゲームモードを識別するために使用できる、ゲーム固有のバリアント ID を返します。

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

バージョン

uint32_t Version() const

厳密に増分される ID で、一致が変更されるたびに更新されます。

演算子=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

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

演算子=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

この TurnBasedMatch を別のものに移動することで割り当てます。