gpg::AchievementManager

#include <achievement_manager.h>

Récupère et définit diverses données liées aux réussites.

Résumé

Types publics
FetchAllCallback typedef
std::function< void(const FetchAllResponse &)>
Définit un type de rappel qui reçoit un FetchAllResponse.
FetchCallback typedef
std::function< void(const FetchResponse &)>
Définit un type de rappel qui reçoit un FetchResponse.
ShowAllUICallback typedef
std::function< void(const UIStatus &)>
Définit un type de rappel qui reçoit un UIStatus.

Fonctions publiques
Fetch(const std::string & achievement_id, FetchCallback callback)
void
Charge de manière asynchrone les données d'une réussite spécifique pour le joueur actuellement connecté.
Fetch(DataSource data_source, const std::string & achievement_id, FetchCallback callback)
void
Charge de manière asynchrone les données d'une réussite spécifique pour le joueur actuellement connecté.
FetchAll(FetchAllCallback callback)
void
Charge de manière asynchrone toutes les données de réussite pour le joueur actuellement connecté.
FetchAll(DataSource data_source, FetchAllCallback callback)
void
Charge de manière asynchrone toutes les données de réussite pour le joueur actuellement connecté.
FetchAllBlocking()
Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.
FetchAllBlocking(DataSource data_source)
Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.
FetchAllBlocking(Timeout timeout)
Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.
FetchAllBlocking(DataSource data_source, Timeout timeout)
Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.
FetchBlocking(const std::string & achievement_id)
Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.
FetchBlocking(DataSource data_source, const std::string & achievement_id)
Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.
FetchBlocking(Timeout timeout, const std::string & achievement_id)
Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.
FetchBlocking(DataSource data_source, Timeout timeout, const std::string & achievement_id)
Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.
Increment(const std::string & achievement_id)
void
Incrémente un succès du nombre d'étapes donné.
Increment(const std::string & achievement_id, uint32_t steps)
void
Incrémente un succès du nombre d'étapes donné.
Reveal(const std::string & achievement_id)
void
révéler une réussite masquée au joueur actuellement connecté ;
SetStepsAtLeast(const std::string & achievement_id, uint32_t steps)
void
Définissez un succès pour qu'il comprenne au moins le nombre d'étapes donné.
ShowAllUI(ShowAllUICallback callback)
void
Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.
ShowAllUI()
void
Obsolète. Privilégiez ShowAllUI(ShowAllUICallbackCallback). Présente à l'utilisateur une interface utilisateur qui affiche des informations sur toutes les réussites. L'UI s'affiche de manière asynchrone sur toutes les plates-formes.
ShowAllUIBlocking()
Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.
ShowAllUIBlocking(Timeout timeout)
Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.
Unlock(const std::string & achievement_id)
void
Débloque une réussite pour le joueur actuellement connecté.

Structs
gpg::AchievementManager::FetchAllResponse

Contient toutes les données de l'ensemble des réussites, ainsi que l'état de la réponse.

gpg::AchievementManager::FetchResponse

Contient les données et l'état des réponses pour un seul succès.

Types publics

FetchAllCallback

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

Définit un type de rappel qui reçoit un FetchAllResponse.

Ce type de rappel est fourni aux fonctions FetchAll(*) ci-dessous.

FetchCallback

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

Définit un type de rappel qui reçoit un FetchResponse.

Ce type de rappel est fourni aux fonctions Fetch(*) ci-dessous.

ShowAllUICallback

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

Définit un type de rappel qui reçoit un UIStatus.

Ce type de rappel est fourni à la fonction ShowAllUI* ci-dessous.

Fonctions publiques

Récupération

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

Charge de manière asynchrone les données d'une réussite spécifique pour le joueur actuellement connecté.

Appelle le FetchCallback fourni à la fin de l'opération. Si vous ne spécifiez pas data_source, cet appel de fonction équivaut à appeler Fetch(DataSource data_source, const std::string& id, FetchCallback), avec data_source spécifié comme CACHE_OR_NETWORK.

Récupération

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

Charge de manière asynchrone les données d'une réussite spécifique pour le joueur actuellement connecté.

Appelle le FetchCallback fourni à la fin de l'opération. Spécifiez CACHE_OR_NETWORK ou NETWORK_ONLY pour le champ "data_source".

FetchAll

void FetchAll(
  FetchAllCallback callback
)

Charge de manière asynchrone toutes les données de réussite pour le joueur actuellement connecté.

Appelle le FetchAllCallback fourni à la fin de l'opération. Si vous ne spécifiez pas data_source, cet appel de fonction équivaut à l'appel de FetchAll(DataSource data_source, FetchAllCallback), avec data_source défini sur CACHE_OR_NETWORK.

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

Charge de manière asynchrone toutes les données de réussite pour le joueur actuellement connecté.

Appelle le FetchAllCallback fourni à la fin de l'opération. Spécifiez data_source en tant que CACHE_OR_NETWORK ou NETWORK_ONLY.

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.

Si vous ne spécifiez ni data_source, ni timeout, cet appel de fonction équivaut à appeler FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout), avec data_source défini sur CACHE_OR_NETWORK et timeout défini sur 10 ans.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.

Spécifiez data_source en tant que CACHE_OR_NETWORK ou NETWORK_ONLY. Si vous ne spécifiez pas timeout, cet appel de fonction équivaut à appeler FetchAllBlocking FetchAllResponse(DataSource data_source, Timeout timeout), avec la valeur data_source spécifiée et la valeur timeout définie sur 10 ans.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.

Spécifiez timeout en tant que nombre arbitraire de millisecondes. Si vous ne spécifiez pas data_source, cet appel de fonction équivaut à appeler FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout), avec data_source défini sur CACHE_OR_NETWORK et timeout contenant la valeur spécifiée.

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

Charge de manière synchrone toutes les données de réussite pour le joueur actuellement connecté, en renvoyant directement le FetchAllResponse.

Spécifiez data_source en tant que CACHE_OR_NETWORK ou NETWORK_ONLY. Spécifiez le délai avant expiration sous la forme d'un nombre arbitraire de millisecondes.

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & achievement_id
)

Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.

Si data_source et timeout ne sont pas spécifiés, cet appel de fonction équivaut à appeler FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id), avec data_source défini sur CACHE_OR_NETWORK et timeout défini sur 10 ans.

FetchBlocking

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

Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.

Spécifiez data_source en tant que CACHE_OR_NETWORK ou NETWORK_ONLY. Si timeout n'est pas spécifié, cet appel de fonction équivaut à appeler FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id), avec la valeur data_source spécifiée et la valeur timeout définie sur 10 ans.

FetchBlocking

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

Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.

Spécifiez timeout en tant que nombre arbitraire de millisecondes. Si data_source n'est pas spécifié, cet appel de fonction équivaut à appeler FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id), avec data_source défini sur CACHE_OR_NETWORK et timeout contenant la valeur spécifiée.

FetchBlocking

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

Charge de manière synchrone les données d'un succès spécifique, identifié par un ID de chaîne, pour le joueur actuellement connecté ; renvoie directement FetchResponse.

Spécifiez data_source en tant que CACHE_OR_NETWORK ou NETWORK_ONLY. Spécifiez timeout en tant que nombre arbitraire de millisecondes.

Incrément

void Increment(
  const std::string & achievement_id
)

Incrémente un succès du nombre d'étapes donné.

Si l'incrément n'est pas défini, sa valeur par défaut est 1. La réussite doit être une réussite progressive. Lorsqu'une réussite atteint le nombre maximal d'étapes, elle est automatiquement déverrouillée. Tout incrément supplémentaire est ignoré.

Incrément

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

Incrémente un succès du nombre d'étapes donné.

La réussite doit être une réussite progressive. Lorsqu'une réussite atteint au moins le nombre maximal d'étapes, elle est automatiquement déverrouillée. Tout incrément supplémentaire est ignoré.

Voir la réponse

void Reveal(
  const std::string & achievement_id
)

révéler une réussite masquée au joueur actuellement connecté ;

Si la réussite a déjà été déverrouillée, cela n'aura aucun effet.

SetStepsAtLeast

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

Définissez un succès pour qu'il comprenne au moins le nombre d'étapes donné.

L'appel de cette méthode alors que le succès comporte déjà plus d'étapes que la valeur fournie est une opération no-op. Une fois que le succès a atteint le nombre maximum d'étapes, le succès est automatiquement déverrouillé et toute autre opération de mutation est ignorée.

ShowAllUI

void ShowAllUI(
  ShowAllUICallback callback
)

Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.

Il appelle ShowAllUICallback de manière asynchrone.

ShowAllUI

void ShowAllUI()

Obsolète. Privilégiez ShowAllUI(ShowAllUICallbackCallback). Présente à l'utilisateur une interface utilisateur qui affiche des informations sur toutes les réussites. L'UI s'affiche de manière asynchrone sur toutes les plates-formes.

ShowAllUIBlocking

UIStatus ShowAllUIBlocking()

Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.

Elle renvoie UIStatus de manière synchrone. Si vous ne spécifiez pas timeout, cet appel de fonction équivaut à appeler ShowAllUIBlocking(Timeout timeout) avec timeout défini sur 10 ans.

ShowAllUIBlocking

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

Présente à l'utilisateur une interface qui affiche des informations sur toutes les réussites.

Elle renvoie UIStatus de manière synchrone. Spécifiez timeout en tant que nombre arbitraire de millisecondes.

Déverrouiller

void Unlock(
  const std::string & achievement_id
)

Débloque une réussite pour le joueur actuellement connecté.

Si la réussite est masquée, le SDK l'affiche également.