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 を返す必要があります。
説明
std::string Description() const
サーバーによって生成された、部屋の状態に関する概要を返します。
この関数を使用できるようにするには、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 を返す必要があります。
演算子=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
この RealTimeRoom
オブジェクトを別のオブジェクトからコピーして割り当てます。
演算子=
RealTimeRoom & operator=( RealTimeRoom && move_from )
この RealTimeRoom
オブジェクトに別のオブジェクトを移動して割り当てます。