gpg::Player
#include <player.h>
允许您访问有关特定玩家数据的 数据结构。
摘要
构造函数和析构函数 |
|
---|---|
Player()
|
|
Player(std::shared_ptr< const PlayerImpl > impl)
|
|
Player(const Player & copy_from)
创建现有Player的副本。
|
|
Player(Player && move_from)
将现有Player移动到新的对象中。
|
|
~Player()
|
公有函数 |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
返回包含此Player头像图像的URL。
|
CurrentLevel() const
|
const PlayerLevel &
检索此玩家的当前等级数据(如果已知)。
|
CurrentXP() const
|
uint64_t
检索玩家当前的总经验值。
|
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
当返回的玩家填充了数据并伴随成功的响应状态时返回true;对于未填充的用户创建的玩家或伴随不成功响应状态的已填充玩家返回false。
|
operator=(const Player & copy_from)
|
Player &
通过从另一个玩家复制来赋值此Player。
|
operator=(Player && move_from)
|
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
检索玩家当前的总经验值。
如果`HasLevelInfo()`返回false,则返回零。如果`HasLevelInfo()`返回true,则玩家当前的总经验值将在`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内部使用。
Title
const std::string & Title() const
检索玩家的称号。
这基于玩家在Google Play游戏生态系统中采取的操作。请注意,并非所有玩家都有称号,并且玩家的称号可能会随着时间的推移而改变。如果玩家没有称号,`Title()`将返回空字符串。
Valid
bool Valid() const
当返回的玩家填充了数据并伴随成功的响应状态时返回true;对于未填充的用户创建的玩家或伴随不成功响应状态的已填充玩家返回false。
此对象的getter函数必须返回true才能使用。
~Player
~Player()