gpg:: 実績
#include <achievement.h>
特定の成果のステータスに関するデータにアクセスできる単一のデータ構造。
概要
データには、ユーザー固有のデータ(ユーザーがアチーブメントをアンロックしたかどうかなど)とグローバル データ(アチーブメント名など)の 2 種類があります。
コンストラクタとデストラクタ |
|
---|---|
Achievement()
|
|
Achievement(std::shared_ptr< const AchievementImpl > impl)
|
|
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 Console で事前に生成された一意の文字列を返します。
|
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 の内部使用を目的としています。
CurrentSteps
uint32_t CurrentSteps() const
増分実績の達成に向けてプレーヤーが達成したステップ数を返します。
Achievement::Valid() が true を返した場合にのみ呼び出されます。
説明
const std::string & Description() const
実績の簡単な説明を返します。
通常は、実績の獲得方法をプレーヤーに伝えます。最大 500 文字。Achievement::Valid() が true を返した場合にのみ呼び出されます。
ID
const std::string & Id() const
Google Play Console で事前に生成された一意の文字列を返します。
ゲーム クライアントで実績を参照するために使用します。Achievement::Valid() が true を返した場合にのみ呼び出されます。
LastModifiedTime
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 を返した場合にのみ呼び出されます。詳しくは、こちらをご覧ください。
TotalSteps
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 を返します。
このアチーブメントのゲッター関数(id、名前、説明など)を使用できるようにするには、true にする必要があります。
~実績
~Achievement()