gpg:: 達成度
#include <achievement.h>
特定の実績のステータスに関するデータにアクセスできる 1 つのデータ構造。
概要
データには、ユーザー固有(例: ユーザーが実績を解放したかどうか)とグローバル(例: 実績名)の 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
への Achievement を作成します。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、Name、Description など)を使用するには、true である必要があります。
達成
~Achievement()