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也会将其显示。