гпг:: Менеджер достижений

#include <achievement_manager.h>

Получает и устанавливает различные данные, связанные с достижениями.

Краткое содержание

Публичные типы

FetchAllCallback определение типа
std::function< void(const FetchAllResponse &)>
Определяет тип обратного вызова, который получает FetchAllResponse .
FetchCallback определение типа
std::function< void(const FetchResponse &)>
Определяет тип обратного вызова, который получает FetchResponse .
ShowAllUICallback определение типа
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)
Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .
FetchBlocking ( DataSource data_source, const std::string & achievement_id)
Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .
FetchBlocking ( Timeout timeout, const std::string & achievement_id)
Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .
FetchBlocking ( DataSource data_source, Timeout timeout, const std::string & achievement_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
Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.
ShowAllUI ()
void
Устарело. Предпочитайте ShowAllUI(обратный вызов ShowAllUICallback) . Предоставляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях. Пользовательский интерфейс отображается асинхронно на всех платформах.
ShowAllUIBlocking ()
Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.
ShowAllUIBlocking ( Timeout timeout)
Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.
Unlock (const std::string & achievement_id)
void
Открывает достижение для игрока, вошедшего в систему.

Структуры

gpg:: AchievementManager:: FetchAllResponse

Содержит все данные для всех достижений, а также статус ответа.

gpg:: AchievementManager:: FetchResponse

Содержит данные и статус ответа для одного достижения.

Публичные типы

FetchAllОбратный вызов 

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

Определяет тип обратного вызова, который получает FetchAllResponse .

Этот тип обратного вызова предоставляется функциям FetchAll(*) ниже.

Получить обратный вызов 

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

Определяет тип обратного вызова, который получает FetchResponse .

Этот тип обратного вызова предоставляется функциям Fetch(*) ниже.

ПоказатьВсеUICallback 

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

Определяет тип обратного вызова, который получает UIStatus .

Этот тип обратного вызова предоставляется функции ShowAllUI* ниже.

Общественные функции

Принести 

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 .

Принести 

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

Асинхронно загружает данные для определенного достижения для игрока, выполнившего вход в систему.

Вызывает предоставленный FetchCallback после завершения операции. Укажите data_source как CACHE_OR_NETWORK или NETWORK_ONLY .

Получить все 

void FetchAll(
  FetchAllCallback callback
)

Асинхронно загружает все данные о достижениях для игрока, вошедшего в систему.

Вызывает предоставленный FetchAllCallback после завершения операции. Если не указать data_source этот вызов функции будет эквивалентен вызову FetchAll(DataSource data_source, FetchAllCallback) с data_source , указанным как CACHE_OR_NETWORK .

Получить все 

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 . Укажите таймаут как произвольное количество миллисекунд.

Блокировка выборки 

FetchResponse FetchBlocking(
  const std::string & achievement_id
)

Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .

Если оставить data_source и timeout неуказанными, вызов этой функции будет эквивалентен вызову FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id) , где data_source указан как CACHE_OR_NETWORK , а timeout указано как 10 лет.

Блокировка выборки 

FetchResponse FetchBlocking(
  DataSource data_source,
  const std::string & achievement_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 годам.

Блокировка выборки 

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

Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .

Укажите timeout как произвольное количество миллисекунд. Если оставить data_source неуказанным, вызов этой функции будет эквивалентен вызову FetchResponse FetchBlocking(DataSource data_source, Timeout timeout, const std::string& id) , с data_source , указанным как CACHE_OR_NETWORK , и timeout содержащим указанное вами значение.

Блокировка выборки 

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

Синхронно загружает данные для определенного достижения, идентифицируемого строковым идентификатором, для игрока, вошедшего в систему в данный момент; напрямую возвращает FetchResponse .

Укажите data_source как CACHE_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
)

Покажите скрытое достижение игроку, вошедшему в систему.

Если достижение уже было разблокировано, это не повлияет.

УстановитьШагиПо крайней мере 

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

Установите достижение, чтобы выполнить хотя бы заданное количество шагов.

Вызов этого метода, когда достижение уже содержит больше шагов, чем предоставленное значение, является пустым процессом. Как только достижение достигает максимального количества шагов, оно автоматически разблокируется, и любые дальнейшие операции мутации игнорируются.

ПоказатьAllUI 

void ShowAllUI(
  ShowAllUICallback callback
)

Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.

Он асинхронно вызывает ShowAllUICallback .

ПоказатьAllUI 

void ShowAllUI()

Устарело. Предпочитайте ShowAllUI(обратный вызов ShowAllUICallback) . Предоставляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях. Пользовательский интерфейс отображается асинхронно на всех платформах.

ПоказатьAllUIBlocking 

UIStatus ShowAllUIBlocking()

Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.

Он синхронно возвращает UIStatus . Если не указать timeout вызов этой функции будет эквивалентен вызову ShowAllUIBlocking(Timeout timeout) с timeout , указанным в 10 лет.

ПоказатьAllUIBlocking 

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

Представляет пользователю пользовательский интерфейс, отображающий информацию обо всех достижениях.

Он синхронно возвращает UIStatus . Укажите timeout как произвольное количество миллисекунд.

Разблокировать 

void Unlock(
  const std::string & achievement_id
)

Открывает достижение для игрока, вошедшего в систему.

Если достижение скрыто, SDK также его покажет.