gpg::MultiplayerInvitation

#include <multiplayer_invitation.h>

包含回合製對戰邀請目前狀態的資料結構。

摘要

建構函式和解構函式
MultiplayerInvitation()
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
從 shared_ptr 建構 MultiplayerInvitation 至 TurnBasedMatchImpl。
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
從 shared_ptr 建構 MultiplayerInvitation 至 RealTimeRoomImpl。
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
建立現有 MultiplayerInvitation 複本。
MultiplayerInvitation(MultiplayerInvitation && move_from)
將現有的 MultiplayerInvitation 移至新項目。

公開函式
AutomatchingSlotsAvailable() const
uint32_t
傳回針對此物件提供邀請的比對，可用的自動配對版位數量。
CreationTime() const
傳回建立此邀請 TurnBasedMatch 的建立時間 (以 Unix 紀元以來的毫秒數表示)。
Id() const
const std::string &
傳回用來識別此 MultiplayerInvitation 的 ID。
InvitingParticipant() const
傳回邀請本機參與者加入此邀請的 TurnBasedMatch 的參與者。
Participants() const
const std::vector< MultiplayerParticipant > &
此邀請 TurnBasedMatch 中所有參與者的向量。
Type() const
識別這項邀請是針對 RealTimeRoom 或 TurnBasedMatch。
Valid() const
bool
如果這個 MultiplayerInvitation 填入資料，則傳回 true。
Variant() const
uint32_t
傳回遊戲專屬的變化版本 ID，可供遊戲用來識別遊戲模式。
operator=(const MultiplayerInvitation & copy_from)
透過複製另一個玩家的邀請來指派此 MultiplayerInvitation。
operator=(MultiplayerInvitation && move_from)
透過移動另一個玩家的邀請來指派這個MultiplayerInvitation。

公開函式

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

傳回針對此物件提供邀請的比對，可用的自動配對版位數量。

這個值等於建立相符項目的自動配對運算單元數量，減去已透過自動比對功能加入的參與者人數。Valid 必須傳回 true，這個函式才能使用。

CreationTime

Timestamp CreationTime() const

傳回建立此邀請 TurnBasedMatch 的建立時間 (以 Unix 紀元以來的毫秒數表示)。

Valid 必須傳回 true，這個函式才能使用。

ID

const std::string & Id() const

傳回用來識別此 MultiplayerInvitation 的 ID。

Valid 必須傳回 true，這個函式才能使用。

InvitingParticipant

MultiplayerParticipant InvitingParticipant() const

傳回邀請本機參與者加入此邀請的 TurnBasedMatch 的參與者。

Valid 必須傳回 true，這個函式才能使用。

MultiplayerInvitation

 MultiplayerInvitation()

MultiplayerInvitation

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

從 shared_ptr 建構 MultiplayerInvitation 至 TurnBasedMatchImpl。

適用於 API 的內部使用。

MultiplayerInvitation

 MultiplayerInvitation(
  std::shared_ptr< const RealTimeRoomImpl > impl
)

從 shared_ptr 建構 MultiplayerInvitation 至 RealTimeRoomImpl。

適用於 API 的內部使用。

MultiplayerInvitation

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

建立現有 MultiplayerInvitation 複本。

MultiplayerInvitation

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

將現有的 MultiplayerInvitation 移至新項目。

參與者

const std::vector< MultiplayerParticipant > & Participants() const

此邀請 TurnBasedMatch 中所有參與者的向量。

Valid 必須傳回 true，這個函式才能使用。

類型

MultiplayerInvitationType Type() const

識別這項邀請是針對 RealTimeRoom 或 TurnBasedMatch。

有效

bool Valid() const

如果這個 MultiplayerInvitation 填入資料，則傳回 true。

必須為 true，才能使用此 MultiplayerInvitation 物件的 getter 函式 (Id、Variant 等)。

Variant

uint32_t Variant() const

傳回遊戲專屬的變化版本 ID，可供遊戲用來識別遊戲模式。

Valid 必須傳回 true，這個函式才能使用。

operator=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

透過複製另一個玩家的邀請來指派此 MultiplayerInvitation。

operator=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

透過移動另一個玩家的邀請來指派這個MultiplayerInvitation。