gpg::TurnBasedMatch

#include <turn_based_match.h>

包含关于TurnBasedMatch当前状态的数据的數據結構。

摘要

构造函数和析构函数
回合制匹配()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
用指向TurnBasedMatchImpl的shared_ptr构造一个TurnBasedMatch。
TurnBasedMatch(const TurnBasedMatch & copy_from)
创建一个现有TurnBasedMatch的副本。
TurnBasedMatch(TurnBasedMatch && move_from)
移动一个现有的TurnBasedMatch。

公有函数
AutomatchingSlotsAvailable() const
uint32_t
返回匹配中可用的自动匹配槽位数。
CreatingParticipant() const
返回创建此匹配的参与者。
CreationTime() const
std::chrono::milliseconds
返回此TurnBasedMatch的创建时间（以自 Unix 纪元以来的毫秒数表示）。
Data() const
const std::vector< uint8_t > &
如果HasData()为真，则返回匹配数据。
Description() const
const std::string &
返回服务器生成的匹配状态摘要。
HasData() const
bool
如果此对象具有在上一回合设置的数据，则为真。
HasPreviousMatchData() const
bool
如果这是重赛的第一回合，则为真，并且此函数才能使用，则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复制来赋值此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的创建时间（以自 Unix 纪元以来的毫秒数表示）。

Valid 必须返回 true，此函数才能使用。

Data

const std::vector< uint8_t > & Data() const

如果HasData()为真，则返回匹配数据。

Valid 必须返回 true，此函数才能使用。

Description

const std::string & Description() const

返回服务器生成的匹配状态摘要。

Valid 必须返回 true，此函数才能使用。

HasData

bool HasData() const

如果此对象具有在上一回合设置的数据，则为真。

Valid 必须返回 true，此函数才能使用。

HasPreviousMatchData

bool HasPreviousMatchData() const

如果这是重赛的第一回合，则为真，并且此函数才能使用，则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，此函数才能使用。

Number

uint32_t Number() const

一个数字，指示有多少场比赛通过重赛先于这场比赛。

在第一场比赛中设置为 1，并在每次重赛时递增 1。

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

返回匹配的结果。

结果可以通过TurnBasedMultiplayerManager::TakeMyTurn、TurnBasedMultiplayerManager::FinishDuringMyTurn和其他相关函数设置。始终使用ParticipantResults().WithResult(...)创建与任何现有对象一致的新ParticipantResults对象。Valid 必须返回 true，此函数才能使用。

Participants

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（如果可用）。

Status

MatchStatus Status() const

返回本地参与者的匹配状态。

状态决定可以对匹配执行哪些操作。Valid 必须返回 true，此函数才能使用。

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

一个辅助函数，从已加入、可邀请和自动匹配的参与者集合中选择一个有效的参与者。

如果始终使用此函数选择下一个参与者，则游戏将按顺序依次进行所有参与者，必要时重复。只有当Status()为MatchStatus::MY_TURN时，才能调用此函数，因为这是此函数结果有意义的唯一时间。如果调用不正确，此函数将返回无效参与者（MultiplayerParticipant::Valid() == false）。

回合制匹配

 TurnBasedMatch()

回合制匹配

 TurnBasedMatch(
  std::shared_ptr< const TurnBasedMatchImpl > impl
)

用指向TurnBasedMatchImpl的shared_ptr构造一个TurnBasedMatch。

供 API 内部使用。

回合制匹配

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

创建一个现有TurnBasedMatch的副本。

回合制匹配

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

移动一个现有的TurnBasedMatch。

Valid

bool Valid() const

如果此TurnBasedMatch已填充数据，则返回 true。

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

Variant

uint32_t Variant() const

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

Valid 必须返回 true，此函数才能使用。

Version

uint32_t Version() const

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

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

通过从另一个TurnBasedMatch复制来赋值此TurnBasedMatch。

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

通过将另一个TurnBasedMatch移动到其中来赋值此TurnBasedMatch。