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	MultiplayerParticipant הפונקציה מחזירה את המשתתף שיצר את ההתאמה הזו.
CreationTime() const	std::chrono::milliseconds הפונקציה מחזירה את השעה שבה הערך של TurnBasedMatch was created (מבוטאת כאלפיות שנייה מאז תחילת התקופה של יוניקס [Unix epoch]).
Data() const	const std::vector< uint8_t > & מחזירה את נתוני ההתאמה, אם הערך HasData() נכון.
Description() const	const std::string & מחזירה סיכום של מצב ההתאמה שנוצר על ידי השרת.
HasData() const	bool הערך הוא True אם לאובייקט הזה יש נתונים שהוגדרו במהלך פנייה קודמת.
HasPreviousMatchData() const	bool הערך הוא True אם זו הפנייה הראשונה של התאמה חוזרת, ונתונים מהשדה Valid בגרסה הקודמת חייבים להחזיר את הערך True כדי שאפשר יהיה להשתמש בפונקציה.
HasRematchId() const	bool הפונקציה מחזירה את הערך true אם ההתאמה הזו הותאמה.
Id() const	const std::string & הפונקציה מחזירה מזהה שמזהה באופן ייחודי את TurnBasedMatch.
LastUpdateTime() const	Timestamp הפונקציה מחזירה את השעה שבה TurnBasedMatch עודכן לאחרונה (מבוטאת כאלפיות שנייה מתחילת התקופה של יוניקס [Unix epoch]).
LastUpdatingParticipant() const	MultiplayerParticipant הפונקציה מחזירה את המשתתף שעדכן את ההתאמה האחרונה.
Number() const	uint32_t מספר שמציין כמה התאמות קדמו להתאמה הזו באמצעות התאמה מחדש.
ParticipantResults() const	const gpg::ParticipantResults & מחזירה את התוצאות של ההתאמה.
Participants() const	const std::vector< MultiplayerParticipant > & וקטור של כל המשתתפים במשחק הזה.
PendingParticipant() const	MultiplayerParticipant הפונקציה מחזירה את המשתתף שתורו לעדכן את ההתאמה הזו.
PreviousMatchData() const	const std::vector< uint8_t > & נתונים מההתאמה הקודמת, אם HasPreviousMatchData().
RematchId() const	const std::string & הפונקציה מחזירה את המזהה של ההתאמה שהיא התאמה חוזרת של ההתאמה הזו, אם היא זמינה.
Status() const	MatchStatus הפונקציה מחזירה את סטטוס ההתאמה של המשתתף המקומי.
SuggestedNextParticipant() const	MultiplayerParticipant פונקציית סיוע שבוחרת משתתף חוקי מתוך קבוצת המשתתפים שהצטרפו, המשתתפים בלתי נמנעים והמשתתפים התואמים אוטומטית.
Valid() const	bool הפונקציה מחזירה true אם TurnBasedMatch הזה מאוכלס בנתונים.
Variant() const	uint32_t הפונקציה מחזירה מזהה וריאנט ספציפי למשחק, שיכול לשמש את המשחק כדי לזהות מצבי משחק שונים.
Version() const	uint32_t מזהה שהולך וגדל באופן מובהק, מתעדכן בכל פעם שמתבצע שינוי בהתאמה.
operator=(const TurnBasedMatch & copy_from)	TurnBasedMatch & הקצאת TurnBasedMatch זה על ידי העתקה מתפקיד אחר.
operator=(TurnBasedMatch && move_from)	TurnBasedMatch & הקצאה של TurnBasedMatch על ידי העברת נכס אחר פנימה.

פונקציות ציבוריות

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const 

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

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

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const 

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

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

CreationTime

std::chrono::milliseconds CreationTime() const 

הפונקציה מחזירה את השעה שבה הערך של TurnBasedMatch was created (מבוטאת כאלפיות שנייה מאז תחילת התקופה של יוניקס [Unix epoch]).

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

HasRematchId

bool HasRematchId() const 

הפונקציה מחזירה את הערך true אם ההתאמה הזו הותאמה.

Id

const std::string & Id() const 

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

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

LastUpdateTime

Timestamp LastUpdateTime() const 

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

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

אפשר לקרוא לפונקציה רק אם הערך של Valid מחזיר 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 באובייקט TurnBasedMatch (Id, CreationTime וכו'...), צריך להחזיר את הערך true.

וריאנט

uint32_t Variant() const 

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

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

גרסה

uint32_t Version() const 

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

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

הקצאת TurnBasedMatch זה על ידי העתקה מתפקיד אחר.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

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