gpg:: RealTimeRoom

#include <real_time_room.h>

یک ساختار داده حاوی وضعیت فعلی یک اتاق چند نفره بلادرنگ.

خلاصه

سازندگان و ویرانگرها

RealTimeRoom ()
RealTimeRoom (std::shared_ptr< const RealTimeRoomImpl > impl)
یک شی RealTimeRoom از یک shared_ptr به یک شی RealTimeRoomImpl می سازد.
RealTimeRoom (const RealTimeRoom & copy_from)
یک کپی از یک شی RealTimeRoom موجود ایجاد می کند.
RealTimeRoom ( RealTimeRoom && move_from)
یک شی RealTimeRoom موجود را جابجا می کند.

توابع عمومی

AutomatchWaitEstimate () const
تخمین ایجاد شده توسط سرور از مدت زمانی که برای پر کردن شکاف‌های تطبیق خودکار این اتاق طول می‌کشد.
CreatingParticipant () const
شرکت کننده ای را که این اتاق را ایجاد کرده است برمی گرداند.
CreationTime () const
std::chrono::milliseconds
زمانی را برمی‌گرداند که در آن شی RealTimeRoom ایجاد شده است (به صورت میلی‌ثانیه از دوران یونیکس بیان می‌شود).
Description () const
std::string
خلاصه ای از وضعیت اتاق ایجاد شده توسط سرور را برمی گرداند.
Id () const
const std::string &
شناسه‌ای را برمی‌گرداند که به‌طور منحصربه‌فرد این شی RealTimeRoom را شناسایی می‌کند.
Participants () const
std::vector< MultiplayerParticipant >
بردار همه شرکت کنندگان در این اتاق.
RemainingAutomatchingSlots () const
uint32_t
تعداد اسلات‌های تطبیق خودکار موجود برای اتاق را برمی‌گرداند.
Status () const
وضعیت اتاق را برمی گرداند.
Valid () const
bool
اگر این شی RealTimeRoom با داده پر شده باشد، مقدار true را برمی گرداند.
Variant () const
uint32_t
یک شناسه نوع خاص بازی را برمی‌گرداند که می‌تواند توسط یک بازی برای شناسایی حالت‌های مختلف بازی استفاده شود.
operator= (const RealTimeRoom & copy_from)
این شی RealTimeRoom را با کپی کردن از یکی دیگر اختصاص می دهد.
operator= ( RealTimeRoom && move_from)
این شی RealTimeRoom را با انتقال یک شی دیگر به آن اختصاص می دهد.

توابع عمومی

AutomatchWaitEstimate 

Timeout AutomatchWaitEstimate() const

تخمین ایجاد شده توسط سرور از مدت زمانی که برای پر کردن شکاف‌های تطبیق خودکار این اتاق طول می‌کشد.

ایجاد شرکت کننده 

MultiplayerParticipant CreatingParticipant() const

شرکت کننده ای را که این اتاق را ایجاد کرده است برمی گرداند.

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

CreationTime 

std::chrono::milliseconds CreationTime() const

زمانی را برمی‌گرداند که در آن شی RealTimeRoom ایجاد شده است (به صورت میلی‌ثانیه از دوران یونیکس بیان می‌شود).

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

توضیحات 

std::string Description() const

خلاصه ای از وضعیت اتاق ایجاد شده توسط سرور را برمی گرداند.

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

شناسه 

const std::string & Id() const

شناسه‌ای را برمی‌گرداند که به‌طور منحصربه‌فرد این شی RealTimeRoom را شناسایی می‌کند.

برای بازیابی این اتاق در مرحله بعدی، از این شناسه با RealTimeRoom::FetchRoom استفاده کنید.

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

شرکت کنندگان 

std::vector< MultiplayerParticipant > Participants() const

بردار همه شرکت کنندگان در این اتاق.

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

RealTimeRoom 

 RealTimeRoom()

RealTimeRoom 

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

یک شی RealTimeRoom از یک shared_ptr به یک شی RealTimeRoomImpl می سازد.

برای استفاده داخلی توسط API در نظر گرفته شده است.

RealTimeRoom 

 RealTimeRoom(
  const RealTimeRoom & copy_from
)

یک کپی از یک شی RealTimeRoom موجود ایجاد می کند.

RealTimeRoom 

 RealTimeRoom(
  RealTimeRoom && move_from
)

یک شی RealTimeRoom موجود را جابجا می کند.

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

یک شناسه نوع خاص بازی را برمی‌گرداند که می‌تواند توسط یک بازی برای شناسایی حالت‌های مختلف بازی استفاده شود.

برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

اپراتور= 

RealTimeRoom & operator=(
  const RealTimeRoom & copy_from
)

این شی RealTimeRoom را با کپی کردن از یکی دیگر اختصاص می دهد.

اپراتور= 

RealTimeRoom & operator=(
  RealTimeRoom && move_from
)

این شی RealTimeRoom را با انتقال یک شی دیگر به آن اختصاص می دهد.