gpg:: נגן
#include <player.h>
מבנה נתונים שמאפשר לגשת לנתונים על שחקן ספציפי.
סיכום
בנייה |
|
---|---|
Player()
|
|
Player(std::shared_ptr< const PlayerImpl > impl)
|
|
Player(const Player & copy_from)
יצירת עותק של נגן קיים.
|
|
Player(Player && move_from)
העברת שחקן קיים לשחקן חדש.
|
|
~Player()
|
פונקציות ציבוריות |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
הפונקציה מחזירה את כתובת ה-URL שבה נמצאת תמונת הדמות של השחקן.
|
CurrentLevel() const
|
const PlayerLevel &
אחזור נתוני הרמה הנוכחיים של הנגן, אם הם ידועים.
|
CurrentXP() const
|
uint64_t
אחזור של סך ה-XP הנוכחי של השחקן.
|
HasLevelInfo() const
|
bool
הפונקציה מחזירה אם יש לנגן הזה מידע זמין על הרמות.
|
Id() const
|
const std::string &
הפונקציה מחזירה את הערך
Id של הנגן שמחובר כרגע. |
LastLevelUpTime() const
|
אחזור חותמת הזמן שבה השחקן עלה לרמה האחרונה.
|
Name() const
|
const std::string &
מחזירה את שם Google+ של הנגן שמחובר כרגע.
|
NextLevel() const
|
const PlayerLevel &
אחזור של נתוני הרמה הבאה של הנגן הזה, אם הם ידועים.
|
Title() const
|
const std::string &
מאחזר את שם הנגן.
|
Valid() const
|
bool
הפונקציה מחזירה true כשהנגן שהוחזר מאוכלס בנתונים ולצידו סטטוס תגובה מוצלחת. FALSE עבור נגן לא מאוכלס שנוצר על ידי משתמש או עבור נגן מאוכלס שמלווה בסטטוס תגובה שנכשלה.
|
operator=(const Player & copy_from)
|
Player &
הקצאת הנגן הזה על ידי העתקה מהנגן אחר.
|
operator=(Player && move_from)
|
Player &
הקצאת ערך של נגן על ידי העברת ערך אחר אליו.
|
פונקציות ציבוריות
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
הפונקציה מחזירה את כתובת ה-URL שבה נמצאת תמונת הדמות של השחקן.
הפרמטר ImageResolution
מציין את הרזולוציה של התמונה. כדי שאפשר יהיה להשתמש בפונקציה הזו, הערך של Player::Valid()
חייב להיות True.
CurrentLevel
const PlayerLevel & CurrentLevel() const
אחזור נתוני הרמה הנוכחיים של הנגן, אם הם ידועים.
אם הפונקציה HasLevelInfo() מחזירה את הערך false, היא מחזירה אובייקט PlayerLevel שעבורו גם Valid() מחזירה את הערך false.
CurrentXP
uint64_t CurrentXP() const
אחזור של סך ה-XP הנוכחי של השחקן.
אם הפונקציה HasLevelInfo() מחזירה את הערך false, היא מחזירה אפס. אם HasLevelInfo() מחזירה את הערך True, סכום ה-XP הנוכחי של הנגן יהיה בטווח CurrentLevel().MinimumXP עד CurrentLevel().maxXP.
HasLevelInfo
bool HasLevelInfo() const
הפונקציה מחזירה אם יש לנגן הזה מידע זמין על הרמות.
אם היא מחזירה False, CurrentLevel()
ו-NextLevel()
יחזירו PlayerLevel
אובייקטים לא חוקיים.
Id
const std::string & Id() const
הפונקציה מחזירה את הערך Id
של הנגן שמחובר כרגע.
כדי שאפשר יהיה להשתמש בפונקציה הזו, הערך של Player::Valid()
חייב להיות True.
LastLevelUpTime
Timestamp LastLevelUpTime() const
אחזור חותמת הזמן שבה השחקן עלה לרמה האחרונה.
אם HasLevelInfo() מחזירה את הערך False, או אם הנגן אף פעם לא עלה לרמה הבאה, הפעולה תחזיר אפס (ראשית).
שם
const std::string & Name() const
מחזירה את שם Google+ של הנגן שמחובר כרגע.
כדי שאפשר יהיה להשתמש בפונקציה הזו, הערך של Player::Valid()
חייב להיות True.
NextLevel
const PlayerLevel & NextLevel() const
אחזור של נתוני הרמה הבאה של הנגן הזה, אם הם ידועים.
אם הפונקציה HasLevelInfo() מחזירה את הערך false, היא מחזירה אובייקט PlayerLevel שעבורו גם Valid() מחזירה את הערך false. זו הרמה שהנגן עובד עליה כרגע. אם הנגן כבר נמצא ברמה המקסימלית שאליה הוא יכול להגיע, CurrentLevel() ו-NextLevel() מחזירה ערכים זהים.
שחקן
Player()
שחקן
Player( std::shared_ptr< const PlayerImpl > impl )
יוצרת נגן מ-shared_ptr
ל-PlayerImpl
.
מיועד לשימוש פנימי של ה-API.
כותרת
const std::string & Title() const
מאחזר את שם הנגן.
הפעולות האלה מבוססות על הפעולות שהשחקן ביצע בסביבה העסקית של Google Play Games. לתשומת ליבכם: לא לכל השחקנים יש כותרות, וששם השחקן עשוי להשתנות עם הזמן. אם לשחקן אין כותרת, Title() מחזירה מחרוזת ריקה.
נתונים תקפים
bool Valid() const
הפונקציה מחזירה true כשהנגן שהוחזר מאוכלס בנתונים ולצידו סטטוס תגובה מוצלחת. FALSE עבור נגן לא מאוכלס שנוצר על ידי משתמש או עבור נגן מאוכלס שמלווה בסטטוס תגובה שנכשלה.
הוא צריך להחזיר את הערך true כדי שאפשר יהיה להשתמש בפונקציות getter באובייקט הזה.
~נגן
~Player()