gpg:: Achievement
#include <achievement.h>
מבנה נתונים יחיד שמאפשר לגשת לנתונים לגבי הסטטוס של הישג ספציפי.
סיכום
הנתונים מורכבים משני סוגים: ספציפיים למשתמש (למשל, אם המשתמש ביטל את הנעילה של ההישג וכו') וגלובלי (למשל, שם ההישג).
בנייה |
|
---|---|
Achievement()
|
|
Achievement(std::shared_ptr< const AchievementImpl > impl)
|
|
Achievement(const Achievement & copy_from)
יצירת עותק של הישג קיים.
|
|
Achievement(Achievement && move_from)
העברת הישג קיים.
|
|
~Achievement()
|
פונקציות ציבוריות |
|
---|---|
CurrentSteps() const
|
uint32_t
הפונקציה מחזירה את מספר הצעדים שהשחקן ביצע כדי להשיג הישג מצטבר.
|
Description() const
|
const std::string &
מחזירה תיאור תמציתי של ההישג.
|
Id() const
|
const std::string &
מחזירה את המחרוזת הייחודית שנוצרה מראש ב-Google Play Console.
|
LastModified() const
|
הוצא משימוש. יש עדיפות ל-LastChangeTime. |
LastModifiedTime() const
|
פונקציה זו מחזירה את הזמן שבו הערך שונה לאחרונה (מבוטא כאלפיות שנייה מאז נקודת הזמן של יוניקס [Unix epoch]).
|
Name() const
|
const std::string &
מחזירה את השם המקוצר של ההישג.
|
RevealedIconUrl() const
|
const std::string &
הפונקציה מחזירה את כתובת ה-URL שמובילה לתמונה של הסמל שנחשף עבור ההישג הזה.
|
State() const
|
מחזירה את מצב ההישג:
HIDDEN , REVEALED או UNLOCKED . |
TotalSteps() const
|
uint32_t
הפונקציה מחזירה את מספר השלבים בסך הכול כדי שהשחקן ישיג הישג מצטבר נתון.
|
Type() const
|
הפונקציה מחזירה את סוג ההישג:
INCREMENTAL או STANDARD . |
UnlockedIconUrl() const
|
const std::string &
הפונקציה מחזירה את כתובת ה-URL שמובילה לתמונה של סמל הנעילה של ההישג הזה.
|
Valid() const
|
bool
הפונקציה מחזירה true כשההישג שהוחזר מאוכלס בנתונים וללוות אותו סטטוס תגובה מוצלחת. FALSE עבור הישג שנוצר על ידי משתמש שלא מאוכלס או עבור הישג מאוכלס שמלווה בסטטוס תגובה שנכשלה.
|
XP() const
|
uint64_t
מספר נקודות הניסיון שהשיג ההישג.
|
operator=(const Achievement & copy_from)
|
הקצאת ההישג הזה על ידי העתקה מהישג אחר.
|
operator=(Achievement && move_from)
|
הקצאת ההישג הזה על ידי העברת הישג אחר להישגים.
|
פונקציות ציבוריות
הישג
Achievement()
הישג
Achievement( std::shared_ptr< const AchievementImpl > impl )
יוצרת הישג מ-shared_ptr
ל-AchievementImpl
.מיועד לשימוש פנימי של ה-API.
CurrentSteps
uint32_t CurrentSteps() const
הפונקציה מחזירה את מספר הצעדים שהשחקן ביצע כדי להשיג הישג מצטבר.
ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
תיאור
const std::string & Description() const
מחזירה תיאור תמציתי של ההישג.
בדרך כלל מנחה את השחקן איך להרוויח את ההישג. עד 500 תווים. ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
Id
const std::string & Id() const
מחזירה את המחרוזת הייחודית שנוצרה מראש ב-Google Play Console.
אפשר להשתמש בו כדי להתייחס להישג בלקוח המשחק שלכם. ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
LastModifiedTime
Timestamp LastModifiedTime() const
פונקציה זו מחזירה את הזמן שבו הערך שונה לאחרונה (מבוטא כאלפיות שנייה מאז תחילת התקופה של יוניקס [Unix epoch]).
ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
שם
const std::string & Name() const
מחזירה את השם המקוצר של ההישג.
עד 100 תווים. ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
RevealedIconUrl
const std::string & RevealedIconUrl() const
הפונקציה מחזירה את כתובת ה-URL שמובילה לתמונה של הסמל שנחשף עבור ההישג הזה.
הסמל יוצג כשההישג נחשף, אבל הוא עדיין לא יינעל. ניתן לקרוא לפונקציה הזו רק כאשר Achievement::Valid() מחזירה True.
מדינה
AchievementState State() const
מחזירה את מצב ההישג: HIDDEN
, REVEALED
או UNLOCKED
.
ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True. מידע נוסף זמין כאן
TotalSteps
uint32_t TotalSteps() const
הפונקציה מחזירה את מספר השלבים בסך הכול כדי שהשחקן ישיג הישג מצטבר נתון.
ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
סוג
AchievementType Type() const
הפונקציה מחזירה את סוג ההישג: INCREMENTAL
או STANDARD
.
ניתן לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True. מידע נוסף זמין כאן
UnlockedIconUrl
const std::string & UnlockedIconUrl() const
הפונקציה מחזירה את כתובת ה-URL שמובילה לתמונה של סמל הנעילה של ההישג הזה.
הסמל הזה יוצג לאחר ביטול הנעילה של ההישג (ולכן גם חשיפה). ניתן לקרוא לפונקציה הזו רק כאשר Achievement::Valid() מחזירה True.
נתונים תקפים
bool Valid() const
הפונקציה מחזירה true כשההישג שהוחזר מאוכלס בנתונים ולצידו מופיע סטטוס תגובה מוצלח. FALSE עבור הישג שנוצר על ידי משתמש שלא מאוכלס או עבור הישג מאוכלס שמלווה בסטטוס תגובה שנכשלה.
הערך הזה חייב להיות נכון כדי שניתן יהיה להשתמש בפונקציות getter בהישג הזה (מזהה, שם, תיאור וכו').
XP
uint64_t XP() const
מספר נקודות הניסיון שההישג הזה קיבל.
אפשר לקרוא לפונקציה רק כאשר Achievement::Valid() מחזירה True.
operator=
Achievement & operator=( const Achievement & copy_from )
הקצאת ההישג הזה על ידי העתקה מהישג אחר.
operator=
Achievement & operator=( Achievement && move_from )
הקצאת ההישג הזה על ידי העברת הישג אחר להישגים.
~Achievement
~Achievement()