gpg::שחקן

#include <player.h>

מבנה נתונים שמאפשר לגשת לנתונים על שחקן ספציפי.

סיכום

בונים והורסים
Player()
Player(std::shared_ptr< const PlayerImpl > impl) הפונקציה יוצרת נגן מ-shared_ptr ל-PlayerImpl.
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	Timestamp אחזור של חותמת הזמן שבה השחקן הזה עלה לרמה האחרונה.
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().MaximumXP.

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.

שחקן

 Player(
  const Player & copy_from
)

יצירת עותק של נגן קיים.

שחקן

 Player(
  Player && move_from
)

העברת נגן קיים לנגן חדש.

כותרת

const std::string & Title() const 

אחזור של שם השחקן.

הנתון הזה מבוסס על פעולות של השחקן בסביבת המשחקים של Google Play. שימו לב שלא לכל השחקנים יש כותרות, והשם של שחקן עשוי להשתנות עם הזמן. אם אין שם לנגן, הפונקציה Title() תחזיר מחרוזת ריקה.

נתונים תקפים

bool Valid() const 

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

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

אופרטור=

Player & operator=(
  const Player & copy_from
)

הקצאת הנגן הזה באמצעות העתקה מנגן אחר.

אופרטור=

Player & operator=(
  Player && move_from
)

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

~נגן

 ~Player()