gpg:: RealTimeRoom
#include <real_time_room.h>
リアルタイムのマルチプレーヤー ルームの現在の状態を含むデータ構造。
概要
コンストラクタとデストラクタ |
|
---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
既存の
RealTimeRoom オブジェクトのコピーを作成します。 |
|
RealTimeRoom(RealTimeRoom && move_from)
既存の
RealTimeRoom オブジェクトを移動します。 |
パブリック関数 |
|
---|---|
AutomatchWaitEstimate() const
|
この会議室の自動マッチング スロットが埋まるまでの推定所要時間をサーバーによって推定したものです。
|
CreatingParticipant() const
|
この会議室を作成した参加者を返します。
|
CreationTime() const
|
std::chrono::milliseconds
この
RealTimeRoom オブジェクトが作成された時刻を返します(Unix エポックからのミリ秒数で表されます)。 |
Description() const
|
std::string
サーバーが生成した、会議室の状態の概要を返します。
|
Id() const
|
const std::string &
この
RealTimeRoom オブジェクトを一意に識別する ID を返します。 |
Participants() const
|
std::vector< MultiplayerParticipant >
このルーム内のすべての参加者のベクター。
|
RemainingAutomatchingSlots() const
|
uint32_t
会議室で使用可能な自動一致スロットの数を返します。
|
Status() const
|
ルームのステータスを返します。
|
Valid() const
|
bool
この
RealTimeRoom オブジェクトにデータが入力されている場合、true を返します。 |
Variant() const
|
uint32_t
ゲームがさまざまなゲームモードを識別するために使用できる、ゲーム固有のバリアント ID を返します。
|
operator=(const RealTimeRoom & copy_from)
|
別のオブジェクトからコピーすることで、この
RealTimeRoom オブジェクトを割り当てます。 |
operator=(RealTimeRoom && move_from)
|
この
RealTimeRoom オブジェクトを、別のオブジェクトを移動して割り当てます。 |
パブリック関数
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
この会議室の自動マッチング スロットが埋まるまでの推定所要時間をサーバーによって推定したものです。
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
この会議室を作成した参加者を返します。
この関数を使用するには、Valid が true を返す必要があります。
CreationTime
std::chrono::milliseconds CreationTime() const
この RealTimeRoom
オブジェクトが作成された時刻を返します(Unix エポックからのミリ秒数で表されます)。
この関数を使用するには、Valid が true を返す必要があります。
ID
const std::string & Id() const
この RealTimeRoom
オブジェクトを一意に識別する ID を返します。
後でこの部屋を取得するには、この ID と RealTimeRoom::FetchRoom
を使用します。
この関数を使用するには、Valid が true を返す必要があります。
参加者数
std::vector< MultiplayerParticipant > Participants() const
このルーム内のすべての参加者のベクター。
この関数を使用するには、Valid が true を返す必要があります。
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
shared_ptr
から RealTimeRoomImpl
オブジェクトへの RealTimeRoom
オブジェクトを構築します。
API の内部で使用することを目的としています。
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
会議室で使用可能な自動一致スロットの数を返します。
この数は、会議室が作成された自動対戦のスロット数から自動対戦によってすでに追加されている参加者の数を引いた数になります。この関数を使用するには、Valid が true を返す必要があります。
ステータス
RealTimeRoomStatus Status() const
ルームのステータスを返します。
ステータスによって、会議室に対して実施できる操作が決まります。この関数を使用するには、Valid が true を返す必要があります。
有効
bool Valid() const
この RealTimeRoom
オブジェクトにデータが入力されている場合、true を返します。
RealTimeRoom
オブジェクトのゲッター関数(Id
、CreationTime
など)を使用できるようにするには、true を返す必要があります。
パターン
uint32_t Variant() const
ゲームがさまざまなゲームモードを識別するために使用できる、ゲーム固有のバリアント ID を返します。
この関数を使用するには、Valid が true を返す必要があります。
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
別のオブジェクトからコピーすることで、この RealTimeRoom
オブジェクトを割り当てます。
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
この RealTimeRoom
オブジェクトを、別のオブジェクトを移動して割り当てます。