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
מחזירה את מספר יחידות הקיבולת (Slot) הזמינות להתאמה אוטומטית.
CreatingParticipant() const
מחזירה את המשתתף שיצר את ההתאמה הזו.
CreationTime() const
std::chrono::milliseconds
מחזירה את הזמן שבו TurnBasedMatch was created זה (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).
Data() const
const std::vector< uint8_t > &
מחזירה את נתוני ההתאמה, אם HasData() הוא TRUE.
Description() const
const std::string &
מחזירה סיכום שנוצר על ידי השרת של מצב ההתאמה.
HasData() const
bool
הערך הוא True אם לאובייקט הזה יש נתונים שהוגדרו במהלך פנייה קודמת.
HasPreviousMatchData() const
bool
הערך הוא True אם זו הפנייה הראשונה של התאמה חוזרת, והנתונים מהפונקציה תקין הקודמת חייבים להחזיר את הערך true כדי שיהיה אפשר להשתמש בפונקציה הזו.
HasRematchId() const
bool
מחזירה TRUE אם ההתאמה הזו בוצעה מחדש.
Id() const
const std::string &
הפונקציה מחזירה מזהה שמזהה באופן ייחודי את TurnBasedMatch.
LastUpdateTime() const
מחזירה את השעה שבה עודכן לאחרונה TurnBasedMatch (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).
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
הפונקציה מחזירה את הערך True אם השדה TurnBasedMatch מאוכלס בנתונים.
Variant() const
uint32_t
מחזירה מזהה וריאנט ספציפי למשחק, שיכול לשמש את המשחק לזיהוי מצבי משחק שונים.
Version() const
uint32_t
מזהה המצטבר ישירות, ומתעדכן בכל פעם שמשנים התאמה.
operator=(const TurnBasedMatch & copy_from)
הקצאת TurnBasedMatch באמצעות העתקה ממכשיר אחר.
operator=(TurnBasedMatch && move_from)
הפונקציה מקצה את TurnBasedMatch על ידי העברת כרטיס אחר אליו.

תפקידים ציבוריים

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

מחזירה את מספר יחידות הקיבולת (Slot) הזמינות להתאמה אוטומטית.

מספר זה שווה למספר המשבצות להתאמה אוטומטית שאיתן נוצרה ההתאמה, פחות מספר המשתתפים שכבר נוספו באמצעות ההתאמה האוטומטית. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

מחזירה את המשתתף שיצר את ההתאמה הזו.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

CreationTime

std::chrono::milliseconds CreationTime() const

מחזירה את הזמן שבו TurnBasedMatch was created זה (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

נתונים

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

מחזירה את נתוני ההתאמה, אם HasData() הוא TRUE.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

התיאור

const std::string & Description() const

מחזירה סיכום שנוצר על ידי השרת של מצב ההתאמה.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

HasData

bool HasData() const

הערך הוא True אם לאובייקט הזה יש נתונים שהוגדרו במהלך פנייה קודמת.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

HasPreviousMatchData

bool HasPreviousMatchData() const

הערך הוא True אם זו הפנייה הראשונה של התאמה חוזרת, והנתונים מהפונקציה תקין הקודמת חייבים להחזיר את הערך true כדי שיהיה אפשר להשתמש בפונקציה הזו.

HasRematchId

bool HasRematchId() const

מחזירה TRUE אם ההתאמה הזו בוצעה מחדש.

Id

const std::string & Id() const

הפונקציה מחזירה מזהה שמזהה באופן ייחודי את TurnBasedMatch.

אפשר להשתמש בשילוב עם TurnBasedMultiplayerManager::FetchMatch כדי לאחזר את ההתאמה הזו בשלב מאוחר יותר. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

LastUpdateTime

Timestamp LastUpdateTime() const

מחזירה את השעה שבה עודכן לאחרונה TurnBasedMatch (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

מחזירה את המשתתף שעדכן את ההתאמה האחרונה.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

מספרים

uint32_t Number() const

מספר שמציין כמה התאמות קדמו לתוצאה הזו באמצעות התאמה מחדש.

מוגדר כ-1 בהתאמה הראשונה, ומתווסף לאחד בכל משחק חוזר.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

מחזירה את התוצאות עבור ההתאמה.

אפשר להגדיר את התוצאות באמצעות TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn ועוד פונקציות קשורות. יש להשתמש תמיד ב-ParticipantResults().WithResult(...) כדי ליצור אובייקט ParticipantResults חדש התואם לאובייקטים הקיימים. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

משתתפים

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

וקטור של כל המשתתפים במשחק הזה.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

PendingParticipant

MultiplayerParticipant PendingParticipant() const

מחזירה את המשתתף שתורו לעדכן את ההתאמה הזו.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

PreviousMatchData

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

נתונים מההתאמה הקודמת, אם HasPreviousMatchData().

הפונקציה יכולה לקרוא רק אם הערך תקין מחזיר את הערך True.

RematchId

const std::string & RematchId() const

מחזירה את המזהה של ההתאמה שהיא התאמה חוזרת, אם היא זמינה.

סטטוס

MatchStatus Status() const

מחזירה את סטטוס ההתאמה עבור המשתתף המקומי.

הסטטוס קובע אילו פעולות אפשר לבצע בהתאמה. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר 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

הפונקציה מחזירה את הערך True אם השדה TurnBasedMatch מאוכלס בנתונים.

כדי שניתן יהיה להשתמש בפונקציות getter (פונקציית getter) באובייקט TurnBasedMatch (Id, CreationTime וכו'...), יש להחזיר true.

וריאנט

uint32_t Variant() const

מחזירה מזהה וריאנט ספציפי למשחק, שיכול לשמש את המשחק לזיהוי מצבי משחק שונים.

כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.

גרסה

uint32_t Version() const

מזהה המצטבר ישירות, ומתעדכן בכל פעם שמשנים התאמה.

אופרטור=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

הקצאת TurnBasedMatch באמצעות העתקה ממכשיר אחר.

אופרטור=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

הפונקציה מקצה את TurnBasedMatch על ידי העברת כרטיס אחר אליו.