gpg::Player

#include <player.h>

一个数据结构，允许您访问特定玩家的数据。

摘要

构造函数和析构函数
Player()
Player(std::shared_ptr< const PlayerImpl > impl)
根据指向 PlayerImpl 的 shared_ptr 构造 Player。
Player(const Player & copy_from)
创建现有 Player 的副本。
Player(Player && move_from)
将现有 Player 移动到新的 Player 中。
~Player()

公共函数
AvatarUrl(ImageResolution resolution) const
const std::string &
返回此 Player 头像图片的 URL。
CurrentLevel() const
const PlayerLevel &
检索此玩家的当前等级数据（如果已知）。
CurrentXP() const
uint64_t
检索玩家当前的 XP 总计。
HasLevelInfo() const
bool
返回此玩家是否有等级信息可用。
Id() const
const std::string &
返回当前登录玩家的 Id。
LastLevelUpTime() const
检索此玩家上次升级的时间戳。
Name() const
const std::string &
返回当前登录玩家的 Google+ 名称。
NextLevel() const
const PlayerLevel &
检索此玩家的下一个等级数据（如果已知）。
Title() const
const std::string &
检索玩家的称号。
Valid() const
bool
当返回的 player 填充了数据并伴随成功的响应状态时返回 true；对于未填充的用户创建的 player 或填充了数据但伴随不成功的响应状态的 player 则返回 false。
operator=(const Player & copy_from)
Player &
通过复制另一个 Player 来赋值给此 Player。
operator=(Player && move_from)
Player &
通过移动另一个 Player 到此 Player 中来赋值。

公共函数

AvatarUrl

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

返回此 Player 头像图片的 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，或者如果玩家从未升级过，则此函数将返回零（纪元）。

Name

const std::string & Name() const

返回当前登录玩家的 Google+ 名称。

此函数可用之前，Player::Valid() 必须返回 true。

NextLevel

const PlayerLevel & NextLevel() const

检索此玩家的下一个等级数据（如果已知）。

如果 HasLevelInfo() 返回 false，则此函数将返回一个 PlayerLevel 对象，该对象的 Valid() 也返回 false。这是玩家当前正在努力达到的等级。如果玩家已经达到他们能达到的最高等级，CurrentLevel() 和 NextLevel() 将返回相同的值。

Player

 Player()

Player

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

根据指向 PlayerImpl 的 shared_ptr 构造 Player。

供 API 内部使用。

Player

 Player(
  const Player & copy_from
)

创建现有 Player 的副本。

Player

 Player(
  Player && move_from
)

将现有 Player 移动到新的 Player 中。

Title

const std::string & Title() const

检索玩家的称号。

这基于玩家在 Google Play 游戏生态系统中采取的操作。请注意，并非所有玩家都有称号，并且玩家的称号可能会随时间而变化。如果玩家没有称号，Title() 将返回空字符串。

Valid

bool Valid() const

当返回的 player 填充了数据并伴随成功的响应状态时返回 true；对于未填充的用户创建的 player 或填充了数据但伴随不成功的响应状态的 player 则返回 false。

此对象上的 getter 函数可用之前，它必须返回 true。

operator=

Player & operator=(
  const Player & copy_from
)

通过复制另一个 Player 来赋值给此 Player。

operator=

Player & operator=(
  Player && move_from
)

通过移动另一个 Player 到此 Player 中来赋值。

~Player

 ~Player()