gpg::TurnBasedMultiplayerManager
#include <turn_based_multiplayer_manager.h>
获取、修改和创建 TurnBasedMatch 对象。
摘要
公共类型 |
|
|---|---|
MatchInboxUICallback
|
typedefstd::function< void(const MatchInboxUIResponse &)>
定义一个回调,该回调可以接收来自 ShowMatchInboxUI 的 MatchInboxUIResponse。 |
MultiplayerStatusCallback
|
typedefstd::function< void(MultiplayerStatus)>
定义一个回调,可用于接收 MultiplayerStatus。 |
PlayerSelectUICallback
|
typedefstd::function< void(const PlayerSelectUIResponse &)>
定义一个回调,该回调可以接收来自 ShowPlayerSelectUI 的 PlayerSelectUIResponse。 |
TurnBasedMatchCallback
|
typedefstd::function< void(const TurnBasedMatchResponse &)>
定义一个回调,可用于接收来自回合制多人游戏操作的 TurnBasedMatchResponse。 |
TurnBasedMatchesCallback
|
typedefstd::function< void(const TurnBasedMatchesResponse &)>
定义一个回调,该回调可以接收来自回合制多人游戏操作的 TurnBasedMatchesResponse。 |
公共静态属性 |
|
|---|---|
kAutomatchingParticipant
|
const MultiplayerParticipant
可以传递给接受“下一个参与者”的方法的参与者。
|
结构体 |
|
|---|---|
|
gpg:: |
|
|
gpg:: |
|
|
gpg:: |
特定 |
|
gpg:: |
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 时,才能调用此函数。
| 详细信息 | |||||
|---|---|---|---|---|---|
| 参数 |
|
||||
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 )
忽略 TurnBasedMatch 的 MultiplayerInvitation。
这不会改变其他参与者可见的 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 )
异步为当前玩家获取 TurnBasedMatch 和 Invitation 对象。
将返回所有活动比赛和最多 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 时,才能调用此函数。
| 详细信息 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| 参数 |
|
||||||||
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,才能使用此函数。
| 详细信息 | |||||||
|---|---|---|---|---|---|---|---|
| 参数 |
|
||||||
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 年的默认超时时间。
Rematch
void Rematch( const TurnBasedMatch & match, TurnBasedMatchCallback callback )
重新匹配状态为 MatchStatus::COMPLETED 的比赛。
如果可以重新匹配,TurnBasedMatchCallback 会收到新的比赛。
| 详细信息 | |||||
|---|---|---|---|---|---|
| 参数 |
|
||||
RematchBlocking
TurnBasedMatchResponse RematchBlocking( Timeout timeout, const TurnBasedMatch & match )
Rematch 的阻塞版本。
允许调用方指定以毫秒为单位的超时时间。经过指定时间后,函数返回 ERROR_TIMEOUT。
RematchBlocking
TurnBasedMatchResponse RematchBlocking( const TurnBasedMatch & match )
RematchBlocking 的重载,使用 10 年的默认超时时间。
ShowMatchInboxUI
void ShowMatchInboxUI( MatchInboxUICallback callback )
异步显示比赛收件箱 UI,允许玩家选择比赛或邀请。
完成后,选定的比赛或邀请通过 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 )
异步显示玩家选择 UI,允许玩家选择其他玩家一起进行比赛。
完成后,选定的玩家将通过 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 比赛数据。
收到新数据会触发 OnTurnBasedMatchEventCallback 或 OnMultiplayerInvitationReceivedCallback。
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 时,才能调用此函数。
| 详细信息 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 参数 |
|
||||||||||
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 年的默认超时时间。