gpg::Achievement

#include <achievement.h>

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

摘要

数据包含两种类型：用户特定数据（例如，用户是否解锁了成就等）和全局数据（例如，成就名称）。

构造函数和析构函数
成就()
Achievement(std::shared_ptr< const AchievementImpl > impl)
从指向 AchievementImpl 的 shared_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(
  std::shared_ptr< const AchievementImpl > impl
)

从指向 AchievementImpl 的 shared_ptr 构造一个 Achievement。旨在供 API 内部使用。

成就

 Achievement(
  const Achievement & copy_from
)

创建现有 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。

对于此成就的 getter 函数（id、Name、Description 等）可用，它必须为 true。

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()