gpg::
#include <real_time_room.h>
מבנה נתונים שמכיל את המצב הנוכחי של חדר רב-משתתפים בזמן אמת.
סיכום
בונים והורסים |
|
|---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
יוצר עותק של אובייקט
RealTimeRoom קיים. |
|
RealTimeRoom(RealTimeRoom && move_from)
העברת אובייקט
RealTimeRoom קיים. |
תפקידים ציבוריים |
|
|---|---|
AutomatchWaitEstimate() const
|
הערכה שנוצרה על ידי השרת לגבי משך הזמן שייקח לך למלא את משבצות ההתאמה האוטומטית בחדר הזה.
|
CreatingParticipant() const
|
מחזירה את המשתתף שיצר את החדר.
|
CreationTime() const
|
std::chrono::milliseconds
מחזירה את השעה שבה נוצר האובייקט
RealTimeRoom (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix). |
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).
כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר 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.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
מחזירה את מספר המשבצות הזמינות להתאמה אוטומטית בחדר.
המספר הזה שווה למספר המשבצות להתאמה אוטומטית שבהן החדר נוצר, פחות מספר המשתתפים שכבר נוספו באמצעות ההתאמה האוטומטית. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.
סטטוס
RealTimeRoomStatus Status() const
מחזירה את הסטטוס של החדר.
הסטטוס קובע אילו פעולות אפשר לבצע בחדר. כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.
נתונים תקפים
bool Valid() const
הפונקציה מחזירה את הערך True אם האובייקט RealTimeRoom מאוכלס בנתונים.
כדי שניתן יהיה להשתמש בפונקציות getter (פונקציית getter) באובייקט RealTimeRoom (Id, CreationTime וכו'...), יש להחזיר true.
וריאנט
uint32_t Variant() const
מחזירה מזהה וריאנט ספציפי למשחק, שיכול לשמש את המשחק לזיהוי מצבי משחק שונים.
כדי שיהיה אפשר להשתמש בפונקציה הזו, הערך תקין חייב להחזיר true.
אופרטור=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
הפונקציה מקצה את האובייקט RealTimeRoom הזה על ידי העתקה מאובייקט אחר.
אופרטור=
RealTimeRoom & operator=( RealTimeRoom && move_from )
הפונקציה הזאת מקצה את האובייקט RealTimeRoom על ידי העברה של אובייקט אחר אליו.