gpg::Joueur

#include <player.h>

Structure de données qui vous permet d'accéder aux données d'un joueur spécifique.

Résumé

Constructeurs et destructeurs

Player()
Player(std::shared_ptr< const PlayerImpl > impl)
Construit un Player à partir d'un shared_ptr vers un PlayerImpl.
Player(const Player & copy_from)
Crée une copie d'un Player existant.
Player(Player && move_from)
Déplace un Player existant vers un nouveau.
~Player()

Fonctions publiques

AvatarUrl(ImageResolution resolution) const
const std::string &
Renvoie l'URL où se trouve l'image de l'avatar de ce Player.
CurrentLevel() const
const PlayerLevel &
Récupère les données relatives au niveau actuel du joueur, si elles sont connues.
CurrentXP() const
uint64_t
Récupère le nombre total de points XP actuels du joueur.
HasLevelInfo() const
bool
Indique si des informations sur le niveau sont disponibles pour ce joueur.
Id() const
const std::string &
Renvoie la valeur Id du joueur actuellement connecté.
LastLevelUpTime() const
Récupère le code temporel correspondant au dernier niveau auquel le joueur est passé au niveau supérieur.
Name() const
const std::string &
Renvoie le nom Google+ du joueur actuellement connecté.
NextLevel() const
const PlayerLevel &
Récupère les données de niveau supérieur du joueur, si elles sont connues.
Title() const
const std::string &
Récupère le titre du joueur.
Valid() const
bool
Renvoie la valeur "true" lorsque le joueur renvoyé est renseigné avec des données et est accompagné d'une réponse positive ; "false" pour un joueur non renseigné créé par un utilisateur ou pour un joueur rempli accompagné d'un état de réponse "Échec".
operator=(const Player & copy_from)
Player &
Attribue ce Player en copiant un autre élément.
operator=(Player && move_from)
Player &
Attribue cette valeur Player en déplaçant une autre à l'intérieur.

Fonctions publiques

AvatarUrl

const std::string & AvatarUrl(
  ImageResolution resolution
) const 

Renvoie l'URL où se trouve l'image de l'avatar de ce Player.

Le paramètre ImageResolution spécifie la résolution de l'image. Player::Valid() doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

CurrentLevel

const PlayerLevel & CurrentLevel() const 

Récupère les données relatives au niveau actuel du joueur, si elles sont connues.

Si HasLevelInfo() renvoie la valeur "false", un objet PlayerLevel est renvoyé, pour lequel Valid() renvoie également la valeur "false".

CurrentXP

uint64_t CurrentXP() const 

Récupère le nombre total de points XP actuels du joueur.

Si HasLevelInfo() renvoie la valeur "false", la valeur "0" est renvoyée. Si HasLevelInfo() renvoie la valeur "true", le total des XP actuels du joueur sera compris entre CurrentLevel().MinimumXP et CurrentLevel().MaximumXP.

HasLevelInfo

bool HasLevelInfo() const 

Indique si des informations sur le niveau sont disponibles pour ce joueur.

Si la valeur "false" est renvoyée, CurrentLevel() et NextLevel() renvoient des objets PlayerLevel non valides.

ID

const std::string & Id() const 

Renvoie la valeur Id du joueur actuellement connecté.

Player::Valid() doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

LastLevelUpTime

Timestamp LastLevelUpTime() const 

Récupère le code temporel correspondant au dernier niveau auquel le joueur est passé au niveau supérieur.

Si HasLevelInfo() renvoie la valeur "false" ou si le joueur n'est jamais passé au niveau supérieur, la valeur renvoie zéro (epoch).

Nom

const std::string & Name() const 

Renvoie le nom Google+ du joueur actuellement connecté.

Player::Valid() doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

NextLevel

const PlayerLevel & NextLevel() const 

Récupère les données de niveau supérieur du joueur, si elles sont connues.

Si HasLevelInfo() renvoie la valeur "false", un objet PlayerLevel est renvoyé, pour lequel Valid() renvoie également la valeur "false". Il s'agit du niveau vers lequel le joueur travaille actuellement. Si le joueur a déjà atteint le niveau maximal qu'il peut atteindre, CurrentLevel() et NextLevel() renvoient des valeurs identiques.

Joueur

 Player()

Joueur

 Player(
  std::shared_ptr< const PlayerImpl > impl
)

Construit un Player à partir d'un shared_ptr vers un PlayerImpl.

Destiné à un usage interne par l'API.

Joueur

 Player(
  const Player & copy_from
)

Crée une copie d'un Player existant.

Joueur

 Player(
  Player && move_from
)

Déplace un Player existant vers un nouveau.

Titre

const std::string & Title() const 

Récupère le titre du joueur.

Elle est basée sur les actions effectuées par le joueur dans l'écosystème Google Play Jeux. Notez que tous les joueurs n'ont pas de titre, et que celui-ci peut changer au fil du temps. Si le joueur n'a pas de titre, la fonction Title() renvoie une chaîne vide.

Valide

bool Valid() const 

Renvoie la valeur "true" lorsque le joueur renvoyé est renseigné avec des données et est accompagné d'une réponse positive ; "false" pour un joueur non renseigné créé par un utilisateur ou pour un joueur rempli accompagné d'un état de réponse "Échec".

La valeur "true" doit être renvoyée pour que les fonctions getter de cet objet soient utilisables.

opérateur=

Player & operator=(
  const Player & copy_from
)

Attribue ce Player en copiant un autre élément.

opérateur=

Player & operator=(
  Player && move_from
)

Attribue cette valeur Player en déplaçant une autre à l'intérieur.

~Lecteur

 ~Player()