gpg::AchievementManager

#include <achievement_manager.h>

获取和设置各种成就相关数据。

摘要

公共类型
FetchAllCallback typedef
std::function< void(const FetchAllResponse &)>
定义接收 FetchAllResponse 的回调类型。
FetchCallback typedef
std::function< void(const FetchResponse &)>
定义接收 FetchResponse 的回调类型。
ShowAllUICallback typedef
std::function< void(const UIStatus &)>
定义接收 UIStatus 的回调类型。

公共函数
Fetch(const std::string & achievement_id, FetchCallback callback)
void
异步加载当前已登录玩家特定成就的数据。
Fetch(DataSource data_source, const std::string & achievement_id, FetchCallback callback)
void
异步加载当前已登录玩家特定成就的数据。
FetchAll(FetchAllCallback callback)
void
异步加载当前已登录玩家的所有成就数据。
FetchAll(DataSource data_source, FetchAllCallback callback)
void
异步加载当前已登录玩家的所有成就数据。
FetchAllBlocking()
同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。
FetchAllBlocking(DataSource data_source)
同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。
FetchAllBlocking(Timeout timeout)
同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。
FetchAllBlocking(DataSource data_source, Timeout timeout)
同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。
FetchBlocking(const std::string & achievement_id)
同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。
FetchBlocking(DataSource data_source, const std::string & achievement_id)
同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。
FetchBlocking(Timeout timeout, const std::string & achievement_id)
同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。
FetchBlocking(DataSource data_source, Timeout timeout, const std::string & achievement_id)
同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。
Increment(const std::string & achievement_id)
void
将成就增加给定步数。
Increment(const std::string & achievement_id, uint32_t steps)
void
将成就增加给定步数。
Reveal(const std::string & achievement_id)
void
向当前已登录玩家揭示隐藏成就。
SetStepsAtLeast(const std::string & achievement_id, uint32_t steps)
void
将成就的已完成步数设置为至少达到给定步数。
ShowAllUI(ShowAllUICallback callback)
void
向用户呈现一个显示所有成就信息的 UI。
ShowAllUI()
void
已弃用。 优先使用 ShowAllUI(ShowAllUICallback callback)。它向用户呈现一个 UI，其中显示所有成就的信息。该 UI 在所有平台上异步显示。
ShowAllUIBlocking()
向用户呈现一个显示所有成就信息的 UI。
ShowAllUIBlocking(Timeout timeout)
向用户呈现一个显示所有成就信息的 UI。
Unlock(const std::string & achievement_id)
void
为当前已登录玩家解锁成就。

结构体
gpg::AchievementManager::FetchAllResponse

保存所有成就的所有数据以及响应状态。
gpg::AchievementManager::FetchResponse

包含单个成就的数据和响应状态。

公共类型

FetchAllCallback

std::function< void(const FetchAllResponse &)> FetchAllCallback

定义接收 FetchAllResponse 的回调类型。

此回调类型提供给下面的 FetchAll(*) 函数。

FetchCallback

std::function< void(const FetchResponse &)> FetchCallback

定义接收 FetchResponse 的回调类型。

此回调类型提供给下面的 Fetch(*) 函数。

ShowAllUICallback

std::function< void(const UIStatus &)> ShowAllUICallback

定义接收 UIStatus 的回调类型。

此回调类型提供给下面的 ShowAllUI* 函数。

公共函数

Fetch

void Fetch(
  const std::string & achievement_id,
  FetchCallback callback
)

异步加载当前已登录玩家特定成就的数据。

在操作完成后调用提供的 FetchCallback。未指定 data_source 会使此函数调用等效于调用 Fetch(DataSource data_source, const std::string& id, FetchCallback)，其中 data_source 指定为 CACHE_OR_NETWORK。

Fetch

void Fetch(
  DataSource data_source,
  const std::string & achievement_id,
  FetchCallback callback
)

异步加载当前已登录玩家特定成就的数据。

在操作完成后调用提供的 FetchCallback。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。

FetchAll

void FetchAll(
  FetchAllCallback callback
)

异步加载当前已登录玩家的所有成就数据。

在操作完成后调用提供的 FetchAllCallback。未指定 data_source 会使此函数调用等效于调用 FetchAll(DataSource data_source, FetchAllCallback)，其中 data_source 指定为 CACHE_OR_NETWORK。

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

异步加载当前已登录玩家的所有成就数据。

在操作完成后调用提供的 FetchAllCallback。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。

未指定 data_source 或 timeout 会使此函数调用等效于调用 FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout)，其中 data_source 指定为 CACHE_OR_NETWORK，timeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。未指定 timeout 会使此函数调用等效于调用 FetchAllBlocking FetchAllResponse(DataSource data_source, Timeout timeout)，使用您指定的 data_source 值，并且 timeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。

将 timeout 指定为任意毫秒数。未指定 data_source 会使此函数调用等效于调用 FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout)，其中 data_source 指定为 CACHE_OR_NETWORK，且 timeout 包含您指定的值。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

同步加载当前已登录玩家的所有成就数据，直接返回 FetchAllResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 timeout 指定为任意毫秒数。

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & achievement_id
)

同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。

未指定 data_source 和 timeout 会使此函数调用等效于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id)，其中 data_source 指定为 CACHE_OR_NETWORK，timeout 指定为 10 年。

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  const std::string & achievement_id
)

同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。未指定 timeout 会使此函数调用等效于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id)，使用您指定的 data_source 值，并且 timeout 指定为 10 年。

FetchBlocking

FetchResponse FetchBlocking(
  Timeout timeout,
  const std::string & achievement_id
)

同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。

将 timeout 指定为任意毫秒数。未指定 data_source 会使此函数调用等效于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id)，其中 data_source 指定为 CACHE_OR_NETWORK，且 timeout 包含您指定的值。

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & achievement_id
)

同步加载当前已登录玩家特定成就（由字符串 ID 标识）的数据；直接返回 FetchResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 timeout 指定为任意毫秒数。

Increment

void Increment(
  const std::string & achievement_id
)

将成就增加给定步数。

未定义增量时，其值默认为 1。成就必须是增量成就。一旦成就达到最大步数，就会自动解锁。任何进一步的增量都会被忽略。

Increment

void Increment(
  const std::string & achievement_id,
  uint32_t steps
)

将成就增加给定步数。

成就必须是增量成就。一旦成就达到至少最大步数，就会自动解锁。任何进一步的增量都会被忽略。

Reveal

void Reveal(
  const std::string & achievement_id
)

向当前已登录玩家揭示隐藏成就。

如果成就已被解锁，此操作将无效。

SetStepsAtLeast

void SetStepsAtLeast(
  const std::string & achievement_id,
  uint32_t steps
)

将成就的已完成步数设置为至少达到给定步数。

在成就步数已多于提供的数值时调用此方法无效。一旦成就达到最大步数，就会自动解锁，任何进一步的修改操作都会被忽略。

ShowAllUI

void ShowAllUI(
  ShowAllUICallback callback
)

向用户呈现一个显示所有成就信息的 UI。

它会异步调用 ShowAllUICallback。

ShowAllUI

void ShowAllUI()

已弃用。 优先使用 ShowAllUI(ShowAllUICallback callback)。它向用户呈现一个 UI，其中显示所有成就的信息。该 UI 在所有平台上异步显示。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking()

向用户呈现一个显示所有成就信息的 UI。

它会同步返回 UIStatus。未指定 timeout 会使此函数调用等效于调用 ShowAllUIBlocking(Timeout timeout)，其中 timeout 指定为 10 年。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

向用户呈现一个显示所有成就信息的 UI。

它会同步返回 UIStatus。将 timeout 指定为任意毫秒数。

Unlock

void Unlock(
  const std::string & achievement_id
)

为当前已登录玩家解锁成就。

如果成就是隐藏的，SDK 也会揭示它。