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 הזה (מבוטאת באלפיות השנייה מאז תחילת התקופה של יוניקס [Unix epoch]).
Description() const
std::string
הפונקציה מחזירה סיכום של מצב החדר שנוצר על ידי השרת.
Id() const
const std::string &
מחזירה מזהה שמזהה באופן ייחודי את אובייקט RealTimeRoom הזה.
Participants() const
std::vector< MultiplayerParticipant >
וקטור של כל המשתתפים בחדר הזה.
RemainingAutomatchingSlots() const
uint32_t
הפונקציה מחזירה את מספר המשבצות להתאמה אוטומטית בחדר.
Status() const
הפונקציה מחזירה את הסטטוס של החדר.
Valid() const
bool
הפונקציה מחזירה true אם האובייקט RealTimeRoom הזה מאוכלס בנתונים.
Variant() const
uint32_t
הפונקציה מחזירה מזהה וריאנט ספציפי למשחק, שיכול לשמש את המשחק כדי לזהות מצבי משחק שונים.
operator=(const RealTimeRoom & copy_from)
הקצאת אובייקט RealTimeRoom זה על ידי העתקה מאובייקט אחר.
operator=(RealTimeRoom && move_from)
הקצאת אובייקט RealTimeRoom זה על ידי העברת אובייקט אחר אליו.

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

AutomatchWaitEstimate

Timeout AutomatchWaitEstimate() const

אומדן שנוצר על ידי השרת לגבי כמה זמן ייקח למלא את משבצות ההתאמה האוטומטית של החדר.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

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

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

CreationTime

std::chrono::milliseconds CreationTime() const

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

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

תיאור

std::string Description() const

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

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

Id

const std::string & Id() const

מחזירה מזהה שמזהה באופן ייחודי את אובייקט RealTimeRoom הזה.

כדי לאחזר את החדר הזה מאוחר יותר, צריך להשתמש במזהה הזה עם RealTimeRoom::FetchRoom.

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

משתתפים

std::vector< MultiplayerParticipant > Participants() const

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

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

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

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

סטטוס

RealTimeRoomStatus Status() const

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

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

נתונים תקפים

bool Valid() const

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

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

וריאנט

uint32_t Variant() const

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

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

operator=

RealTimeRoom & operator=(
  const RealTimeRoom & copy_from
)

הקצאת אובייקט RealTimeRoom זה על ידי העתקה מאובייקט אחר.

operator=

RealTimeRoom & operator=(
  RealTimeRoom && move_from
)

הקצאת אובייקט RealTimeRoom זה על ידי העברת אובייקט אחר אליו.