gpg:: プレーヤー
#include <player.h>
特定のプレーヤーに関するデータにアクセスできるデータ構造。
概要
コンストラクタとデストラクタ |
|
---|---|
Player()
|
|
Player(std::shared_ptr< const PlayerImpl > impl)
|
|
Player(const Player & copy_from)
既存の Player のコピーを作成します。
|
|
Player(Player && move_from)
既存の Player を新しいプレーヤーに移動します。
|
|
~Player()
|
パブリック関数 |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
この Player のアバターの画像が存在する URL を返します。
|
CurrentLevel() const
|
const PlayerLevel &
このプレーヤーの現在のレベルデータを取得します(判明している場合)。
|
CurrentXP() const
|
uint64_t
プレーヤーの現在の XP 合計を取得します。
|
HasLevelInfo() const
|
bool
このプレーヤーがレベル情報を持っているかどうかを返します。
|
Id() const
|
const std::string &
現在ログインしているプレーヤーの
Id を返します。 |
LastLevelUpTime() const
|
このプレーヤーが最後にレベルアップした時点のタイムスタンプを取得します。
|
Name() const
|
const std::string &
現在ログインしているプレーヤーの Google+ 名を返します。
|
NextLevel() const
|
const PlayerLevel &
このプレーヤーの次のレベルのデータを取得します(判明している場合)。
|
Title() const
|
const std::string &
プレーヤーのタイトルを取得します。
|
Valid() const
|
bool
返されたプレーヤーにデータが挿入され、成功のレスポンス ステータスを伴う場合、true を返します。未入力のユーザー作成プレーヤー、または入力失敗のレスポンス ステータスを伴うプレーヤーの場合は false。
|
operator=(const Player & copy_from)
|
Player &
別のプレーヤーからコピーすることによって、この Player を割り当てます。
|
operator=(Player && move_from)
|
Player &
この Player の値を、別の値を移動して割り当てます。
|
パブリック関数
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
この Player のアバターの画像が存在する URL を返します。
ImageResolution
パラメータは画像の解像度を指定します。この関数を使用するには、Player::Valid()
が true を返す必要があります。
CurrentLevel
const PlayerLevel & CurrentLevel() const
このプレーヤーの現在のレベルデータを取得します(判明している場合)。
HasLevelInfo() が false を返す場合は、Valid() も false を返す PlayerLevel オブジェクトが返されます。
CurrentXP
uint64_t CurrentXP() const
プレーヤーの現在の XP 合計を取得します。
HasLevelInfo() が false を返す場合は、0 が返されます。HasLevelInfo() が true を返す場合、プレーヤーの現在の XP の合計は CurrentLevel().MinimumXP から CurrentLevel().MaximumXP までの範囲になります。
HasLevelInfo
bool HasLevelInfo() const
このプレーヤーがレベル情報を持っているかどうかを返します。
false が返された場合、CurrentLevel()
と NextLevel()
は無効な PlayerLevel
オブジェクトを返します。
ID
const std::string & Id() const
現在ログインしているプレーヤーの Id
を返します。
この関数を使用するには、Player::Valid()
が true を返す必要があります。
LastLevelUpTime
Timestamp LastLevelUpTime() const
このプレーヤーが最後にレベルアップした時点のタイムスタンプを取得します。
HasLevelInfo() が false を返す場合、またはプレーヤーがレベルアップしたことがない場合は、ゼロ(エポック)が返されます。
名前
const std::string & Name() const
現在ログインしているプレーヤーの Google+ 名を返します。
この関数を使用するには、Player::Valid()
が true を返す必要があります。
NextLevel
const PlayerLevel & NextLevel() const
このプレーヤーの次のレベルのデータを取得します(判明している場合)。
HasLevelInfo() が false を返す場合は、Valid() も false を返す PlayerLevel オブジェクトが返されます。これは、プレーヤーが現在取り組んでいるレベルです。プレーヤーがすでに最大レベルに到達している場合、CurrentLevel() と NextLevel() は同じ値を返します。
選手
Player()
選手
Player( std::shared_ptr< const PlayerImpl > impl )
shared_ptr
から PlayerImpl
に Player を構築します。
API の内部で使用することを目的としています。
タイトル
const std::string & Title() const
プレーヤーのタイトルを取得します。
このスコアは、プレーヤーが Google Play Games のエコシステムで行ったアクションに基づいて決定されます。なお、すべてのプレーヤーにタイトルがあるわけではなく、プレーヤーのタイトルは時間とともに変わる可能性があります。プレーヤーにタイトルがない場合、Title() は空の文字列を返します。
有効
bool Valid() const
返されたプレーヤーにデータが入力され、成功のレスポンス ステータスが付いている場合、true を返します。未入力のユーザー作成プレーヤー、または入力失敗のレスポンス ステータスを伴うプレーヤーの場合は false。
このオブジェクトのゲッター関数を使用できるようにするには、true を返す必要があります。
~プレーヤー
~Player()