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
返回游戏特有的变体标识符，游戏可以使用该标识符来识别不同的游戏模式。
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。

必须返回 true，TurnBasedMatch 对象（Id、CreationTime 等）上的 getter 函数才可用。

变体

uint32_t Variant() const

返回游戏特有的变体标识符，游戏可以使用该标识符来识别不同的游戏模式。

Valid 必须返回 true 才可用。

版本

uint32_t Version() const

严格递增的 ID，每次修改匹配时都会更新。

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

通过从另一网络TurnBasedMatch复制来分配此内容。

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

通过将另一个 TurnBasedMatch 移到该文件夹中指定该元素。