gpg::MultiplayerInvitation

#include <multiplayer_invitation.h>

ターン制対戦への招待の現在の状態に関するデータを含むデータ構造。

概要

コンストラクタとデストラクタ
MultiplayerInvitation()
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
shared_ptr から TurnBasedMatchImpl への MultiplayerInvitation を作成します。
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
shared_ptr から RealTimeRoomImpl への MultiplayerInvitation を作成します。
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 から TurnBasedMatchImpl への MultiplayerInvitation を作成します。

API の内部で使用することを目的としています。

MultiplayerInvitation

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

shared_ptr から RealTimeRoomImpl への MultiplayerInvitation を作成します。

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 を返します。

この MultiplayerInvitation オブジェクトのゲッター関数（Id、Variant など）を使用できるようにするには、true でなければなりません。

パターン

uint32_t Variant() const

ゲームがゲームモードを識別するために使用できる、ゲーム固有のバリアント ID を返します。

この関数を使用するには、Valid が true を返す必要があります。

operator=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

別のプレーヤーからコピーすることで、この MultiplayerInvitation を割り当てます。

operator=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

別のプレーヤーを移動して、この MultiplayerInvitation を割り当てます。