gpg:: TurnBasedMatch

#include <turn_based_match.h>

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

خلاصه

سازندگان و تخریب کنندگان

TurnBasedMatch ()
TurnBasedMatch (std::shared_ptr< const TurnBasedMatchImpl > impl)
یک TurnBasedMatch از shared_ptr به TurnBasedMatchImpl می سازد.
TurnBasedMatch (const TurnBasedMatch & copy_from)
یک کپی از TurnBasedMatch موجود ایجاد می کند.
TurnBasedMatch ( TurnBasedMatch && move_from)
یک TurnBasedMatch موجود را منتقل می کند.

توابع عمومی

AutomatchingSlotsAvailable () const
uint32_t
تعداد اسلات‌های تطبیق خودکار موجود برای مسابقه را برمی‌گرداند.
CreatingParticipant () const
شرکت کننده ای که این مسابقه را ایجاد کرده است را برمی گرداند.
CreationTime () const
std::chrono::milliseconds
زمانی را برمی‌گرداند که در آن TurnBasedMatch was created (که به صورت میلی‌ثانیه از دوران یونیکس بیان می‌شود).
Data () const
const std::vector< uint8_t > &
اگر HasData() درست باشد، داده‌های مطابقت را برمی‌گرداند.
Description () const
const std::string &
خلاصه ای از وضعیت مسابقه ایجاد شده توسط سرور را برمی گرداند.
HasData () const
bool
اگر این شی داده‌هایی داشته باشد که در چرخش قبلی تنظیم شده‌اند، درست است.
HasPreviousMatchData () const
bool
اگر این اولین نوبت یک مسابقه مجدد باشد، درست است، و داده‌های Valid قبلی باید true باشد تا این تابع قابل استفاده باشد.
HasRematchId () const
bool
اگر این مسابقه مجدداً مسابقه داده شده باشد، درست برمی‌گردد.
Id () const
const std::string &
شناسه‌ای را برمی‌گرداند که به‌طور منحصربه‌فرد این TurnBasedMatch را شناسایی می‌کند.
LastUpdateTime () const
زمانی را که این TurnBasedMatch آخرین بار به روز شده است (به صورت میلی ثانیه از دوره یونیکس بیان می شود) برمی گرداند.
LastUpdatingParticipant () const
شرکت کننده ای را که اخیراً این مسابقه را به روز کرده است برمی گرداند.
Number () const
uint32_t
عددی که نشان می دهد چند مسابقه قبل از این مسابقه از طریق مسابقه مجدد انجام شده است.
ParticipantResults () const
نتایج مسابقه را برمی گرداند.
Participants () const
const std::vector< MultiplayerParticipant > &
بردار تمام شرکت کنندگان در این مسابقه.
PendingParticipant () const
شرکت‌کننده‌ای را برمی‌گرداند که نوبت به‌روزرسانی این مسابقه است.
PreviousMatchData () const
const std::vector< uint8_t > &
داده‌های مسابقه قبلی، اگر HasPreviousMatchData() .
RematchId () const
const std::string &
شناسه مسابقه را که یک مسابقه مجدد از این مسابقه است، در صورت موجود بودن، برمی گرداند.
Status () const
وضعیت مسابقه را برای شرکت کننده محلی برمی گرداند.
SuggestedNextParticipant () const
یک تابع کمکی که یک شرکت‌کننده معتبر را از مجموعه شرکت‌کنندگان پیوسته، دعوت‌شونده و همسان خودکار انتخاب می‌کند.
Valid () const
bool
اگر این TurnBasedMatch پر از داده باشد، true برمی‌گرداند.
Variant () const
uint32_t
یک شناسه نوع خاص بازی را برمی‌گرداند که می‌تواند توسط یک بازی برای شناسایی حالت‌های مختلف بازی استفاده شود.
Version () const
uint32_t
یک شناسه کاملاً افزایشی که هر بار که مطابقت تغییر می‌کند، به‌روزرسانی می‌شود.
operator= (const TurnBasedMatch & copy_from)
این TurnBasedMatch با کپی کردن از یکی دیگر اختصاص می دهد.
operator= ( TurnBasedMatch && move_from)
این TurnBasedMatch با انتقال یکی دیگر به آن اختصاص می دهد.

توابع عمومی

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

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

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

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

MultiplayerParticipant CreatingParticipant() const

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

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

CreationTime

std::chrono::milliseconds CreationTime() const

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

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

داده ها

const std::vector< uint8_t > & Data() const

اگر HasData() درست باشد، داده‌های مطابقت را برمی‌گرداند.

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

شرح

const std::string & Description() const

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

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

HasData

bool HasData() const

اگر این شی داده‌هایی داشته باشد که در چرخش قبلی تنظیم شده‌اند، درست است.

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

HasPreviousMatchData

bool HasPreviousMatchData() const

اگر این اولین نوبت یک مسابقه مجدد باشد، درست است، و داده‌های Valid قبلی باید true باشد تا این تابع قابل استفاده باشد.

HasRematchId

bool HasRematchId() const

اگر این مسابقه مجدداً مسابقه داده شده باشد، درست برمی‌گردد.

شناسه

const std::string & Id() const

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

با TurnBasedMultiplayerManager::FetchMatch برای بازیابی این تطابق در مرحله بعد استفاده کنید. برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

LastUpdateTime

Timestamp LastUpdateTime() const

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

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

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

شرکت کننده ای را که اخیراً این مسابقه را به روز کرده است برمی گرداند.

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

عدد

uint32_t Number() const

عددی که نشان می دهد چند مسابقه قبل از این مسابقه از طریق مسابقه مجدد انجام شده است.

در مسابقه اول روی 1 تنظیم شده است و در هر مسابقه مجدد یک عدد افزایش می یابد.

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

const gpg::ParticipantResults & ParticipantResults() const

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

نتایج را می توان از طریق TurnBasedMultiplayerManager::TakeMyTurn ، TurnBasedMultiplayerManager::FinishDuringMyTurn و سایر توابع مرتبط تنظیم کرد. همیشه از ParticipantResults() .WithResult(...) برای ایجاد یک شیء ParticipantResults جدید مطابق با هر شیء موجود استفاده کنید. برای اینکه این تابع قابل استفاده باشد، Valid باید true باشد.

شركت كنندگان

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

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

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

در انتظار شرکت کننده

MultiplayerParticipant PendingParticipant() const

شرکت‌کننده‌ای را برمی‌گرداند که نوبت به‌روزرسانی این مسابقه است.

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

PreviousMatchData

const std::vector< uint8_t > & PreviousMatchData() const

داده‌های مسابقه قبلی، اگر HasPreviousMatchData() .

فقط در صورتی می توان فراخوانی کرد که Valid true را برگرداند.

RematchId

const std::string & RematchId() const

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

وضعیت

MatchStatus Status() const

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

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

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

یک تابع کمکی که یک شرکت‌کننده معتبر را از مجموعه شرکت‌کنندگان پیوسته، دعوت‌شونده و همسان خودکار انتخاب می‌کند.

اگر همیشه از این تابع برای انتخاب شرکت‌کننده بعدی استفاده شود، بازی به ترتیب از طریق همه شرکت‌کنندگان ادامه می‌یابد و در صورت لزوم تکرار می‌شود. این تابع فقط در صورتی باید فراخوانی شود که Status() MatchStatus::MY_TURN باشد، زیرا این تنها زمانی است که می توان از نتیجه این تابع به طور معناداری استفاده کرد. اگر به اشتباه فراخوانی شود، این تابع یک شرکت‌کننده نامعتبر را برمی‌گرداند ( MultiplayerParticipant::Valid() == false ).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

یک TurnBasedMatch از shared_ptr به TurnBasedMatchImpl می سازد.

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

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

یک کپی از TurnBasedMatch موجود ایجاد می کند.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

یک TurnBasedMatch موجود را منتقل می کند.

معتبر

bool Valid() const

اگر این TurnBasedMatch پر از داده باشد، true برمی‌گرداند.

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

گونه

uint32_t Variant() const

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

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

نسخه

uint32_t Version() const

یک شناسه کاملاً افزایشی که هر بار که مطابقت تغییر می‌کند، به‌روزرسانی می‌شود.

اپراتور=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

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

اپراتور=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

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