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 コールバック) を使用することをおすすめします。すべての実績に関する情報を表示する UI をユーザーに提示します。UI はすべてのプラットフォームで非同期的に表示されます。
ShowAllUIBlocking()
すべての実績に関する情報を表示する UI をユーザーに表示します。
ShowAllUIBlocking(Timeout timeout)
すべての実績に関する情報を表示する UI をユーザーに表示します。
Unlock(const std::string & achievement_id)
void
現在ログインしているプレーヤーの実績をロック解除します。

構造体

gpg::AchievementManager::FetchAllResponse

すべての実績のすべてのデータとレスポンス ステータスを保持します。

gpg::AchievementManager::FetchResponse

1 つの実績のデータとレスポンス ステータスを含みます。

パブリック タイプ

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* 関数に提供されます。

パブリック関数

取得

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

現在ログインしているプレーヤーの特定の実績のデータを非同期的に読み込みます。

オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を指定しない場合、この関数呼び出しは、data_sourceCACHE_OR_NETWORK として指定された Fetch(DataSource data_source, const std::string& id, FetchCallback) の呼び出しと同等になります。

取得

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 を指定しない場合、この関数呼び出しは、data_sourceCACHE_OR_NETWORK として指定された FetchAll(DataSource data_source, FetchAllCallback) の呼び出しと同じになります。

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

現在ログインしているプレーヤーのすべての実績データを非同期で読み込みます。

オペレーションの完了時に指定された FetchAllCallback を呼び出します。data_sourceCACHE_OR_NETWORK または NETWORK_ONLY として指定します。

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

現在ログインしているプレーヤーのすべての実績データを同期的に読み込み、FetchAllResponse を直接返します。

data_sourcetimeout も指定しない場合、この関数呼び出しは、data_sourceCACHE_OR_NETWORK に、timeout を 10 年に指定して FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout) を呼び出すことと同じになります。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

現在ログインしているプレーヤーのすべての実績データを同期的に読み込み、FetchAllResponse を直接返します。

data_sourceCACHE_OR_NETWORK または NETWORK_ONLY として指定します。timeout を指定しない場合、この関数呼び出しは、指定した data_source 値と timeout が 10 年として指定された FetchAllBlocking FetchAllResponse(DataSource data_source, Timeout timeout) の呼び出しと同じになります。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

現在ログインしているプレーヤーのすべての実績データを同期的に読み込み、FetchAllResponse を直接返します。

timeout は任意のミリ秒数で指定します。data_source を指定しない場合、この関数呼び出しは FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout) を呼び出す場合と同じになります。この場合、data_sourceCACHE_OR_NETWORK として指定され、timeout には指定した値が含まれます。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

現在ログインしているプレーヤーのすべての実績データを同期的に読み込み、FetchAllResponse を直接返します。

data_sourceCACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを任意のミリ秒数で指定します。

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & achievement_id
)

現在ログインしているプレーヤーの特定の成果(文字列 ID で識別)のデータを同期的に読み込み、FetchResponse を直接返します。

data_sourcetimeout を指定しない場合は、この関数呼び出しは、data_sourceCACHE_OR_NETWORK として、timeout を 10 年として指定して FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id) を呼び出すのと同じになります。

FetchBlocking

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

現在ログインしているプレーヤーの特定の成果(文字列 ID で識別)のデータを同期的に読み込み、FetchResponse を直接返します。

data_sourceCACHE_OR_NETWORK または NETWORK_ONLY として指定します。timeout を指定しない場合は、この関数呼び出しは、指定した data_source 値と timeout を 10 年として FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id) を呼び出す場合と同じになります。

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_sourceCACHE_OR_NETWORK として指定され、timeout には指定した値が含まれます。

FetchBlocking

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

現在ログインしているプレーヤーの特定の成果(文字列 ID で識別)のデータを同期的に読み込み、FetchResponse を直接返します。

data_sourceCACHE_OR_NETWORK または NETWORK_ONLY として指定します。timeout は任意のミリ秒数で指定します。

増やす

void Increment(
  const std::string & achievement_id
)

指定されたステップ数だけ実績を増加します。

増分値を未定義のままにすると、デフォルトで 1 になります。実績は増分実績である必要があります。実績のステップ数が最大数に達すると、自動的にロックが解除されます。それ以降の増分は無視されます。

増やす

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

指定されたステップ数だけ実績を増加します。

実績は増分実績である必要があります。実績のステップ数が最大数に達すると、自動的にロックが解除されます。それ以降の増分は無視されます。

表示

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 コールバック) を使用することをおすすめします。すべての実績に関する情報を表示する UI をユーザーに提示します。UI はすべてのプラットフォームで非同期的に表示されます。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking()

すべての実績に関する情報を表示する UI をユーザーに表示します。

UIStatus を同期的に返します。timeout を指定しない場合、この関数呼び出しは、timeout を 10 年として指定して ShowAllUIBlocking(Timeout timeout) を呼び出すのと同じになります。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

すべての実績に関する情報を表示する UI をユーザーに表示します。

UIStatus を同期的に返します。timeout は任意のミリ秒数で指定します。

ロック解除

void Unlock(
  const std::string & achievement_id
)

現在ログインしているプレーヤーの実績をロック解除します。

実績が非表示になっている場合、SDK によって表示されます。