гпг:: Достижение
#include <achievement.h>
Единая структура данных, позволяющая получить доступ к данным о статусе конкретного достижения.
Краткое содержание
Данные состоят из двух типов: специфичные для пользователя (например, разблокировал ли пользователь достижение и т. д.) и глобальные (например, название достижения).
Конструкторы и деструкторы | |
---|---|
Achievement () | |
Achievement (std::shared_ptr< const AchievementImpl > impl) Конструирует достижение из shared_ptr в AchievementImpl . Предназначено для внутреннего использования API. | |
Achievement (const Achievement & copy_from) Создает копию существующего достижения . | |
Achievement ( Achievement && move_from) Перемещает существующее достижение . | |
~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 & Возвращает URL-адрес, ведущий к изображению значка этого достижения . |
State () const | Возвращает состояние достижения: HIDDEN , REVEALED или UNLOCKED . |
TotalSteps () const | uint32_t Возвращает общее количество шагов, необходимое игроку, чтобы разблокировать данное дополнительное достижение. |
Type () const | Возвращает тип достижения: INCREMENTAL или STANDARD . |
UnlockedIconUrl () const | const std::string & Возвращает URL-адрес, ведущий к изображению разблокированного значка этого достижения . |
Valid () const | bool Возвращает true, когда возвращаемое достижение заполнено данными и сопровождается статусом успешного ответа; false для незаполненного достижения, созданного пользователем, или для заполненного достижения, сопровождающегося статусом неудачного ответа. |
XP () const | uint64_t Количество очков опыта, полученных за это достижение. |
operator= (const Achievement & copy_from) | Присваивает это Достижение путем копирования с другого. |
operator= ( Achievement && move_from) | Назначает это достижение , перемещая в него другое. |
Общественные функции
Достижение
Achievement()
Достижение
Achievement( std::shared_ptr< const AchievementImpl > impl )
Конструирует достижение из shared_ptr
в AchievementImpl
. Предназначено для внутреннего использования API.
Текущие шаги
uint32_t CurrentSteps() const
Возвращает количество шагов, предпринятых игроком для открытия дополнительного достижения.
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Описание
const std::string & Description() const
Возвращает краткое описание вашего достижения.
Обычно сообщает игроку, как получить достижение. До 500 символов. Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Идентификатор
const std::string & Id() const
Возвращает уникальную строку, заранее сгенерированную консолью разработчика Google Play.
Используйте его для обозначения достижения в вашем игровом клиенте. Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Ластмодифицированноевремя
Timestamp LastModifiedTime() const
Возвращает время последнего изменения записи (выраженное в миллисекундах с эпохи Unix).
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Имя
const std::string & Name() const
Возвращает краткое название достижения.
До 100 символов. Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
RevealedIconUrl
const std::string & RevealedIconUrl() const
Возвращает URL-адрес, ведущий к изображению значка этого достижения .
Этот значок предназначен для отображения, когда достижение открыто, но еще не разблокировано. Эту функцию можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Состояние
AchievementState State() const
Возвращает состояние достижения: HIDDEN
, REVEALED
или UNLOCKED
.
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true. Более подробная информация доступна здесь .
Всего шагов
uint32_t TotalSteps() const
Возвращает общее количество шагов, необходимых игроку, чтобы разблокировать данное дополнительное достижение.
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Тип
AchievementType Type() const
Возвращает тип достижения: INCREMENTAL
или STANDARD
.
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true. Более подробная информация доступна здесь .
UnlockedIconUrl
const std::string & UnlockedIconUrl() const
Возвращает URL-адрес, ведущий к изображению значка разблокировки этого достижения .
Этот значок предназначен для отображения, когда достижение разблокировано (и, следовательно, также раскрыто). Эту функцию можно вызвать только тогда, когда Achievement::Valid() возвращает true.
Действительный
bool Valid() const
Возвращает true, когда возвращаемое достижение заполнено данными и сопровождается статусом успешного ответа; false для незаполненного достижения, созданного пользователем, или для заполненного достижения, сопровождающегося статусом неудачного ответа.
Чтобы можно было использовать функции получения этого достижения (идентификатор, имя, описание и т. д.), оно должно быть истинным.
XP
uint64_t XP() const
Количество очков опыта, полученных за это достижение.
Его можно вызвать только тогда, когда Achievement::Valid() возвращает true.
оператор=
Achievement & operator=( const Achievement & copy_from )
Присваивает это Достижение путем копирования с другого.
оператор=
Achievement & operator=( Achievement && move_from )
Назначает это достижение , перемещая в него другое.
~Достижение
~Achievement()