gpg:: دعوت چند نفره

#include <multiplayer_invitation.h>

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

خلاصه

سازندگان و تخریب کنندگان
MultiplayerInvitation ()
MultiplayerInvitation (std::shared_ptr< const TurnBasedMatchImpl > impl) یک دعوت چند نفره از یک shared_ptr به یک TurnBasedMatchImpl می سازد.
MultiplayerInvitation (std::shared_ptr< const RealTimeRoomImpl > impl) یک دعوت چند نفره از یک shared_ptr به یک RealTimeRoomImpl می سازد.
MultiplayerInvitation (const MultiplayerInvitation & copy_from) یک کپی از یک دعوت چند نفره موجود ایجاد می کند.
MultiplayerInvitation ( MultiplayerInvitation && move_from) یک دعوت چند نفره موجود را به یک دعوت جدید منتقل می کند.

توابع عمومی
AutomatchingSlotsAvailable () const	uint32_t تعداد اسلات‌های تطبیق خودکار موجود برای مسابقه‌ای که این شیء برای آن دعوت است، برمی‌گرداند.
CreationTime () const	Timestamp زمانی را برمی‌گرداند که در آن TurnBasedMatch برای این دعوت‌نامه ایجاد شده است (که به صورت میلی‌ثانیه از دوران یونیکس بیان می‌شود).
Id () const	const std::string & شناسه‌ای را برمی‌گرداند که به‌طور منحصربه‌فرد این دعوت چند نفره را شناسایی می‌کند.
InvitingParticipant () const	MultiplayerParticipant شرکت‌کننده‌ای را برمی‌گرداند که شرکت‌کننده محلی را به TurnBasedMatch برای این دعوت دعوت کرده است.
Participants () const	const std::vector< MultiplayerParticipant > & بردار همه شرکت کنندگان در TurnBasedMatch برای این دعوت.
Type () const	MultiplayerInvitationType مشخص می کند که آیا این دعوت برای RealTimeRoom است یا TurnBasedMatch .
Valid () const	bool اگر این دعوت چند نفره پر از داده باشد، درست برمی گردد.
Variant () const	uint32_t یک شناسه نوع خاص بازی را برمی‌گرداند که بازی می‌تواند از آن برای شناسایی حالت بازی استفاده کند.
operator= (const MultiplayerInvitation & copy_from)	MultiplayerInvitation & این دعوت چند نفره را با کپی کردن از یکی دیگر اختصاص می دهد.
operator= ( MultiplayerInvitation && move_from)	MultiplayerInvitation & این دعوت چند نفره را با انتقال یک دعوتنامه دیگر به آن اختصاص می دهد.

توابع عمومی

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const 

تعداد اسلات‌های تطبیق خودکار موجود برای مسابقه‌ای که این شیء برای آن دعوت است، برمی‌گرداند.

این مقدار برابر است با تعداد اسلات های تطبیق خودکار که مسابقه با آن ها ایجاد شده است، منهای تعداد شرکت کنندگانی که قبلاً از طریق تطبیق خودکار اضافه شده اند. برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

CreationTime

Timestamp CreationTime() const 

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

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

شناسه

const std::string & Id() const 

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

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

دعوت کننده شرکت کننده

MultiplayerParticipant InvitingParticipant() const 

شرکت‌کننده‌ای را برمی‌گرداند که شرکت‌کننده محلی را به TurnBasedMatch برای این دعوت دعوت کرده است.

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

دعوت چند نفره

 MultiplayerInvitation()

دعوت چند نفره

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

یک دعوت چند نفره از یک shared_ptr به یک TurnBasedMatchImpl می سازد.

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

دعوت چند نفره

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

یک دعوت چند نفره از یک shared_ptr به یک RealTimeRoomImpl می سازد.

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

دعوت چند نفره

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

یک کپی از یک دعوت چند نفره موجود ایجاد می کند.

دعوت چند نفره

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

یک دعوت چند نفره موجود را به یک دعوت جدید منتقل می کند.

شركت كنندگان

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

بردار همه شرکت کنندگان در TurnBasedMatch برای این دعوت.

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

تایپ کنید

MultiplayerInvitationType Type() const 

مشخص می کند که آیا این دعوت برای RealTimeRoom است یا TurnBasedMatch .

معتبر

bool Valid() const 

اگر این دعوت چند نفره پر از داده باشد، درست برمی گردد.

برای اینکه توابع گیرنده ( Id ، Variant و غیره) در این شی MultiplayerInvitation قابل استفاده باشند، باید درست باشد.

گونه

uint32_t Variant() const 

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

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

اپراتور=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

این دعوت چند نفره را با کپی کردن از یکی دیگر اختصاص می دهد.

اپراتور=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

این دعوت چند نفره را با انتقال یک دعوتنامه دیگر به آن اختصاص می دهد.