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 &
この Achievement について、公開されたアイコンの画像に誘導する URL を返します。
|
State() const
|
実績の状態(
HIDDEN 、REVEALED 、UNLOCKED )を返す。 |
TotalSteps() const
|
uint32_t
プレーヤーが所定の増分実績をロック解除するために必要な合計ステップ数を返します。
|
Type() const
|
実績のタイプ(
INCREMENTAL または STANDARD )を返します。 |
UnlockedIconUrl() const
|
const std::string &
この Achievement のロック解除済みアイコンの画像に誘導する URL を返します。
|
Valid() const
|
bool
返された実績にデータが入力され、レスポンスのステータスが成功した場合、true を返します。ユーザー作成の実績が入力されていない場合は false、レスポンス ステータスが失敗した場合はデータが入力されます。
|
XP() const
|
uint64_t
この実績によって獲得できる経験ポイント数。
|
operator=(const Achievement & copy_from)
|
別の実績からコピーして、この実績を割り当てます。
|
operator=(Achievement && move_from)
|
この実績をもう 1 つ移動して割り当てます。
|
パブリック関数
達成度
Achievement()
達成度
Achievement( std::shared_ptr< const AchievementImpl > impl )
shared_ptr
から AchievementImpl
までの Achievement を作成します(API による内部使用向け)。
現在のステップ
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 を返した場合にのみ呼び出すことができます。
最終更新日時
Timestamp LastModifiedTime() const
エントリが最後に変更された時刻(Unix エポックからのミリ秒単位)を返します。
このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
氏名
const std::string & Name() const
実績の略称を返します。
100 文字まで。このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
アイコン表示
const std::string & RevealedIconUrl() const
この Achievement について、公開されたアイコンの画像に誘導する URL を返します。
このアイコンは、実績が公表されていても、まだロック解除されていない場合に表示されます。この関数は、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
State
AchievementState State() const
実績の状態(HIDDEN
、REVEALED
、UNLOCKED
)を返す。
このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。詳しくは、こちらをご覧ください。
合計歩数
uint32_t TotalSteps() const
プレーヤーが所定の増分実績をロック解除するために必要な合計ステップ数を返します。
このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
タイプ
AchievementType Type() const
実績のタイプ(INCREMENTAL
または STANDARD
)を返します。
このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。詳しくは、こちらをご覧ください。
ロック解除されたアイコン URL
const std::string & UnlockedIconUrl() const
この Achievement のロック解除済みアイコンの画像に誘導する URL を返します。
このアイコンは、実績のロックが解除されたときに表示されることを想定しています。この関数は、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
有効
bool Valid() const
返された実績にデータが入力され、レスポンスのステータスが成功した場合、true を返します。ユーザー作成の実績が入力されていない場合は false、レスポンス ステータスが失敗した場合はデータが入力されます。
この実績のゲッター関数(ID、名前、説明など)が使用可能であることが必要です。
XP
uint64_t XP() const
この実績によって獲得できる経験ポイント数。
このメソッドは、Achievement::Valid() が true を返した場合にのみ呼び出すことができます。
成果
~Achievement()