gpg::Achievement

#include <achievement.h>

一个单一数据结构,允许您访问特定成就的状态数据。

摘要

数据包括两种类型:用户特定数据(例如,用户是否解锁了成就等)和全局数据(例如,成就名称)。

构造函数和析构函数

Achievement()
Achievement(std::shared_ptr< const AchievementImpl > impl)
从指向 AchievementImplshared_ptr 构造一个 Achievement。供 API 内部使用。
Achievement(const Achievement & copy_from)
创建现有 Achievement 的副本。
Achievement(Achievement && move_from)
移动现有 Achievement
~Achievement()

公共函数

CurrentSteps() const
uint32_t
返回玩家在解锁增量成就方面已采取的步骤数。
Description() const
const std::string &
返回成就的简明描述。
Id() const
const std::string &
返回 Google Play 管理中心事先生成的唯一字符串。
LastModified() const 已弃用。 优先使用 LastModifiedTime。
LastModifiedTime() const
返回条目上次修改的时间(表示为自 Unix 纪元以来的毫秒数)。
Name() const
const std::string &
返回成就的简称。
RevealedIconUrl() const
const std::string &
返回指向此 Achievement 已揭示图标图像的 URL。
State() const
返回成就状态:HIDDEN(隐藏)、REVEALED(已揭示)或 UNLOCKED(已解锁)。
TotalSteps() const
uint32_t
返回玩家解锁给定增量成就总共所需的步数。
Type() const
返回成就类型:INCREMENTAL(增量)或 STANDARD(标准)。
UnlockedIconUrl() const
const std::string &
返回指向此 Achievement 已解锁图标图像的 URL。
Valid() const
bool
当返回的成就填充了数据并伴随成功的响应状态时返回 true;对于未填充的用户创建的成就或填充但伴随不成功的响应状态的成就则返回 false。
XP() const
uint64_t
此成就授予的经验值数量。
operator=(const Achievement & copy_from)
通过从另一个 Achievement 复制来赋值此 Achievement
operator=(Achievement && move_from)
通过将另一个 Achievement 移入此 Achievement 来赋值。

公共函数

Achievement

 Achievement()

Achievement

 Achievement(
  std::shared_ptr< const AchievementImpl > impl
)

从指向 AchievementImplshared_ptr 构造一个 Achievement。供 API 内部使用。

Achievement

 Achievement(
  const Achievement & copy_from
)

创建现有 Achievement 的副本。

Achievement

 Achievement(
  Achievement && move_from
)

移动现有 Achievement

CurrentSteps

uint32_t CurrentSteps() const 

返回玩家在解锁增量成就方面已采取的步骤数。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。

Description

const std::string & Description() const 

返回成就的简明描述。

通常说明玩家如何获得成就。最多 500 个字符。仅当 Achievement::Valid() 返回 true 时才能调用此函数。

Id

const std::string & Id() const 

返回 Google Play 管理中心事先生成的唯一字符串。

在您的游戏客户端中使用此函数来指代成就。仅当 Achievement::Valid() 返回 true 时才能调用此函数。

LastModified

Timestamp LastModified() const 

已弃用。 优先使用 LastModifiedTime。

LastModifiedTime

Timestamp LastModifiedTime() const 

返回条目上次修改的时间(表示为自 Unix 纪元以来的毫秒数)。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。

Name

const std::string & Name() const 

返回成就的简称。

最多 100 个字符。仅当 Achievement::Valid() 返回 true 时才能调用此函数。

RevealedIconUrl

const std::string & RevealedIconUrl() const 

返回指向此 Achievement 已揭示图标图像的 URL。

此图标旨在当 Achievement 已揭示但尚未解锁时显示。仅当 Achievement::Valid() 返回 true 时才能调用此函数。

State

AchievementState State() const 

返回成就状态:HIDDEN(隐藏)、REVEALED(已揭示)或 UNLOCKED(已解锁)。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。在此处可以找到更多信息:这里

TotalSteps

uint32_t TotalSteps() const 

返回玩家解锁给定增量成就总共所需的步数。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。

Type

AchievementType Type() const 

返回成就类型:INCREMENTAL(增量)或 STANDARD(标准)。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。在此处可以找到更多信息:这里

UnlockedIconUrl

const std::string & UnlockedIconUrl() const 

返回指向此 Achievement 已解锁图标图像的 URL。

此图标旨在当 Achievement 已解锁(因此也已揭示)时显示。仅当 Achievement::Valid() 返回 true 时才能调用此函数。

Valid

bool Valid() const 

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

此函数必须返回 true,才能使用此成就的 getter 函数(id、Name、Description 等)。

XP

uint64_t XP() const 

此成就授予的经验值数量。

仅当 Achievement::Valid() 返回 true 时才能调用此函数。

operator=

Achievement & operator=(
  const Achievement & copy_from
)

通过从另一个 Achievement 复制来赋值此 Achievement

operator=

Achievement & operator=(
  Achievement && move_from
)

通过将另一个 Achievement 移入此 Achievement 来赋值。

~Achievement

 ~Achievement()