gpg::AchievementManager

#include <achievement_manager.h>

מקבל ומגדיר נתונים שונים הקשורים להישגים.

סיכום

סוגים ציבוריים
FetchAllCallback typedef
std::function< void(const FetchAllResponse &)>
מגדיר סוג קריאה חוזרת (callback) שמקבל FetchAllResponse.
FetchCallback typedef
std::function< void(const FetchResponse &)>
מגדיר סוג קריאה חוזרת (callback) שמקבל FetchResponse.
ShowAllUICallback typedef
std::function< void(const UIStatus &)>
מגדיר סוג קריאה חוזרת (callback) שמקבל UIStatus.

תפקידים ציבוריים
Fetch(const std::string & achievement_id, FetchCallback callback)
void
טוען נתונים באופן אסינכרוני של הישג ספציפי עבור השחקן המחובר כרגע.
Fetch(DataSource data_source, const std::string & achievement_id, FetchCallback callback)
void
טוען נתונים באופן אסינכרוני של הישג ספציפי עבור השחקן המחובר כרגע.
FetchAll(FetchAllCallback callback)
void
טוען באופן אסינכרוני את כל נתוני ההישגים עבור הנגן המחובר כעת.
FetchAll(DataSource data_source, FetchAllCallback callback)
void
טוען באופן אסינכרוני את כל נתוני ההישגים עבור הנגן המחובר כעת.
FetchAllBlocking()
טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.
FetchAllBlocking(DataSource data_source)
טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.
FetchAllBlocking(Timeout timeout)
טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.
FetchAllBlocking(DataSource data_source, Timeout timeout)
טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.
FetchBlocking(const std::string & achievement_id)
טוען נתונים של הישג ספציפי באופן סינכרוני, שמזוהה על ידי מזהה המחרוזת, עבור הנגן המחובר כעת, ומחזיר את FetchResponse ישירות.
FetchBlocking(DataSource data_source, const std::string & achievement_id)
טוען נתונים של הישג ספציפי באופן סינכרוני, שמזוהה על ידי מזהה המחרוזת, עבור הנגן המחובר כעת, ומחזיר את FetchResponse ישירות.
FetchBlocking(Timeout timeout, const std::string & achievement_id)
טוען נתונים של הישג ספציפי באופן סינכרוני, שמזוהה על ידי מזהה המחרוזת, עבור הנגן המחובר כעת, ומחזיר את FetchResponse ישירות.
FetchBlocking(DataSource data_source, Timeout timeout, const std::string & achievement_id)
טוען נתונים של הישג ספציפי באופן סינכרוני, שמזוהה על ידי מזהה המחרוזת, עבור הנגן המחובר כעת, ומחזיר את FetchResponse ישירות.
Increment(const std::string & achievement_id)
void
מוסיפה הישג לפי מספר השלבים הנתון.
Increment(const std::string & achievement_id, uint32_t steps)
void
מוסיפה הישג לפי מספר השלבים הנתון.
Reveal(const std::string & achievement_id)
void
חשיפת הישג מוסתר לשחקן שמחובר כרגע.
SetStepsAtLeast(const std::string & achievement_id, uint32_t steps)
void
מגדירים הישג כך שישלים את מספר השלבים הנתון לפחות.
ShowAllUI(ShowAllUICallback callback)
void
הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.
ShowAllUI()
void
הוצא משימוש. יש להעדיף את ShowAllUI(ShowAllUICallback callback). הצגת ממשק משתמש למשתמש עם מידע על כל ההישגים. ממשק המשתמש מוצג באופן אסינכרוני בכל הפלטפורמות.
ShowAllUIBlocking()
הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.
ShowAllUIBlocking(Timeout timeout)
הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.
Unlock(const std::string & achievement_id)
void
משיג הישג עבור השחקן המחובר כרגע.

מבנים
gpg::AchievementManager::FetchAllResponse

מכיל את כל הנתונים של כל ההישגים, יחד עם סטטוס התגובה.

gpg::AchievementManager::FetchResponse

מכיל נתונים וסטטוס תגובה של הישג יחיד.

סוגים ציבוריים

FetchAllCallback

std::function< void(const FetchAllResponse &)> FetchAllCallback

מגדיר סוג קריאה חוזרת (callback) שמקבל FetchAllResponse.

סוג הקריאה החוזרת (callback) הזה מסופק לפונקציות FetchAll(*) שמפורטות בהמשך.

FetchCallback

std::function< void(const FetchResponse &)> FetchCallback

מגדיר סוג קריאה חוזרת (callback) שמקבל FetchResponse.

סוג הקריאה החוזרת (callback) הזה מסופק לפונקציות Fetch(*) שמפורטות בהמשך.

ShowAllUICallback

std::function< void(const UIStatus &)> ShowAllUICallback

מגדיר סוג קריאה חוזרת (callback) שמקבל UIStatus.

סוג הקריאה החוזרת (callback) הזה מסופק לפונקציה ShowAllUI* שלמטה.

תפקידים ציבוריים

שליפה

void Fetch(
  const std::string & achievement_id,
  FetchCallback callback
)

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

קריאה ל-FetchCallback שסופק בסיום הפעולה. אם לא מציינים data_source, הפונקציה הזו מקבילה לקריאה ל-Fetch(DataSource data_source, const std::string& id, FetchCallback), כאשר data_source מצוינת כ-CACHE_OR_NETWORK.

שליפה

void Fetch(
  DataSource data_source,
  const std::string & achievement_id,
  FetchCallback callback
)

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

קריאה ל-FetchCallback שסופק בסיום הפעולה. יש לציין את המאפיין data_source כ-CACHE_OR_NETWORK או כ-NETWORK_ONLY.

FetchAll

void FetchAll(
  FetchAllCallback callback
)

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

קריאה ל-FetchAllCallback שסופק בסיום הפעולה. אם לא מציינים את data_source, הפונקציה הזו מקבילה לקריאה לפונקציה FetchAll(DataSource data_source, FetchAllCallback), כאשר data_source מצוין בתור CACHE_OR_NETWORK.

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

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

קריאה ל-FetchAllCallback שסופק בסיום הפעולה. יש לציין data_source בתור CACHE_OR_NETWORK או NETWORK_ONLY.

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.

אם לא מציינים data_source וגם לא timeout, הפעלת הפונקציה הזו היא שוות-ערך לקריאה לפונקציה FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout), כאשר data_source מצוין כ-CACHE_OR_NETWORK ו-timeout מוגדר כ-10 שנים.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.

יש לציין data_source בתור CACHE_OR_NETWORK או NETWORK_ONLY. אם לא מציינים timeout, הפונקציה הזו מקבילה לקריאה לפונקציה FetchAllBlocking FetchAllResponse(DataSource data_source, Timeout timeout), עם הערך שצוין ב-data_source ול-timeout יש לציין 10 שנים.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.

צריך לציין את timeout כמספר שרירותי של אלפיות השנייה. אם לא מציינים data_source, הפעלת הפונקציה הזו היא שוות-ערך לקריאה ל-FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout), כאשר data_source מצוין כ-CACHE_OR_NETWORK ו-timeout מכיל את הערך שצוין.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

טוען באופן סינכרוני את כל נתוני ההישגים של השחקן המחובר כעת, ומחזיר את ה-FetchAllResponse ישירות.

יש לציין data_source בתור CACHE_OR_NETWORK או NETWORK_ONLY. הגדרת זמן קצוב לתפוגה כמספר שרירותי של אלפיות השנייה.

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & achievement_id
)

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

אם משאירים את המדיניות data_source ו-timeout לא צוינו, הפעלת הפונקציה הזו היא שוות-ערך לקריאה לפונקציה FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id), כאשר data_source מצוין כ-CACHE_OR_NETWORK ו-timeout מצוין כ-10 שנים.

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  const std::string & achievement_id
)

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

יש לציין data_source בתור CACHE_OR_NETWORK או NETWORK_ONLY. אם משאירים את הפונקציה timeout לא מוגדרת, הפעלת הפונקציה הזו היא שוות-ערך לקריאה לפונקציה FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id) עם הערך שצוין ל-data_source ול-timeout יש לציין 10 שנים.

FetchBlocking

FetchResponse FetchBlocking(
  Timeout timeout,
  const std::string & achievement_id
)

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

צריך לציין את timeout כמספר שרירותי של אלפיות השנייה. אם משאירים את הפונקציה data_source לא מוגדרת, הפעלת הפונקציה הזו היא שוות-ערך לקריאה לפונקציה FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id), כאשר data_source מצוין כ-CACHE_OR_NETWORK ו-timeout מכיל את הערך שצוין.

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & achievement_id
)

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

יש לציין data_source בתור CACHE_OR_NETWORK או NETWORK_ONLY. צריך לציין את timeout כמספר שרירותי של אלפיות השנייה.

הגדלה

void Increment(
  const std::string & achievement_id
)

מוסיפה הישג לפי מספר השלבים הנתון.

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

הגדלה

void Increment(
  const std::string & achievement_id,
  uint32_t steps
)

מוסיפה הישג לפי מספר השלבים הנתון.

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

חשיפה

void Reveal(
  const std::string & achievement_id
)

חשיפת הישג מוסתר לשחקן שמחובר כרגע.

אם ההישג כבר שוחרר, לא תהיה לכך השפעה.

SetStepsAtLeast

void SetStepsAtLeast(
  const std::string & achievement_id,
  uint32_t steps
)

מגדירים הישג כך שישלים את מספר השלבים הנתון לפחות.

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

ShowAllUI

void ShowAllUI(
  ShowAllUICallback callback
)

הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.

הוא מבצע קריאה אסינכרונית ל-ShowAllUICallback.

ShowAllUI

void ShowAllUI()

הוצא משימוש. יש להעדיף את ShowAllUI(ShowAllUICallback callback). הצגת ממשק משתמש למשתמש עם מידע על כל ההישגים. ממשק המשתמש מוצג באופן אסינכרוני בכל הפלטפורמות.

ShowAllUIBlocking

UIStatus ShowAllUIBlocking()

הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.

הוא מחזיר UIStatus באופן סינכרוני. אם לא מציינים את timeout, הפונקציה הזו מקבילה לקריאה לפונקציה ShowAllUIBlocking(Timeout timeout) כאשר timeout מצוין כ-10 שנים.

ShowAllUIBlocking

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

הצגת ממשק משתמש עם מידע על כל ההישגים למשתמש.

הוא מחזיר UIStatus באופן סינכרוני. צריך לציין את timeout כמספר שרירותי של אלפיות השנייה.

ביטול הנעילה

void Unlock(
  const std::string & achievement_id
)

משיג הישג עבור השחקן המחובר כרגע.

אם ההישג מוסתר, ה-SDK חושף גם אותו.