gpg::TurnBasedMultiplayerManager

#include <turn_based_multiplayer_manager.h>

获取、修改和创建 TurnBasedMatch 对象。

摘要

公共类型

MatchInboxUICallback typedef
std::function< void(const MatchInboxUIResponse &)>
定义可从 ShowMatchInboxUI 接收 MatchInboxUIResponse 的回调。
MultiplayerStatusCallback typedef
std::function< void(MultiplayerStatus)>
定义可用于接收 MultiplayerStatus 的回调。
PlayerSelectUICallback typedef
std::function< void(const PlayerSelectUIResponse &)>
定义可从 ShowPlayerSelectUI 接收 PlayerSelectUIResponse 的回调。
TurnBasedMatchCallback typedef
std::function< void(const TurnBasedMatchResponse &)>
定义可用于从某个回合制多人游戏操作接收 TurnBasedMatchResponse 的回调。
TurnBasedMatchesCallback typedef
std::function< void(const TurnBasedMatchesResponse &)>
定义一个可从某个回合制多人游戏操作接收 TurnBasedMatchesResponse 的回调。

公共静态属性

kAutomatchingParticipant
一个参与者,可以传递给接受“下一个 参与者”。

公共函数

AcceptInvitation(const MultiplayerInvitation & invitation, TurnBasedMatchCallback callback)
void
异步接受 MultiplayerInvitation,并通过 TurnBasedMatchCallback 返回结果。
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation)
AcceptInvitation 的屏蔽版本。
AcceptInvitationBlocking(const MultiplayerInvitation & invitation)
使 AcceptInvitationBlocking 过载,其默认超时时间为 10 年。
CancelMatch(const TurnBasedMatch & match, MultiplayerStatusCallback callback)
void
异步取消匹配。
CancelMatchBlocking(Timeout timeout, const TurnBasedMatch & match)
CancelMatch 的阻止版本。
CancelMatchBlocking(const TurnBasedMatch & match)
CancelMatch 过载,默认超时时间为 10 年。
ConfirmPendingCompletion(const TurnBasedMatch & match, TurnBasedMatchCallback callback)
void
确认已结束且正在等待本地完成的匹配结果。
ConfirmPendingCompletionBlocking(Timeout timeout, const TurnBasedMatch & match)
ConfirmPendingCompletion 的阻塞版本。
ConfirmPendingCompletionBlocking(const TurnBasedMatch & match)
过载 ConfirmPendingCompletionBlocking,它使用默认的超时时间为 10 年。
CreateTurnBasedMatch(const gpg::TurnBasedMatchConfig & config, TurnBasedMatchCallback callback)
void
使用提供的 TurnBasedMatchConfig 异步创建 TurnBasedMatch
CreateTurnBasedMatchBlocking(Timeout timeout, const gpg::TurnBasedMatchConfig & config)
CreateTurnBasedMatch 的阻止版本。
CreateTurnBasedMatchBlocking(const gpg::TurnBasedMatchConfig & config)
重载 CreateTurnBasedMatchBlocking,其默认超时时间为 10 年。
DeclineInvitation(const MultiplayerInvitation & invitation)
void
拒绝向 TurnBasedMatch 发出的 MultiplayerInvitation
DismissInvitation(const MultiplayerInvitation & invitation)
void
DismissMatch(const TurnBasedMatch & match)
void
关闭 TurnBasedMatch
FetchMatch(const std::string & match_id, TurnBasedMatchCallback callback)
void
按 ID 异步提取特定匹配项。
FetchMatchBlocking(Timeout timeout, const std::string & match_id)
FetchMatch 的阻止版本。
FetchMatchBlocking(const std::string & match_id)
过载 FetchMatchBlocking(默认超时时间为 10 年)。
FetchMatches(TurnBasedMatchesCallback callback)
void
异步提取当前播放器的 TurnBasedMatchInvitation 对象。
FetchMatchesBlocking(Timeout timeout)
FetchMatches 的阻止版本。
FetchMatchesBlocking()
过载 FetchMatchesBlocking(默认超时时间为 10 年)。
FinishMatchDuringMyTurn(const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results, TurnBasedMatchCallback callback)
void
异步完成指定的匹配。
FinishMatchDuringMyTurnBlocking(Timeout timeout, const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results)
FinishMatchDuringMyTurn 的阻止版本。
FinishMatchDuringMyTurnBlocking(const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results)
FinishMatchDuringMyTurnBlocking 过载,默认超时时间为 10 年。
LeaveMatchDuringMyTurn(const TurnBasedMatch & match, const MultiplayerParticipant & next_participant, MultiplayerStatusCallback callback)
void
在本地参与者轮次异步退出对局。
LeaveMatchDuringMyTurnBlocking(Timeout timeout, const TurnBasedMatch & match, const MultiplayerParticipant & next_participant)
LeaveMatchDuringMyTurn 的阻止版本。
LeaveMatchDuringMyTurnBlocking(const TurnBasedMatch & match, const MultiplayerParticipant & next_participant)
LeaveMatchDuringMyTurnBlocking 过载,默认超时时间为 10 年。
LeaveMatchDuringTheirTurn(const TurnBasedMatch & match, MultiplayerStatusCallback callback)
void
轮到其他参与者时异步退出对局。
LeaveMatchDuringTheirTurnBlocking(Timeout timeout, const TurnBasedMatch & match)
LeaveMatchDuringTheirTurn 的阻止版本。
LeaveMatchDuringTheirTurnBlocking(const TurnBasedMatch & match)
LeaveMatchDuringTheirTurnBlocking 过载,默认超时时间为 10 年。
Rematch(const TurnBasedMatch & match, TurnBasedMatchCallback callback)
void
重新匹配状态为 MatchStatus::COMPLETED 的匹配项。
RematchBlocking(Timeout timeout, const TurnBasedMatch & match)
重新匹配的屏蔽版本。
RematchBlocking(const TurnBasedMatch & match)
过载 RematchBlocking(默认超时时间为 10 年)。
ShowMatchInboxUI(MatchInboxUICallback callback)
void
异步显示对局收件箱界面,让玩家可以选择对局或邀请。
ShowMatchInboxUIBlocking(Timeout timeout)
ShowMatchInboxUI 的阻止版本。
ShowMatchInboxUIBlocking()
ShowMatchInboxUIBlocking 过载,默认超时时间为 10 年。
ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
void
异步显示玩家选择界面,允许玩家选择其他玩家来一起玩。
ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
ShowPlayerSelectUI 的阻止版本。
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
ShowPlayerSelectUIBlocking 过载,默认超时时间为 10 年。
SynchronizeData()
void
强制将 TBMP 匹配数据与服务器同步。
TakeMyTurn(const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results, const MultiplayerParticipant & next_participant, TurnBasedMatchCallback callback)
void
异步轮到本地参与者。
TakeMyTurnBlocking(Timeout timeout, const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results, const MultiplayerParticipant & next_participant)
TakeMyTurn 的屏蔽版本。
TakeMyTurnBlocking(const TurnBasedMatch & match, std::vector< uint8_t > match_data, const ParticipantResults & results, const MultiplayerParticipant & next_participant)
TakeMyTurnBlocking 过载,其默认超时时间为 10 年。

结构体

gpg::TurnBasedMultiplayerManager::MatchInboxUIResponse

用于 ShowMatchInboxUI 操作的 DataResponseStatus

gpg::TurnBasedMultiplayerManager::PlayerSelectUIResponse

用于 ShowPlayerSelectUI 操作的 DataResponseStatus

gpg::TurnBasedMultiplayerManager::TurnBasedMatchResponse

特定 TurnBasedMatchDataResponseStatus

gpg::TurnBasedMultiplayerManager::TurnBasedMatchesResponse

DataResponseStatus,适用于 TurnBasedMatches邀请

公共类型

MatchInboxUICallback

std::function< void(const MatchInboxUIResponse &)> MatchInboxUICallback

定义可从 ShowMatchInboxUI 接收 MatchInboxUIResponse 的回调。

MultiplayerStatusCallback

std::function< void(MultiplayerStatus)> MultiplayerStatusCallback

定义可用于接收 MultiplayerStatus 的回调。

供 LeaveMatch 和 CancelMatch 函数使用。

PlayerSelectUICallback

std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback

定义可从 ShowPlayerSelectUI 接收 PlayerSelectUIResponse 的回调。

TurnBasedMatchCallback

std::function< void(const TurnBasedMatchResponse &)> TurnBasedMatchCallback

定义一个回调,可用于从回合制多人游戏操作之一接收 TurnBasedMatchResponse

TurnBasedMatchesCallback

std::function< void(const TurnBasedMatchesResponse &)> TurnBasedMatchesCallback

定义一个可从某个回合制多人游戏操作接收 TurnBasedMatchesResponse 的回调。

公共静态属性

kAutomatchingParticipant

const MultiplayerParticipant kAutomatchingParticipant

一个参与者,可以传递给接受“下一个 参与者”。

这会使该方法通过自动匹配选择下一位参与者。只有当相关匹配的 TurnBasedMatch::AutomatchingSlotsAvailable 大于 0 时,将 kAutomatchingPARTICIPANT 传递给函数才有效。

公共函数

AcceptInvitation

void AcceptInvitation(
  const MultiplayerInvitation & invitation,
  TurnBasedMatchCallback callback
)

异步接受 MultiplayerInvitation,并通过 TurnBasedMatchCallback 返回结果。

如果操作成功,通过回调返回的 TurnBasedMatch 将处于 TurnBasedMatchState::MY_TURN 状态。

AcceptInvitationBlocking

TurnBasedMatchResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation
)

AcceptInvitation 的屏蔽版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

AcceptInvitationBlocking

TurnBasedMatchResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation
)

使 AcceptInvitationBlocking 过载,其默认超时时间为 10 年。

CancelMatch

void CancelMatch(
  const TurnBasedMatch & match,
  MultiplayerStatusCallback callback
)

异步取消匹配。

通过 MultiplayerStatusCallback 返回的状态指示操作是否成功。此函数的匹配状态必须为 INVITED、THEIR_TURN 或 MY_TURN。

CancelMatchBlocking

MultiplayerStatus CancelMatchBlocking(
  Timeout timeout,
  const TurnBasedMatch & match
)

CancelMatch 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

CancelMatchBlocking

MultiplayerStatus CancelMatchBlocking(
  const TurnBasedMatch & match
)

CancelMatch 过载,默认超时时间为 10 年。

ConfirmPendingCompletion

void ConfirmPendingCompletion(
  const TurnBasedMatch & match,
  TurnBasedMatchCallback callback
)

确认已结束且正在等待本地完成的匹配结果。

此函数只能在 TurnBasedMatch::Status() 返回 MatchStatus::PENDING_COMPLETION 时调用。

详细信息
参数
match
要确认其完成情况的匹配项。
callback
接收 TurnBasedMatchResponse 的回调。

ConfirmPendingCompletionBlocking

TurnBasedMatchResponse ConfirmPendingCompletionBlocking(
  Timeout timeout,
  const TurnBasedMatch & match
)

ConfirmPendingCompletion 的阻塞版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

ConfirmPendingCompletionBlocking

TurnBasedMatchResponse ConfirmPendingCompletionBlocking(
  const TurnBasedMatch & match
)

过载 ConfirmPendingCompletionBlocking,它使用默认的超时时间为 10 年。

CreateTurnBasedMatch

void CreateTurnBasedMatch(
  const gpg::TurnBasedMatchConfig & config,
  TurnBasedMatchCallback callback
)

使用提供的 TurnBasedMatchConfig 异步创建 TurnBasedMatch

如果创建成功,此函数会通过提供的 TurnBasedMatchCallback 返回 TurnBasedMatch。新创建的 TurnBasedMatch 始终以 TurnBasedMatchState::MY_TURN 状态开始。

CreateTurnBasedMatchBlocking

TurnBasedMatchResponse CreateTurnBasedMatchBlocking(
  Timeout timeout,
  const gpg::TurnBasedMatchConfig & config
)

CreateTurnBasedMatch 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

CreateTurnBasedMatchBlocking

TurnBasedMatchResponse CreateTurnBasedMatchBlocking(
  const gpg::TurnBasedMatchConfig & config
)

重载 CreateTurnBasedMatchBlocking,其默认超时时间为 10 年。

DeclineInvitation

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

拒绝向 TurnBasedMatch 发出的 MultiplayerInvitation

这样做可以取消其他参与者的对局,并从本地玩家的设备中移除该对局。

DismissInvitation

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

关闭对 TurnBasedMatchMultiplayerInvitation

这不会更改其他参与者的 TurnBasedMatch 的可见状态,但会从本地玩家的设备中移除 TurnBasedMatch

DismissMatch

void DismissMatch(
  const TurnBasedMatch & match
)

关闭 TurnBasedMatch

这不会更改其他参与者的 TurnBasedMatch 的可见状态,但会从本地玩家的设备中移除 TurnBasedMatch

FetchMatch

void FetchMatch(
  const std::string & match_id,
  TurnBasedMatchCallback callback
)

按 ID 异步提取特定匹配项。

此操作的结果将通过 TurnBasedMatchCallback 返回。

FetchMatchBlocking

TurnBasedMatchResponse FetchMatchBlocking(
  Timeout timeout,
  const std::string & match_id
)

FetchMatch 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

FetchMatchBlocking

TurnBasedMatchResponse FetchMatchBlocking(
  const std::string & match_id
)

过载 FetchMatchBlocking(默认超时时间为 10 年)。

FetchMatches

void FetchMatches(
  TurnBasedMatchesCallback callback
)

异步提取当前播放器的 TurnBasedMatchInvitation 对象。

系统会返回所有有效匹配项和最多 10 个已完成的匹配项。

FetchMatchesBlocking

TurnBasedMatchesResponse FetchMatchesBlocking(
  Timeout timeout
)

FetchMatches 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

FetchMatchesBlocking

TurnBasedMatchesResponse FetchMatchesBlocking()

过载 FetchMatchesBlocking(默认超时时间为 10 年)。

FinishMatchDuringMyTurn

void FinishMatchDuringMyTurn(
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results,
  TurnBasedMatchCallback callback
)

异步完成指定的匹配。

在对局的最后一轮中,玩家可以使用此目标而非 TakeMyTurn。允许调用方为 match_data 指定最终值,以及为 ParticipantResults 指定一组最终值。此操作完成后,系统将通过提供的 TurnBasedMatchCallback. 返回更新后的匹配项。只有当 TurnBasedMatch::Status() 返回 MatchStatus::MY_TURN. 时,才能调用此函数

详细信息
参数
match
对局结束。
match_data
表示匹配最终状态的数据 blob。
results
每个球员在比赛中的任何结果。请注意,这些结果不得与之前通过 TakeTurn 指定的任何结果相悖。尝试为玩家设置不同的结果会导致 ERROR_INVALID_RESULTS
callback
接收 TurnBasedMatchResponse 的回调。

FinishMatchDuringMyTurnBlocking

TurnBasedMatchResponse FinishMatchDuringMyTurnBlocking(
  Timeout timeout,
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results
)

FinishMatchDuringMyTurn 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

FinishMatchDuringMyTurnBlocking

TurnBasedMatchResponse FinishMatchDuringMyTurnBlocking(
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results
)

FinishMatchDuringMyTurnBlocking 过载,默认超时时间为 10 年。

LeaveMatchDuringMyTurn

void LeaveMatchDuringMyTurn(
  const TurnBasedMatch & match,
  const MultiplayerParticipant & next_participant,
  MultiplayerStatusCallback callback
)

在本地参与者轮次异步退出对局。

通过 TurnBasedMatchCallback 返回的响应包含本地玩家退出后的对局状态。如果比赛过程中参与者不足两人,该比赛就会取消。match.Status() 必须返回 MatchStatus::MY_TURN,此函数才可用。

详细信息
参数
match
即将开始的比赛。
next_participant
轮到下一个的参与者。TurnBasedMultiplayerManager::kAutomatchingParticipant 可用于指定通过自动匹配功能选择下一位参与者。
callback
接收 TurnBasedMatchResponse 的回调

LeaveMatchDuringMyTurnBlocking

MultiplayerStatus LeaveMatchDuringMyTurnBlocking(
  Timeout timeout,
  const TurnBasedMatch & match,
  const MultiplayerParticipant & next_participant
)

LeaveMatchDuringMyTurn 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

LeaveMatchDuringMyTurnBlocking

MultiplayerStatus LeaveMatchDuringMyTurnBlocking(
  const TurnBasedMatch & match,
  const MultiplayerParticipant & next_participant
)

LeaveMatchDuringMyTurnBlocking 过载,默认超时时间为 10 年。

LeaveMatchDuringTheirTurn

void LeaveMatchDuringTheirTurn(
  const TurnBasedMatch & match,
  MultiplayerStatusCallback callback
)

轮到其他参与者时异步退出对局。

通过 MultiplayerStatusCallback 返回的响应包含本地参与者是否已成功退出对局。如果比赛过程中参与者不足两人,该比赛就会取消。match.Status() 必须返回 MatchStatus::THEIR_TURN,此函数才可用。

LeaveMatchDuringTheirTurnBlocking

MultiplayerStatus LeaveMatchDuringTheirTurnBlocking(
  Timeout timeout,
  const TurnBasedMatch & match
)

LeaveMatchDuringTheirTurn 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

LeaveMatchDuringTheirTurnBlocking

MultiplayerStatus LeaveMatchDuringTheirTurnBlocking(
  const TurnBasedMatch & match
)

LeaveMatchDuringTheirTurnBlocking 过载,默认超时时间为 10 年。

再来一局

void Rematch(
  const TurnBasedMatch & match,
  TurnBasedMatchCallback callback
)

重新匹配状态为 MatchStatus::COMPLETED 的匹配项。

如果可以再匹配一次,TurnBasedMatchCallback 会收到新的匹配内容。

详细信息
参数
match
要重新配对的对局。
callback
接收 TurnBasedMatchResponse 的回调。

RematchBlocking

TurnBasedMatchResponse RematchBlocking(
  Timeout timeout,
  const TurnBasedMatch & match
)

重新匹配的屏蔽版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

RematchBlocking

TurnBasedMatchResponse RematchBlocking(
  const TurnBasedMatch & match
)

过载 RematchBlocking(默认超时时间为 10 年)。

ShowMatchInboxUI

void ShowMatchInboxUI(
  MatchInboxUICallback callback
)

异步显示对局收件箱界面,让玩家可以选择对局或邀请。

完成后,系统会通过 MatchInboxUICallback 返回所选的匹配项或邀请。

ShowMatchInboxUIBlocking

MatchInboxUIResponse ShowMatchInboxUIBlocking(
  Timeout timeout
)

ShowMatchInboxUI 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

ShowMatchInboxUIBlocking

MatchInboxUIResponse ShowMatchInboxUIBlocking()

ShowMatchInboxUIBlocking 过载,默认超时时间为 10 年。

ShowPlayerSelectUI

void ShowPlayerSelectUI(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch,
  PlayerSelectUICallback callback
)

异步显示玩家选择界面,允许玩家选择其他玩家来一起玩。

完成后,系统会通过 PlayerSelectUICallback 返回选定的玩家。

ShowPlayerSelectUIBlocking

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  Timeout timeout,
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

ShowPlayerSelectUI 的阻止版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

ShowPlayerSelectUIBlocking

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

ShowPlayerSelectUIBlocking 过载,默认超时时间为 10 年。

SynchronizeData

void SynchronizeData()

强制将 TBMP 匹配数据与服务器同步。

收到新数据会触发 OnTurnBasedMatchEventCallbackOnMultiplayerInvitationReceivedCallback

TakeMyTurn

void TakeMyTurn(
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results,
  const MultiplayerParticipant & next_participant,
  TurnBasedMatchCallback callback
)

异步轮到本地参与者。

轮流时,参与者可以为 match_data 和一组 ParticipantResults 指定一个新的值。转弯时,通过 TurnBasedMatchCallback 返回更新后的对局。此函数只能在 TurnBasedMatch::Status()MatchStatus::MY_TURN 时调用。

详细信息
参数
match
转弯处的对局。
match_data
要发送给下一个参与者的数据 blob。
results
当前比赛的任何已知结果。请注意,只能为一个给定播放器指定一次结果。尝试为玩家设置不同的结果会导致 ERROR_INVALID_RESULTS
next_participant
轮到下一个的参与者。TurnBasedMultiplayerManager::kAutomatchingParticipant 可用于指定通过自动匹配功能选择下一位参与者。
callback
接收 TurnBasedMatchResponse 的回调。

TakeMyTurnBlocking

TurnBasedMatchResponse TakeMyTurnBlocking(
  Timeout timeout,
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results,
  const MultiplayerParticipant & next_participant
)

TakeMyTurn 的屏蔽版本。

允许调用方指定超时(以毫秒为单位)。指定的时间过后,该函数会返回 ERROR_TIMEOUT

TakeMyTurnBlocking

TurnBasedMatchResponse TakeMyTurnBlocking(
  const TurnBasedMatch & match,
  std::vector< uint8_t > match_data,
  const ParticipantResults & results,
  const MultiplayerParticipant & next_participant
)

TakeMyTurnBlocking 过载,其默认超时时间为 10 年。